001: /*
002: * The Apache Software License, Version 1.1
003: *
004: *
005: * Copyright (c) 2000 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.Node;
061:
062: /**
063: * ChildNode inherits from NodeImpl and adds the capability of being a child by
064: * having references to its previous and next siblings.
065: */
066: public abstract class ChildNode extends NodeImpl {
067:
068: //
069: // Constants
070: //
071:
072: /** Serialization version. */
073: static final long serialVersionUID = -6112455738802414002L;
074:
075: // public
076:
077: //
078: // Data
079: //
080:
081: /** Previous sibling. */
082: protected ChildNode previousSibling;
083:
084: /** Next sibling. */
085: protected ChildNode nextSibling;
086:
087: //
088: // Constructors
089: //
090:
091: /**
092: * No public constructor; only subclasses of Node should be
093: * instantiated, and those normally via a Document's factory methods
094: * <p>
095: * Every Node knows what Document it belongs to.
096: */
097: protected ChildNode(CoreDocumentImpl ownerDocument) {
098: super (ownerDocument);
099: } // <init>(CoreDocumentImpl)
100:
101: /** Constructor for serialization. */
102: public ChildNode() {
103: }
104:
105: //
106: // Node methods
107: //
108:
109: /**
110: * Returns a duplicate of a given node. You can consider this a
111: * generic "copy constructor" for nodes. The newly returned object should
112: * be completely independent of the source object's subtree, so changes
113: * in one after the clone has been made will not affect the other.
114: * <P>
115: * Note: since we never have any children deep is meaningless here,
116: * ParentNode overrides this behavior.
117: * @see ParentNode
118: *
119: * <p>
120: * Example: Cloning a Text node will copy both the node and the text it
121: * contains.
122: * <p>
123: * Example: Cloning something that has children -- Element or Attr, for
124: * example -- will _not_ clone those children unless a "deep clone"
125: * has been requested. A shallow clone of an Attr node will yield an
126: * empty Attr of the same name.
127: * <p>
128: * NOTE: Clones will always be read/write, even if the node being cloned
129: * is read-only, to permit applications using only the DOM API to obtain
130: * editable copies of locked portions of the tree.
131: */
132: public Node cloneNode(boolean deep) {
133:
134: ChildNode newnode = (ChildNode) super .cloneNode(deep);
135:
136: // Need to break the association w/ original kids
137: newnode.previousSibling = null;
138: newnode.nextSibling = null;
139: newnode.isFirstChild(false);
140:
141: return newnode;
142:
143: } // cloneNode(boolean):Node
144:
145: /**
146: * Returns the parent node of this node
147: */
148: public Node getParentNode() {
149: // if we have an owner, ownerNode is our parent, otherwise it's
150: // our ownerDocument and we don't have a parent
151: return isOwned() ? ownerNode : null;
152: }
153:
154: /*
155: * same as above but returns internal type
156: */
157: final NodeImpl parentNode() {
158: // if we have an owner, ownerNode is our parent, otherwise it's
159: // our ownerDocument and we don't have a parent
160: return isOwned() ? ownerNode : null;
161: }
162:
163: /** The next child of this node's parent, or null if none */
164: public Node getNextSibling() {
165: return nextSibling;
166: }
167:
168: /** The previous child of this node's parent, or null if none */
169: public Node getPreviousSibling() {
170: // if we are the firstChild, previousSibling actually refers to our
171: // parent's lastChild, but we hide that
172: return isFirstChild() ? null : previousSibling;
173: }
174:
175: /*
176: * same as above but returns internal type
177: */
178: final ChildNode previousSibling() {
179: // if we are the firstChild, previousSibling actually refers to our
180: // parent's lastChild, but we hide that
181: return isFirstChild() ? null : previousSibling;
182: }
183:
184: } // class ChildNode
|