net.sf.saxon.pull

Class UnconstructedDocument

public class UnconstructedDocument extends UnconstructedParent implements DocumentInfo

A document node whose construction is deferred.

(TODO) NOTE: this class is an exception to the general rule that for document nodes, node identity implies object identity
Constructor Summary
UnconstructedDocument(DocumentInstr instruction, XPathContext context)
Method Summary
StringgetDisplayName()
Get the display name of this node.
DocumentInfogetDocumentRoot()
Get the root node, if it is a document node.
intgetFingerprint()
Get fingerprint.
StringgetLocalPart()
Get the local part of the name of this node.
intgetNameCode()
Get name code.
intgetNodeKind()
StringgetPrefix()
Get the prefix of the name of the node.
String[]getUnparsedEntity(String name)
Get the unparsed entity with a given name
StringgetURI()
Get the URI part of the name of this node.
NodeInfoselectID(String id)
Get the element with a given ID, if any

Constructor Detail

UnconstructedDocument

public UnconstructedDocument(DocumentInstr instruction, XPathContext context)

Method Detail

getDisplayName

public String getDisplayName()
Get the display name of this node. For elements and attributes this is [prefix:]localname. For unnamed nodes, it is an empty string.

Returns: The display name of this node. For a node with no name, return an empty string.

getDocumentRoot

public DocumentInfo getDocumentRoot()
Get the root node, if it is a document node.

Returns: the DocumentInfo representing the containing document. If this node is part of a tree that does not have a document node as its root, return null.

getFingerprint

public int getFingerprint()
Get fingerprint. The fingerprint is a coded form of the expanded name of the node: two nodes with the same name code have the same namespace URI and the same local name. A fingerprint of -1 should be returned for a node with no name.

Returns: an integer fingerprint; two nodes with the same fingerprint have the same expanded QName

getLocalPart

public String getLocalPart()
Get the local part of the name of this node. This is the name after the ":" if any.

Returns: the local part of the name. For an unnamed node, returns "". Unlike the DOM interface, this returns the full name in the case of a non-namespaced name.

getNameCode

public int getNameCode()
Get name code. The name code is a coded form of the node name: two nodes with the same name code have the same namespace URI, the same local name, and the same prefix. By masking the name code with &0xfffff, you get a fingerprint: two nodes with the same fingerprint have the same local name and namespace URI.

Returns: an integer name code, which may be used to obtain the actual node name from the name pool

See Also: allocate getFingerprint

getNodeKind

public int getNodeKind()

getPrefix

public String getPrefix()
Get the prefix of the name of the node. This is defined only for elements and attributes. If the node has no prefix, or for other kinds of node, return a zero-length string.

Returns: The prefix of the name of the node.

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, 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

getURI

public String getURI()
Get the URI part of the name of this node. This is the URI corresponding to the prefix, or the URI of the default namespace if appropriate.

Returns: The URI of the namespace of this node. For an unnamed node, or for a node with an empty prefix, return an empty string.

selectID

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

Parameters: id the required ID value

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