org.w3c.dom.ElementTraversal 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) 2009 World Wide Web Consortium,
 *
 * (Massachusetts Institute of Technology, European Research Consortium for
 * Informatics and Mathematics, Keio University). All Rights Reserved. This
 * work is distributed under the W3C(r) Software License [1] 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.
 *
 * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
 */

package org.w3c.dom;

/**
 * The ElementTraversal interface is a set of read-only attributes
 * which allow an author to easily navigate between elements in a document.
 * In conforming implementations of Element Traversal, all objects that
 * implement {@link Element} must also implement the
 * ElementTraversal interface. Four of the methods,
 * {@link #getFirstElementChild}, {@link #getLastElementChild},
 * {@link #getPreviousElementSibling}, and {@link #getNextElementSibling},
 * each return a live reference to another element with the defined
 * relationship to the current element, if the related element exists. The
 * fifth method, {@link #getChildElementCount}, exposes the number of child
 * elements of an element, for preprocessing before navigation.
 * See also the
 * Element Traversal Specification.
 */
public interface ElementTraversal {

    /**
     * Returns the first child element node of this element. null
     * if this element has no child elements.
     */
    Element getFirstElementChild();

    /**
     * Returns the last child element node of this element. null
     * if this element has no child elements.
     */
    Element getLastElementChild();

    /**
     * Returns the previous sibling element node of this element.
     * null if this element has no element sibling nodes that
     * come before this one in the document tree.
     */
    Element getPreviousElementSibling();

    /**
     * Returns the next sibling element node of this element.
     * null if this element has no element sibling nodes that
     * come after this one in the document tree.
     */
    Element getNextElementSibling();

    /**
     * Returns the current number of element nodes that are children of this
     * element. 0 if this element has no child nodes that are of
     * nodeType 1.
     */
    int getChildElementCount();
}