| net.sf.saxon.om.DocumentInfo
All known Subclasses: net.sf.saxon.tree.DocumentImpl, net.sf.saxon.xom.DocumentWrapper, net.sf.saxon.pull.UnconstructedDocument, net.sf.saxon.value.TextFragmentValue, net.sf.saxon.tinytree.TinyDocumentImpl, net.sf.saxon.om.VirtualDocumentCopy, net.sf.saxon.om.StrippedDocument, net.sf.saxon.jdom.DocumentWrapper, net.sf.saxon.dom.DocumentWrapper,
DocumentInfo | public interface DocumentInfo extends NodeInfo(Code) | | 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.isSameNodeInfo 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.
author: Michael H. Kay since: 8.4 |
Method Summary | |
public String[] | getUnparsedEntity(String name) Get the unparsed entity with a given name
Parameters: name - the name of the entity if the entity exists, return an array of two Strings, the firstholding the system ID of the entity, the second holding the publicID if there is one, or null if not. | public NodeInfo | selectID(String id) |
getUnparsedEntity | public String[] getUnparsedEntity(String name)(Code) | | Get the unparsed entity with a given name
Parameters: name - the name of the entity if the entity exists, return an array of two Strings, the firstholding the system ID of the entity, the second holding the publicID if there is one, or null if not. If the entity does not exist,the method returns null. Applications should be written on theassumption that this array may be extended in the future to provideadditional information. since: 8.4 |
selectID | public NodeInfo selectID(String id)(Code) | | Get the element with a given ID, if any
Parameters: id - the required ID value the element with the given ID, or null if there is no such IDpresent (or if the parser has not notified attributes as being oftype ID) since: 8.4 |
|
|