net.sf.saxon.dom

Class DocumentWrapper

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

public class DocumentWrapper
extends NodeWrapper
implements DocumentInfo

The document node of a tree implemented as a wrapper around a DOM Document.

Field Summary

protected String
baseURI
protected Configuration
config
protected int
documentNumber
protected boolean
domLevel3

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

docWrapper, index, node, nodeKind, span

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 doc, String baseURI, Configuration config)
Wrap a DOM Document or DocumentFragment node

Method Summary

Configuration
getConfiguration()
Get the configuration previously set using setConfiguration
int
getDocumentNumber()
Get the unique document number
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
boolean
isSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node.
NodeInfo
selectID(String id)
Get the element with a given ID, if any
void
setConfiguration(Configuration config)
Set the Configuration that contains this document
NodeWrapper
wrap(Node node)
Create a wrapper for a node in this document

Methods inherited from class net.sf.saxon.dom.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, isSameNodeInfo, iterateAxis, iterateAxis, makeWrapper, makeWrapper, setSystemId

Field Details

baseURI

protected String baseURI

config

protected Configuration config

documentNumber

protected int documentNumber

domLevel3

protected boolean domLevel3

Constructor Details

DocumentWrapper

public DocumentWrapper(Node doc,
                       String baseURI,
                       Configuration config)
Wrap a DOM Document or DocumentFragment node
Parameters:
doc - a DOM Document or DocumentFragment node
baseURI - the base URI of the document
config - the Saxon configuration

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
Specified by:
getDocumentNumber in interface NodeInfo
Overrides:
getDocumentNumber in interface NodeWrapper

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

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: JDOM does not provide access to unparsed entities

isSameNodeInfo

public boolean isSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node.
Note: a.isSameNode(b) if and only if generateId(a)==generateId(b)
Specified by:
isSameNodeInfo in interface NodeInfo
Overrides:
isSameNodeInfo in interface NodeWrapper
Returns:
true if this Node object and the supplied Node object represent the same node in the tree.

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:
a NodeInfo representing the element with the given ID, or null if there is no such element. This implementation does not necessarily conform to the rule that if an invalid document contains two elements with the same ID, the one that comes last should be returned.

setConfiguration

public void setConfiguration(Configuration config)
Set the Configuration that contains this document

wrap

public NodeWrapper wrap(Node node)
Create a wrapper for a node in this document
Parameters:
node - the DOM node to be wrapped. This must be a node within the document wrapped by this DocumentWrapper