Package net.sf.saxon.xom
Class DocumentWrapper
java.lang.Object
net.sf.saxon.xom.NodeWrapper
net.sf.saxon.xom.DocumentWrapper
- All Implemented Interfaces:
Source
,DocumentInfo
,Item
,NodeInfo
,SiblingCountingNode
,ValueRepresentation
,VirtualNode
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
FieldsFields 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.ValueRepresentation
EMPTY_VALUE_ARRAY
-
Constructor Summary
ConstructorsConstructorDescriptionDocumentWrapper
(nu.xom.Node root, String baseURI, Configuration config) Create a Saxon wrapper for a XOM root node -
Method Summary
Modifier and TypeMethodDescriptionGet the configuration previously set using setConfigurationint
Get the unique document number for this document (the number is unique for all documents within a NamePool)Get the name pool used for the names in this documentString[]
getUnparsedEntity
(String name) Get the unparsed entity with a given nameGet the element with a given ID, if anyvoid
setConfiguration
(Configuration config) Set the configuration, which defines the name pool used for all names in this document.wrap
(nu.xom.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, getDeclaredNamespaces, getDisplayName, getDocumentRoot, getFingerprint, getLineNumber, getLocalPart, getNameCode, getNodeKind, getParent, getPrefix, getRoot, getSiblingPosition, getStringValue, getStringValueCS, getSystemId, getTypeAnnotation, getTypedValue, getUnderlyingNode, getURI, hasChildNodes, hashCode, isSameNodeInfo, iterateAxis, iterateAxis, makeWrapper, makeWrapper, sendNamespaceDeclarations, setSystemId
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface net.sf.saxon.om.Item
getStringValueCS, getTypedValue
Methods inherited from interface net.sf.saxon.om.NodeInfo
atomize, compareOrder, copy, equals, generateId, getAttributeValue, getBaseURI, getDeclaredNamespaces, getDisplayName, getDocumentRoot, getFingerprint, getLineNumber, getLocalPart, getNameCode, getNodeKind, getParent, getPrefix, getRoot, getStringValue, getSystemId, getTypeAnnotation, getURI, hasChildNodes, hashCode, isSameNodeInfo, iterateAxis, iterateAxis, sendNamespaceDeclarations
Methods inherited from interface javax.xml.transform.Source
isEmpty, setSystemId
-
Field Details
-
config
-
baseURI
-
documentNumber
protected int documentNumber
-
-
Constructor Details
-
DocumentWrapper
Create a Saxon wrapper for a XOM root node- Parameters:
root
- The XOM root nodebaseURI
- The base URI for all the nodes in the treeconfig
- The configuration which defines the name pool used for all names in this tree
-
-
Method Details
-
wrap
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
-
setConfiguration
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
-
getConfiguration
Get the configuration previously set using setConfiguration- Specified by:
getConfiguration
in interfaceNodeInfo
- Overrides:
getConfiguration
in classNodeWrapper
- Returns:
- the Configuration
-
getNamePool
Get the name pool used for the names in this document- Specified by:
getNamePool
in interfaceNodeInfo
- Overrides:
getNamePool
in classNodeWrapper
- Returns:
- the name pool in which all the names used in this document are registered
-
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 interfaceNodeInfo
- Overrides:
getDocumentNumber
in classNodeWrapper
- Returns:
- the unique number identifying this document within the name pool
-
selectID
Get the element with a given ID, if any- Specified by:
selectID
in interfaceDocumentInfo
- 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).
-
getUnparsedEntity
Get the unparsed entity with a given name- Specified by:
getUnparsedEntity
in interfaceDocumentInfo
- Parameters:
name
- the name of the entity- Returns:
- null: XOM does not provide access to unparsed entities
-