org.w3c.dom.traversal.DocumentTraversal Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xercesImpl Show documentation

Xerces2 is the next generation of high performance, fully compliant XML parsers in the Apache Xerces family. This new version of Xerces introduces the Xerces Native Interface (XNI), a complete framework for building parser components and configurations that is extremely modular and easy to program. The Apache Xerces2 parser is the reference implementation of XNI but other parser components, configurations, and parsers can be written using the Xerces Native Interface. For complete design and implementation documents, refer to the XNI Manual. Xerces2 is a fully conforming XML Schema 1.0 processor. A partial experimental implementation of the XML Schema 1.1 Structures and Datatypes Working Drafts (December 2009) and an experimental implementation of the XML Schema Definition Language (XSD): Component Designators (SCD) Candidate Recommendation (January 2010) are provided for evaluation. For more information, refer to the XML Schema page. Xerces2 also provides a complete implementation of the Document Object Model Level 3 Core and Load/Save W3C Recommendations and provides a complete implementation of the XML Inclusions (XInclude) W3C Recommendation. It also provides support for OASIS XML Catalogs v1.1. Xerces2 is able to parse documents written according to the XML 1.1 Recommendation, except that it does not yet provide an option to enable normalization checking as described in section 2.13 of this specification. It also handles namespaces according to the XML Namespaces 1.1 Recommendation, and will correctly serialize XML 1.1 documents if the DOM level 3 load/save APIs are in use.

The newest version!

/*
 * Copyright (c) 2000 World Wide Web Consortium,
 * (Massachusetts Institute of Technology, Institut National de
 * Recherche en Informatique et en Automatique, Keio University). All
 * Rights Reserved. This program is distributed under the W3C's Software
 * Intellectual Property License. This program is distributed in the
 * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
 * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 * PURPOSE.
 * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
 */

package org.w3c.dom.traversal;

import org.w3c.dom.Node;
import org.w3c.dom.DOMException;

/**
 * DocumentTraversal contains methods that create 
 * NodeIterators and TreeWalkers to traverse a 
 * node and its children in document order (depth first, pre-order 
 * traversal, which is equivalent to the order in which the start tags occur 
 * in the text representation of the document). In DOMs which support the 
 * Traversal feature, DocumentTraversal will be implemented by 
 * the same objects that implement the Document interface.
 * See also the Document Object Model (DOM) Level 2 Traversal and Range Specification.
 * @since DOM Level 2
 */
public interface DocumentTraversal {
    /**
     * Create a new NodeIterator over the subtree rooted at the 
     * specified node.
     * @param root The node which will be iterated together with its 
     *   children. The NodeIterator is initially positioned 
     *   just before this node. The whatToShow flags and the 
     *   filter, if any, are not considered when setting this position. The 
     *   root must not be null.
     * @param whatToShow This flag specifies which node types may appear in 
     *   the logical view of the tree presented by the 
     *   NodeIterator. See the description of 
     *   NodeFilter for the set of possible SHOW_ 
     *   values.These flags can be combined using OR.
     * @param filter The NodeFilter to be used with this 
     *   NodeIterator, or null to indicate no 
     *   filter.
     * @param entityReferenceExpansion The value of this flag determines 
     *   whether entity reference nodes are expanded.
     * @return The newly created NodeIterator.
     * @exception DOMException
     *   NOT_SUPPORTED_ERR: Raised if the specified root is 
     *   null.
     */
    public NodeIterator createNodeIterator(Node root, 
                                           int whatToShow, 
                                           NodeFilter filter, 
                                           boolean entityReferenceExpansion)
                                           throws DOMException;

    /**
     * Create a new TreeWalker over the subtree rooted at the 
     * specified node.
     * @param root The node which will serve as the root for the 
     *   TreeWalker. The whatToShow flags and the 
     *   NodeFilter are not considered when setting this value; 
     *   any node type will be accepted as the root. The 
     *   currentNode of the TreeWalker is 
     *   initialized to this node, whether or not it is visible. The 
     *   root functions as a stopping point for traversal 
     *   methods that look upward in the document structure, such as 
     *   parentNode and nextNode. The root must 
     *   not be null.
     * @param whatToShow This flag specifies which node types may appear in 
     *   the logical view of the tree presented by the 
     *   TreeWalker. See the description of 
     *   NodeFilter for the set of possible SHOW_ 
     *   values.These flags can be combined using OR.
     * @param filter The NodeFilter to be used with this 
     *   TreeWalker, or null to indicate no filter.
     * @param entityReferenceExpansion If this flag is false, the contents of 
     *   EntityReference nodes are not presented in the logical 
     *   view.
     * @return The newly created TreeWalker.
     * @exception DOMException
     *    NOT_SUPPORTED_ERR: Raised if the specified root is 
     *   null.
     */
    public TreeWalker createTreeWalker(Node root, 
                                       int whatToShow, 
                                       NodeFilter filter, 
                                       boolean entityReferenceExpansion)
                                       throws DOMException;

}