net.sf.saxon.om

Interface DocumentInfo

public interface DocumentInfo extends NodeInfo

This interface represents a document node as defined in the XPath 2.0 data model. It extends NodeInfo, which is used to represent any node. Every document node must be an instance of DocumentInfo.

The interface supports two methods in addition to those for NodeInfo: one to find elements given their ID value, and one to locate unparsed entities. In addition, document nodes have an important property that is not true of nodes in general: two distinct Java DocumentInfo objects never represent the same document node. So the Java "==" operator returns the same result as the NodeInfo method.

This interface is part of the Saxon public API, and as such (from Saxon8.4 onwards) those methods that form part of the stable public API are labelled with a JavaDoc "since" tag to indicate when they were added to the product.

Since: 8.4

Author: Michael H. Kay

Method Summary
String[]getUnparsedEntity(String name)
Get the unparsed entity with a given name
Iterator<String>getUnparsedEntityNames()
Get the list of unparsed entities defined in this document
NodeInfoselectID(String id, boolean getParent)
Get the element with a given ID, if any

Method Detail

getUnparsedEntity

public String[] getUnparsedEntity(String name)
Get the unparsed entity with a given name

Parameters: name the name of the entity

Returns: if the entity exists, return an array of two Strings, the first holding the system ID of the entity (as an absolute URI if possible), the second holding the public ID if there is one, or null if not. If the entity does not exist, the method returns null. Applications should be written on the assumption that this array may be extended in the future to provide additional information.

Since: 8.4

getUnparsedEntityNames

public Iterator<String> getUnparsedEntityNames()
Get the list of unparsed entities defined in this document

Returns: an Iterator, whose items are of type String, containing the names of all unparsed entities defined in this document. If there are no unparsed entities or if the information is not available then an empty iterator is returned

Since: 9.1

selectID

public NodeInfo selectID(String id, boolean getParent)
Get the element with a given ID, if any

Parameters: id the required ID value getParent true if running the element-with-id() function rather than the id() function; the difference is that in the case of an element of type xs:ID, the parent of the element should be returned, not the element itself.

Returns: the element with the given ID, or null if there is no such ID present (or if the parser has not notified attributes as being of type ID)

Since: 8.4. Second argument added in 9.2.