net.sf.saxon.xom

Class DocumentWrapper

Implemented Interfaces:
DocumentInfo, ExtendedNodeInfo, Item, NodeInfo, Source, Item, NodeInfo, PullEvent, SiblingCountingNode, ValueRepresentation, VirtualNode

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.

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

Field Summary

protected String
baseURI
protected Configuration
config
protected int
documentNumber

Fields inherited from class net.sf.saxon.xom.NodeWrapper

docWrapper, index, node, nodeKind

Fields inherited from interface net.sf.saxon.om.NodeInfo

ALL_NAMESPACES, EMPTY_NAMESPACE_LIST, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES

Fields inherited from interface net.sf.saxon.om.NodeInfo

ALL_NAMESPACES, EMPTY_NAMESPACE_LIST, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES

Fields inherited from interface net.sf.saxon.om.ValueRepresentation

EMPTY_VALUE_ARRAY

Constructor Summary

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

Method Summary

Configuration
getConfiguration()
Get the configuration previously set using setConfiguration
int
getDocumentNumber()
Get the unique document number for this document (the number is unique for all documents within a NamePool)
NamePool
getNamePool()
Get the name pool used for the names in this document
String[]
getUnparsedEntity(String name)
Get the unparsed entity with a given name
NodeInfo
selectID(String id)
Get the element with a given ID, if any
void
setConfiguration(Configuration config)
Set the configuration, which defines the name pool used for all names in this document.
NodeInfo
wrap(Node node)
Wrap a node in the XOM document.

Methods inherited from class net.sf.saxon.xom.NodeWrapper

atomize, compareOrder, copy, equals, generateId, getAttributeValue, getBaseURI, getConfiguration, getDeclaredNamespaces, getDisplayName, getDocumentNumber, getDocumentRoot, getFingerprint, getLineNumber, getLocalPart, getNameCode, getNamePool, getNodeKind, getParent, getPrefix, getRoot, getSiblingPosition, getStringValue, getStringValueCS, getSystemId, getTypeAnnotation, getTypedValue, getURI, getUnderlyingNode, hasChildNodes, hashCode, isId, isIdref, isNilled, isSameNodeInfo, iterateAxis, iterateAxis, makeWrapper, makeWrapper, setSystemId

Field Details

baseURI

protected String baseURI

config

protected Configuration config

documentNumber

protected int documentNumber

Constructor Details

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 Details

getConfiguration

public Configuration getConfiguration()
Get the configuration previously set using setConfiguration
Specified by:
getConfiguration in interface NodeInfo
Overrides:
getConfiguration in interface NodeWrapper

getDocumentNumber

public int getDocumentNumber()
Get the unique document number for this document (the number is unique for all documents within a NamePool)
Specified by:
getDocumentNumber in interface NodeInfo
Overrides:
getDocumentNumber in interface NodeWrapper
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
Specified by:
getNamePool in interface NodeInfo
Overrides:
getNamePool in interface NodeWrapper
Returns:
the name pool in which all the names used in this document are registered

getUnparsedEntity

public String[] getUnparsedEntity(String name)
Get the unparsed entity with a given name
Specified by:
getUnparsedEntity in interface DocumentInfo
Parameters:
name - the name of the entity
Returns:
null: XOM does not provide access to unparsed entities

selectID

public NodeInfo selectID(String id)
Get the element with a given ID, if any
Specified by:
selectID in interface DocumentInfo
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).

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