KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 2000 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.Node JavaDoc;
61
62 /**
63  * ChildNode inherits from NodeImpl and adds the capability of being a child by
64  * having references to its previous and next siblings.
65  */
66 public abstract class ChildNode
67     extends NodeImpl {
68
69     //
70 // Constants
71 //
72
73     /** Serialization version. */
74     static final long serialVersionUID = -6112455738802414002L;
75
76     // public
77
78     //
79 // Data
80 //
81
82     /** Previous sibling. */
83     protected ChildNode previousSibling;
84
85     /** Next sibling. */
86     protected ChildNode nextSibling;
87
88     //
89 // Constructors
90 //
91
92     /**
93      * No public constructor; only subclasses of Node should be
94      * instantiated, and those normally via a Document's factory methods
95      * <p>
96      * Every Node knows what Document it belongs to.
97      */
98     protected ChildNode(DocumentImpl ownerDocument) {
99         super(ownerDocument);
100     } // <init>(DocumentImpl,String,short,boolean,String)
101
102     /** Constructor for serialization. */
103     public ChildNode() {}
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 JavaDoc 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 JavaDoc 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 JavaDoc getNextSibling() {
165         return nextSibling;
166     }
167
168     /** The previous child of this node's parent, or null if none */
169     public Node JavaDoc 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
185
Popular Tags