KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jibx > extras > DomFragmentMapper


1 /*
2 Copyright (c) 2004, Dennis M. Sosnoski
3 All rights reserved.
4
5 Redistribution and use in source and binary forms, with or without modification,
6 are permitted provided that the following conditions are met:
7
8  * Redistributions of source code must retain the above copyright notice, this
9    list of conditions and the following disclaimer.
10  * Redistributions in binary form must reproduce the above copyright notice,
11    this list of conditions and the following disclaimer in the documentation
12    and/or other materials provided with the distribution.
13  * Neither the name of JiBX nor the names of its contributors may be used
14    to endorse or promote products derived from this software without specific
15    prior written permission.
16
17 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
18 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
21 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
24 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
26 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29 package org.jibx.extras;
30
31 import java.io.IOException JavaDoc;
32
33 import org.jibx.runtime.IMarshaller;
34 import org.jibx.runtime.IMarshallingContext;
35 import org.jibx.runtime.IUnmarshaller;
36 import org.jibx.runtime.IUnmarshallingContext;
37 import org.jibx.runtime.JiBXException;
38 import org.jibx.runtime.impl.UnmarshallingContext;
39 import org.w3c.dom.DocumentFragment JavaDoc;
40 import org.w3c.dom.Node JavaDoc;
41
42 /**
43  * <p>Custom content list marshaller/unmarshaller to DOM representation. This
44  * allows you to mix data binding and document model representations for XML
45  * within the same application. You simply use this marshaller/unmarshaller with
46  * a linked object type of <code>org.w3c.dom.DocumentFragment</code> (the actual
47  * runtime type - the declared type is ignored and can be anything). When
48  * unmarshalling it will create a fragment to hold any content up to the close
49  * tag for the enclosing element in the list. When marshalling, it will simply
50  * write out any content directly.</p>
51  *
52  * @author Dennis M. Sosnoski
53  * @version 1.0
54  */
55
56 public class DomFragmentMapper extends DomMapperBase
57     implements IMarshaller, IUnmarshaller
58 {
59     /**
60      * Default constructor.
61      *
62      * @throws JiBXException on configuration error
63      */
64     public DomFragmentMapper() throws JiBXException {
65         super();
66     }
67     
68     /* (non-Javadoc)
69      * @see org.jibx.runtime.IMarshaller#isExtension(int)
70      */
71
72     public boolean isExtension(int index) {
73         return false;
74     }
75
76     /* (non-Javadoc)
77      * @see org.jibx.runtime.IMarshaller#marshal(java.lang.Object,
78      * org.jibx.runtime.IMarshallingContext)
79      */
80     
81     public void marshal(Object JavaDoc obj, IMarshallingContext ictx)
82         throws JiBXException {
83         
84         // make sure the parameters are as expected
85 if (!(obj instanceof DocumentFragment JavaDoc)) {
86             throw new JiBXException
87                 ("Mapped object not an org.w3c.dom.DocumentFragment");
88         } else {
89             try {
90                     
91                 // marshal document fragment with no indentation
92 m_xmlWriter = ictx.getXmlWriter();
93                 int indent = ictx.getIndent();
94                 ictx.setIndent(-1);
95                 m_defaultNamespaceURI = null;
96                 marshalContent(((DocumentFragment JavaDoc)obj).getChildNodes());
97                 ictx.setIndent(indent);
98                 
99             } catch (IOException JavaDoc e) {
100                 throw new JiBXException("Error writing to document", e);
101             }
102         }
103     }
104
105     /* (non-Javadoc)
106      * @see org.jibx.runtime.IUnmarshaller#isPresent(org.jibx.runtime.IUnmarshallingContext)
107      */
108      
109     public boolean isPresent(IUnmarshallingContext ctx) throws JiBXException {
110         if (!(ctx instanceof UnmarshallingContext)) {
111             throw new JiBXException
112                 ("Unmarshalling context not of expected type");
113         } else {
114             return ((UnmarshallingContext)ctx).currentEvent() !=
115                 UnmarshallingContext.END_TAG;
116         }
117     }
118
119     /* (non-Javadoc)
120      * @see org.jibx.runtime.IUnmarshaller#unmarshal(java.lang.Object,
121      * org.jibx.runtime.IUnmarshallingContext)
122      */
123      
124     public Object JavaDoc unmarshal(Object JavaDoc obj, IUnmarshallingContext ictx)
125         throws JiBXException {
126         
127         // verify the entry conditions
128 boolean created = false;
129         DocumentFragment JavaDoc frag = null;
130         if (obj == null) {
131             frag = m_document.createDocumentFragment();
132             created = true;
133         } else if (obj instanceof DocumentFragment JavaDoc) {
134             frag = (DocumentFragment JavaDoc)obj;
135         } else {
136             throw new JiBXException
137                 ("Supplied object is not an org.w3c.dom.DocumentFragment");
138         }
139         if (!(ictx instanceof UnmarshallingContext)) {
140             throw new JiBXException
141                 ("Unmarshalling context not of expected type");
142         }
143         
144         // unmarshal content to document model
145 m_unmarshalContext = (UnmarshallingContext)ictx;
146         try {
147             Node JavaDoc node;
148             while ((node = unmarshalNode()) != null) {
149                 frag.appendChild(node);
150             }
151             if (created && !frag.hasChildNodes()) {
152                 return null;
153             } else {
154                 return frag;
155             }
156         } catch (IOException JavaDoc e) {
157             throw new JiBXException("Error reading from document", e);
158         }
159     }
160 }
Popular Tags