01: /*
02: * Copyright (c) 2000 World Wide Web Consortium,
03: * (Massachusetts Institute of Technology, Institut National de
04: * Recherche en Informatique et en Automatique, Keio University). All
05: * Rights Reserved. This program is distributed under the W3C's Software
06: * Intellectual Property License. This program is distributed in the
07: * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
08: * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
09: * PURPOSE.
10: * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
11: */
12:
13: package org.w3c.dom.traversal;
14:
15: import org.w3c.dom.Node;
16: import org.w3c.dom.DOMException;
17:
18: /**
19: * <code>DocumentTraversal</code> contains methods that create
20: * <code>NodeIterators</code> and <code>TreeWalkers</code> to traverse a
21: * node and its children in document order (depth first, pre-order
22: * traversal, which is equivalent to the order in which the start tags occur
23: * in the text representation of the document). In DOMs which support the
24: * Traversal feature, <code>DocumentTraversal</code> will be implemented by
25: * the same objects that implement the Document interface.
26: * <p>See also the <a href='http://www.w3.org/TR/2000/REC-DOM-Level-2-Traversal-Range-20001113'>Document Object Model (DOM) Level 2 Traversal and Range Specification</a>.
27: * @since DOM Level 2
28: */
29: public interface DocumentTraversal {
30: /**
31: * Create a new <code>NodeIterator</code> over the subtree rooted at the
32: * specified node.
33: * @param root The node which will be iterated together with its
34: * children. The <code>NodeIterator</code> is initially positioned
35: * just before this node. The <code>whatToShow</code> flags and the
36: * filter, if any, are not considered when setting this position. The
37: * root must not be <code>null</code>.
38: * @param whatToShow This flag specifies which node types may appear in
39: * the logical view of the tree presented by the
40: * <code>NodeIterator</code>. See the description of
41: * <code>NodeFilter</code> for the set of possible <code>SHOW_</code>
42: * values.These flags can be combined using <code>OR</code>.
43: * @param filter The <code>NodeFilter</code> to be used with this
44: * <code>TreeWalker</code>, or <code>null</code> to indicate no filter.
45: * @param entityReferenceExpansion The value of this flag determines
46: * whether entity reference nodes are expanded.
47: * @return The newly created <code>NodeIterator</code>.
48: * @exception DOMException
49: * NOT_SUPPORTED_ERR: Raised if the specified <code>root</code> is
50: * <code>null</code>.
51: */
52: public NodeIterator createNodeIterator(Node root, int whatToShow,
53: NodeFilter filter, boolean entityReferenceExpansion)
54: throws DOMException;
55:
56: /**
57: * Create a new <code>TreeWalker</code> over the subtree rooted at the
58: * specified node.
59: * @param root The node which will serve as the <code>root</code> for the
60: * <code>TreeWalker</code>. The <code>whatToShow</code> flags and the
61: * <code>NodeFilter</code> are not considered when setting this value;
62: * any node type will be accepted as the <code>root</code>. The
63: * <code>currentNode</code> of the <code>TreeWalker</code> is
64: * initialized to this node, whether or not it is visible. The
65: * <code>root</code> functions as a stopping point for traversal
66: * methods that look upward in the document structure, such as
67: * <code>parentNode</code> and nextNode. The <code>root</code> must
68: * not be <code>null</code>.
69: * @param whatToShow This flag specifies which node types may appear in
70: * the logical view of the tree presented by the
71: * <code>TreeWalker</code>. See the description of
72: * <code>NodeFilter</code> for the set of possible <code>SHOW_</code>
73: * values.These flags can be combined using <code>OR</code>.
74: * @param filter The <code>NodeFilter</code> to be used with this
75: * <code>TreeWalker</code>, or <code>null</code> to indicate no filter.
76: * @param entityReferenceExpansion If this flag is false, the contents of
77: * <code>EntityReference</code> nodes are not presented in the logical
78: * view.
79: * @return The newly created <code>TreeWalker</code>.
80: * @exception DOMException
81: * NOT_SUPPORTED_ERR: Raised if the specified <code>root</code> is
82: * <code>null</code>.
83: */
84: public TreeWalker createTreeWalker(Node root, int whatToShow,
85: NodeFilter filter, boolean entityReferenceExpansion)
86: throws DOMException;
87:
88: }
|