001: /*
002: * The Apache Software License, Version 1.1
003: *
004: *
005: * Copyright (c) 1999 The Apache Software Foundation. All rights
006: * reserved.
007: *
008: * Redistribution and use in source and binary forms, with or without
009: * modification, are permitted provided that the following conditions
010: * are met:
011: *
012: * 1. Redistributions of source code must retain the above copyright
013: * notice, this list of conditions and the following disclaimer.
014: *
015: * 2. Redistributions in binary form must reproduce the above copyright
016: * notice, this list of conditions and the following disclaimer in
017: * the documentation and/or other materials provided with the
018: * distribution.
019: *
020: * 3. The end-user documentation included with the redistribution,
021: * if any, must include the following acknowledgment:
022: * "This product includes software developed by the
023: * Apache Software Foundation (http://www.apache.org/)."
024: * Alternately, this acknowledgment may appear in the software itself,
025: * if and wherever such third-party acknowledgments normally appear.
026: *
027: * 4. The names "Xerces" and "Apache Software Foundation" must
028: * not be used to endorse or promote products derived from this
029: * software without prior written permission. For written
030: * permission, please contact apache@apache.org.
031: *
032: * 5. Products derived from this software may not be called "Apache",
033: * nor may "Apache" appear in their name, without prior written
034: * permission of the Apache Software Foundation.
035: *
036: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
037: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
038: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
039: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
040: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
041: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
042: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
043: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
044: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
045: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
046: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
047: * SUCH DAMAGE.
048: * ====================================================================
049: *
050: * This software consists of voluntary contributions made by many
051: * individuals on behalf of the Apache Software Foundation and was
052: * originally based on software copyright (c) 1999, International
053: * Business Machines, Inc., http://www.apache.org. For more
054: * information on the Apache Software Foundation, please see
055: * <http://www.apache.org/>.
056: */
057:
058: package org.apache.xerces.dom;
059:
060: import org.w3c.dom.DocumentFragment;
061: import org.w3c.dom.Node;
062:
063: /**
064: * DocumentFragment is a "lightweight" or "minimal" Document
065: * object. It is very common to want to be able to extract a portion
066: * of a document's tree or to create a new fragment of a
067: * document. Imagine implementing a user command like cut or
068: * rearranging a document by moving fragments around. It is desirable
069: * to have an object which can hold such fragments and it is quite
070: * natural to use a Node for this purpose. While it is true that a
071: * Document object could fulfil this role, a Document object can
072: * potentially be a heavyweight object, depending on the underlying
073: * implementation... and in DOM Level 1, nodes aren't allowed to cross
074: * Document boundaries anyway. What is really needed for this is a
075: * very lightweight object. DocumentFragment is such an object.
076: * <P>
077: * Furthermore, various operations -- such as inserting nodes as
078: * children of another Node -- may take DocumentFragment objects as
079: * arguments; this results in all the child nodes of the
080: * DocumentFragment being moved to the child list of this node.
081: * <P>
082: * The children of a DocumentFragment node are zero or more nodes
083: * representing the tops of any sub-trees defining the structure of
084: * the document. DocumentFragment do not need to be well-formed XML
085: * documents (although they do need to follow the rules imposed upon
086: * well-formed XML parsed entities, which can have multiple top
087: * nodes). For example, a DocumentFragment might have only one child
088: * and that child node could be a Text node. Such a structure model
089: * represents neither an HTML document nor a well-formed XML document.
090: * <P>
091: * When a DocumentFragment is inserted into a Document (or indeed any
092: * other Node that may take children) the children of the
093: * DocumentFragment and not the DocumentFragment itself are inserted
094: * into the Node. This makes the DocumentFragment very useful when the
095: * user wishes to create nodes that are siblings; the DocumentFragment
096: * acts as the parent of these nodes so that the user can use the
097: * standard methods from the Node interface, such as insertBefore()
098: * and appendChild().
099: *
100: * @version
101: * @since PR-DOM-Level-1-19980818.
102: */
103: public class DocumentFragmentImpl extends ParentNode implements
104: DocumentFragment {
105:
106: //
107: // Constants
108: //
109:
110: /** Serialization version. */
111: static final long serialVersionUID = -7596449967279236746L;
112:
113: //
114: // Constructors
115: //
116:
117: /** Factory constructor. */
118: public DocumentFragmentImpl(CoreDocumentImpl ownerDoc) {
119: super (ownerDoc);
120: }
121:
122: /** Constructor for serialization. */
123: public DocumentFragmentImpl() {
124: }
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 getNodeName() {
140: return "#document-fragment";
141: }
142:
143: } // class DocumentFragmentImpl
|