net.sf.saxon.option.xom

Class DocumentWrapper

public class DocumentWrapper extends NodeWrapper implements DocumentInfo

The root node of an XPath tree. (Or equivalently, the tree itself).

This class is used not only for a document, but also for the root of a document-less tree fragment.

Author: Michael H. Kay Wolfgang Hoschek (ported net.sf.saxon.jdom to XOM)

Field Summary
protected StringbaseURI
protected Configurationconfig
protected longdocumentNumber
Constructor Summary
DocumentWrapper(Node root, String baseURI, Configuration config)
Create a Saxon wrapper for a XOM root node
Method Summary
ConfigurationgetConfiguration()
Get the configuration previously set using setConfiguration
longgetDocumentNumber()
Get the unique document number for this document (the number is unique for all documents within a NamePool)
NamePoolgetNamePool()
Get the name pool used for the names in this document
intgetTypeAnnotation()
Get the type annotation of this node, if any.
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
voidsetConfiguration(Configuration config)
Set the configuration, which defines the name pool used for all names in this document.
NodeInfowrap(Node node)
Wrap a node in the XOM document.

Field Detail

baseURI

protected String baseURI

config

protected Configuration config

documentNumber

protected long documentNumber

Constructor Detail

DocumentWrapper

public DocumentWrapper(Node root, String baseURI, Configuration config)
Create a Saxon wrapper for a XOM root node

Parameters: root The XOM root node baseURI The base URI for all the nodes in the tree config The configuration which defines the name pool used for all names in this tree

Method Detail

getConfiguration

public Configuration getConfiguration()
Get the configuration previously set using setConfiguration

getDocumentNumber

public long getDocumentNumber()
Get the unique document number for this document (the number is unique for all documents within a NamePool)

Returns: the unique number identifying this document within the name pool

getNamePool

public NamePool getNamePool()
Get the name pool used for the names in this document

Returns: the name pool in which all the names used in this document are registered

getTypeAnnotation

public int getTypeAnnotation()
Get the type annotation of this node, if any. Returns -1 for kinds of nodes that have no annotation, and for elements annotated as untyped, and attributes annotated as untypedAtomic.

Returns: the type annotation of the node.

See Also: Type

getUnparsedEntity

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

Parameters: name the name of the entity

Returns: null: XOM does not provide access to unparsed entities

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

selectID

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

Parameters: id the required ID value getParent

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).

setConfiguration

public void setConfiguration(Configuration config)
Set the configuration, which defines the name pool used for all names in this document. This is always called after a new document has been created. The implementation must register the name pool with the document, so that it can be retrieved using getNamePool(). It must also call NamePool.allocateDocumentNumber(), and return the relevant document number when getDocumentNumber() is subsequently called.

Parameters: config The configuration to be used

wrap

public NodeInfo wrap(Node node)
Wrap a node in the XOM document.

Parameters: node The node to be wrapped. This must be a node in the same document (the system does not check for this).

Returns: the wrapping NodeInfo object