org.w3c.dom.Entity 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) 2004 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;

/**
 * This interface represents a known entity, either parsed or unparsed, in an 
 * XML document. Note that this models the entity itself not the entity declaration.
 * The nodeName attribute that is inherited from 
 * Node contains the name of the entity.
 * 
An XML processor may choose to completely expand entities before the 
 * structure model is passed to the DOM; in this case there will be no 
 * EntityReference nodes in the document tree.
 * 
XML does not mandate that a non-validating XML processor read and 
 * process entity declarations made in the external subset or declared in 
 * parameter entities. This means that parsed entities declared in the 
 * external subset need not be expanded by some classes of applications, and 
 * that the replacement text of the entity may not be available. When the 
 * replacement text is available, the corresponding Entity node's child list 
 * represents the structure of that replacement value. Otherwise, the child 
 * list is empty.
 * 
DOM Level 3 does not support editing Entity nodes; if a 
 * user wants to make changes to the contents of an Entity, 
 * every related EntityReference node has to be replaced in the 
 * structure model by a clone of the Entity's contents, and 
 * then the desired changes must be made to each of those clones instead. 
 * Entity nodes and all their descendants are readonly.
 * 
An Entity node does not have any parent.
 * 
Note: If the entity contains an unbound namespace prefix, the 
 * namespaceURI of the corresponding node in the 
 * Entity node subtree is null. The same is true 
 * for EntityReference nodes that refer to this entity, when 
 * they are created using the createEntityReference method of 
 * the Document interface.
 * See also the Document Object Model (DOM) Level 3 Core Specification.
 */
public interface Entity extends Node {
    /**
     * The public identifier associated with the entity if specified, and 
     * null otherwise.
     */
    public String getPublicId();

    /**
     * The system identifier associated with the entity if specified, and 
     * null otherwise. This may be an absolute URI or not.
     */
    public String getSystemId();

    /**
     * For unparsed entities, the name of the notation for the entity. For 
     * parsed entities, this is null.
     */
    public String getNotationName();

    /**
     * An attribute specifying the encoding used for this entity at the time 
     * of parsing, when it is an external parsed entity. This is 
     * null if it an entity from the internal subset or if it 
     * is not known.
     * @since DOM Level 3
     */
    public String getInputEncoding();

    /**
     * An attribute specifying, as part of the text declaration, the encoding 
     * of this entity, when it is an external parsed entity. This is 
     * null otherwise.
     * @since DOM Level 3
     */
    public String getXmlEncoding();

    /**
     * An attribute specifying, as part of the text declaration, the version 
     * number of this entity, when it is an external parsed entity. This is 
     * null otherwise.
     * @since DOM Level 3
     */
    public String getXmlVersion();

}