KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > xquark > xpath > datamodel > xerces > dom > DocumentFragmentImpl


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 1999 The Apache Software Foundation. All rights
6  * reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Apache Software Foundation (http://www.apache.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Xerces" and "Apache Software Foundation" must
28  * not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact apache@apache.org.
31  *
32  * 5. Products derived from this software may not be called "Apache",
33  * nor may "Apache" appear in their name, without prior written
34  * permission of the Apache Software Foundation.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals on behalf of the Apache Software Foundation and was
52  * originally based on software copyright (c) 1999, International
53  * Business Machines, Inc., http://www.apache.org. For more
54  * information on the Apache Software Foundation, please see
55  * <http://www.apache.org/>.
56  */
57
58 package org.xquark.xpath.datamodel.xerces.dom;
59
60 import org.w3c.dom.DocumentFragment JavaDoc;
61 import org.w3c.dom.Node JavaDoc;
62
63 /**
64  * DocumentFragment is a "lightweight" or "minimal" Document
65  * object. It is very common to want to be able to extract a portion
66  * of a document's tree or to create a new fragment of a
67  * document. Imagine implementing a user command like cut or
68  * rearranging a document by moving fragments around. It is desirable
69  * to have an object which can hold such fragments and it is quite
70  * natural to use a Node for this purpose. While it is true that a
71  * Document object could fulfil this role, a Document object can
72  * potentially be a heavyweight object, depending on the underlying
73  * implementation... and in DOM Level 1, nodes aren't allowed to cross
74  * Document boundaries anyway. What is really needed for this is a
75  * very lightweight object. DocumentFragment is such an object.
76  * <P>
77  * Furthermore, various operations -- such as inserting nodes as
78  * children of another Node -- may take DocumentFragment objects as
79  * arguments; this results in all the child nodes of the
80  * DocumentFragment being moved to the child list of this node.
81  * <P>
82  * The children of a DocumentFragment node are zero or more nodes
83  * representing the tops of any sub-trees defining the structure of
84  * the document. DocumentFragment do not need to be well-formed XML
85  * documents (although they do need to follow the rules imposed upon
86  * well-formed XML parsed entities, which can have multiple top
87  * nodes). For example, a DocumentFragment might have only one child
88  * and that child node could be a Text node. Such a structure model
89  * represents neither an HTML document nor a well-formed XML document.
90  * <P>
91  * When a DocumentFragment is inserted into a Document (or indeed any
92  * other Node that may take children) the children of the
93  * DocumentFragment and not the DocumentFragment itself are inserted
94  * into the Node. This makes the DocumentFragment very useful when the
95  * user wishes to create nodes that are siblings; the DocumentFragment
96  * acts as the parent of these nodes so that the user can use the
97  * standard methods from the Node interface, such as insertBefore()
98  * and appendChild().
99  *
100  * @version
101  * @since PR-DOM-Level-1-19980818.
102  */
103 public class DocumentFragmentImpl
104     extends ParentNode
105     implements DocumentFragment JavaDoc {
106
107     //
108 // Constants
109 //
110
111     /** Serialization version. */
112     static final long serialVersionUID = -7596449967279236746L;
113     
114     //
115 // Constructors
116 //
117
118     /** Factory constructor. */
119     public DocumentFragmentImpl(DocumentImpl ownerDoc) {
120         super(ownerDoc);
121     }
122   
123     /** Constructor for serialization. */
124     public DocumentFragmentImpl() {}
125
126     //
127 // Node methods
128 //
129
130     /**
131      * A short integer indicating what type of node this is. The named
132      * constants for this value are defined in the org.w3c.dom.Node interface.
133      */
134     public short getNodeType() {
135         return Node.DOCUMENT_FRAGMENT_NODE;
136     }
137
138     /** Returns the node name. */
139     public String JavaDoc getNodeName() {
140         return "#document-fragment";
141     }
142     
143 } // class DocumentFragmentImpl
144
Popular Tags