001 /*
002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
003 *
004 * This code is free software; you can redistribute it and/or modify it
005 * under the terms of the GNU General Public License version 2 only, as
006 * published by the Free Software Foundation. Sun designates this
007 * particular file as subject to the "Classpath" exception as provided
008 * by Sun in the LICENSE file that accompanied this code.
009 *
010 * This code is distributed in the hope that it will be useful, but WITHOUT
011 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
012 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
013 * version 2 for more details (a copy is included in the LICENSE file that
014 * accompanied this code).
015 *
016 * You should have received a copy of the GNU General Public License version
017 * 2 along with this work; if not, write to the Free Software Foundation,
018 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
019 *
020 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
021 * CA 95054 USA or visit www.sun.com if you need additional information or
022 * have any questions.
023 */
024
025 /*
026 * This file is available under and governed by the GNU General Public
027 * License version 2 only, as published by the Free Software Foundation.
028 * However, the following notice accompanied the original version of this
029 * file and, per its terms, should not be removed:
030 *
031 * Copyright (c) 2000 World Wide Web Consortium,
032 * (Massachusetts Institute of Technology, Institut National de
033 * Recherche en Informatique et en Automatique, Keio University). All
034 * Rights Reserved. This program is distributed under the W3C's Software
035 * Intellectual Property License. This program is distributed in the
036 * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
037 * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
038 * PURPOSE.
039 * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
040 */
041
042 package org.w3c.dom.traversal;
043
044 import org.w3c.dom.Node;
045 import org.w3c.dom.DOMException;
046
047 /**
048 * <code>DocumentTraversal</code> contains methods that create
049 * <code>NodeIterators</code> and <code>TreeWalkers</code> to traverse a
050 * node and its children in document order (depth first, pre-order
051 * traversal, which is equivalent to the order in which the start tags occur
052 * in the text representation of the document). In DOMs which support the
053 * Traversal feature, <code>DocumentTraversal</code> will be implemented by
054 * the same objects that implement the Document interface.
055 * <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>.
056 * @since DOM Level 2
057 */
058 public interface DocumentTraversal {
059 /**
060 * Create a new <code>NodeIterator</code> over the subtree rooted at the
061 * specified node.
062 * @param root The node which will be iterated together with its
063 * children. The <code>NodeIterator</code> is initially positioned
064 * just before this node. The <code>whatToShow</code> flags and the
065 * filter, if any, are not considered when setting this position. The
066 * root must not be <code>null</code>.
067 * @param whatToShow This flag specifies which node types may appear in
068 * the logical view of the tree presented by the
069 * <code>NodeIterator</code>. See the description of
070 * <code>NodeFilter</code> for the set of possible <code>SHOW_</code>
071 * values.These flags can be combined using <code>OR</code>.
072 * @param filter The <code>NodeFilter</code> to be used with this
073 * <code>NodeIterator</code>, or <code>null</code> to indicate no
074 * filter.
075 * @param entityReferenceExpansion The value of this flag determines
076 * whether entity reference nodes are expanded.
077 * @return The newly created <code>NodeIterator</code>.
078 * @exception DOMException
079 * NOT_SUPPORTED_ERR: Raised if the specified <code>root</code> is
080 * <code>null</code>.
081 */
082 public NodeIterator createNodeIterator(Node root, int whatToShow,
083 NodeFilter filter, boolean entityReferenceExpansion)
084 throws DOMException;
085
086 /**
087 * Create a new <code>TreeWalker</code> over the subtree rooted at the
088 * specified node.
089 * @param root The node which will serve as the <code>root</code> for the
090 * <code>TreeWalker</code>. The <code>whatToShow</code> flags and the
091 * <code>NodeFilter</code> are not considered when setting this value;
092 * any node type will be accepted as the <code>root</code>. The
093 * <code>currentNode</code> of the <code>TreeWalker</code> is
094 * initialized to this node, whether or not it is visible. The
095 * <code>root</code> functions as a stopping point for traversal
096 * methods that look upward in the document structure, such as
097 * <code>parentNode</code> and nextNode. The <code>root</code> must
098 * not be <code>null</code>.
099 * @param whatToShow This flag specifies which node types may appear in
100 * the logical view of the tree presented by the
101 * <code>TreeWalker</code>. See the description of
102 * <code>NodeFilter</code> for the set of possible <code>SHOW_</code>
103 * values.These flags can be combined using <code>OR</code>.
104 * @param filter The <code>NodeFilter</code> to be used with this
105 * <code>TreeWalker</code>, or <code>null</code> to indicate no filter.
106 * @param entityReferenceExpansion If this flag is false, the contents of
107 * <code>EntityReference</code> nodes are not presented in the logical
108 * view.
109 * @return The newly created <code>TreeWalker</code>.
110 * @exception DOMException
111 * NOT_SUPPORTED_ERR: Raised if the specified <code>root</code> is
112 * <code>null</code>.
113 */
114 public TreeWalker createTreeWalker(Node root, int whatToShow,
115 NodeFilter filter, boolean entityReferenceExpansion)
116 throws DOMException;
117
118 }
|