Package net.sf.saxon.dom
Class DocumentWrapper
- java.lang.Object
-
- net.sf.saxon.dom.NodeWrapper
-
- net.sf.saxon.dom.DocumentWrapper
-
- All Implemented Interfaces:
javax.xml.transform.Source
,PullEvent
,DocumentInfo
,Item<NodeInfo>
,NodeInfo
,ValueRepresentation<NodeInfo>
,SiblingCountingNode
,VirtualNode
public class DocumentWrapper extends NodeWrapper implements DocumentInfo
The document node of a tree implemented as a wrapper around a DOM Document.
-
-
Field Summary
Fields Modifier and Type Field Description protected java.lang.String
baseURI
protected Configuration
config
protected long
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, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES
-
Fields inherited from interface net.sf.saxon.om.ValueRepresentation
EMPTY_VALUE_ARRAY
-
-
Constructor Summary
Constructors Constructor Description DocumentWrapper(org.w3c.dom.Node doc, java.lang.String baseURI, Configuration config)
Wrap a DOM Document or DocumentFragment node
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Configuration
getConfiguration()
Get the configuration previously set using setConfigurationlong
getDocumentNumber()
Get the unique document numberNamePool
getNamePool()
Get the name pool used for the names in this documentSchemaType
getSchemaType()
Get the type annotation of this node, if any.int
getTypeAnnotation()
Get the type annotation.java.lang.String[]
getUnparsedEntity(java.lang.String name)
Get the unparsed entity with a given namejava.util.Iterator<java.lang.String>
getUnparsedEntityNames()
Get the list of unparsed entities defined in this documentjava.lang.Object
getUserData(java.lang.String key)
Get user data held in the document node.boolean
isSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node.boolean
isTyped()
Ask whether the document contains any nodes whose type annotation is anything other than UNTYPEDNodeInfo
selectID(java.lang.String id, boolean getParent)
Get the element with a given ID, if anyvoid
setConfiguration(Configuration config)
Set the Configuration that contains this documentvoid
setUserData(java.lang.String key, java.lang.Object value)
Set user data on the document node.NodeWrapper
wrap(org.w3c.dom.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, getAttributeValue, getBaseURI, getColumnNumber, getDeclaredNamespaces, getDisplayName, getDocumentRoot, getFingerprint, getLineNumber, getLocalPart, getNameCode, getNodeKind, getParent, getPrefix, getRealNode, getRoot, getSiblingPosition, getStringValue, getStringValueCS, getSystemId, getTypedValue, getUnderlyingNode, getURI, hasChildNodes, hashCode, isId, isIdref, isNilled, iterateAxis, iterateAxis, makeWrapper, makeWrapper, 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, getAttributeValue, getBaseURI, getColumnNumber, getDeclaredNamespaces, getDisplayName, getDocumentRoot, getFingerprint, getLineNumber, getLocalPart, getNameCode, getNodeKind, getParent, getPrefix, getRoot, getStringValue, getSystemId, getURI, hasChildNodes, hashCode, isId, isIdref, isNilled, iterateAxis, iterateAxis
-
-
-
-
Field Detail
-
config
protected Configuration config
-
baseURI
protected java.lang.String baseURI
-
documentNumber
protected long documentNumber
-
domLevel3
protected boolean domLevel3
-
-
Constructor Detail
-
DocumentWrapper
public DocumentWrapper(org.w3c.dom.Node doc, java.lang.String baseURI, Configuration config)
Wrap a DOM Document or DocumentFragment node- Parameters:
doc
- a DOM Document or DocumentFragment nodebaseURI
- the base URI of the documentconfig
- the Saxon configuration
-
-
Method Detail
-
wrap
public NodeWrapper wrap(org.w3c.dom.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- Returns:
- the wrapped node
- Throws:
java.lang.IllegalArgumentException
- if the node is not a descendant of the Document node wrapped by this DocumentWrapper
-
setConfiguration
public void setConfiguration(Configuration config)
Set the Configuration that contains this document- Parameters:
config
- the Saxon configuration
-
getConfiguration
public Configuration getConfiguration()
Get the configuration previously set using setConfiguration- Specified by:
getConfiguration
in interfaceNodeInfo
- Overrides:
getConfiguration
in classNodeWrapper
- Returns:
- the Configuration
-
getNamePool
public NamePool getNamePool()
Get the name pool used for the names in this document- Specified by:
getNamePool
in interfaceNodeInfo
- Overrides:
getNamePool
in classNodeWrapper
- Returns:
- the NamePool
-
isTyped
public boolean isTyped()
Ask whether the document contains any nodes whose type annotation is anything other than UNTYPED- Specified by:
isTyped
in interfaceDocumentInfo
- Returns:
- true if the document contains elements whose type is other than UNTYPED
-
getDocumentNumber
public long getDocumentNumber()
Get the unique document number- Specified by:
getDocumentNumber
in interfaceNodeInfo
- Overrides:
getDocumentNumber
in classNodeWrapper
- Returns:
- the document number of the document containing this node
-
selectID
public NodeInfo selectID(java.lang.String id, boolean getParent)
Get the element with a given ID, if any- Specified by:
selectID
in interfaceDocumentInfo
- Parameters:
id
- the required ID valuegetParent
- true if the parent of the element having the given ID value is required- 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.
-
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 interfaceNodeInfo
- Overrides:
isSameNodeInfo
in classNodeWrapper
- Parameters:
other
- the node to be compared with this node- Returns:
- true if this Node object and the supplied Node object represent the same node in the tree.
-
getUnparsedEntityNames
public java.util.Iterator<java.lang.String> getUnparsedEntityNames()
Get the list of unparsed entities defined in this document- Specified by:
getUnparsedEntityNames
in interfaceDocumentInfo
- 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
- Since:
- 9.1 (implemented for this subclass since 9.2)
-
getUnparsedEntity
public java.lang.String[] getUnparsedEntity(java.lang.String name)
Get the unparsed entity with a given name- Specified by:
getUnparsedEntity
in interfaceDocumentInfo
- 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 (as an absolute URI if possible), 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 (implemented for this subclass since 9.2)
-
getTypeAnnotation
public int getTypeAnnotation()
Get the type annotation. Always XS_UNTYPED.- Specified by:
getTypeAnnotation
in interfaceNodeInfo
- Overrides:
getTypeAnnotation
in classNodeWrapper
- Returns:
- the type annotation of the node, under the mask NamePool.FP_MASK, and optionally the
bit setting IS_DTD_TYPE in the case of a DTD-derived ID or IDREF/S type (which is treated
as untypedAtomic for the purposes of obtaining the typed value).
For elements and attributes, this is the type annotation as defined in XDM. For document nodes, it should be one of XS_UNTYPED if the document has not been validated, or XS_ANY_TYPE if validation has taken place (that is, if any node in the document has an annotation other than Untyped or UntypedAtomic).
-
getSchemaType
public SchemaType getSchemaType()
Get the type annotation of this node, if any. The type annotation is represented as SchemaType object.Types derived from a DTD are not reflected in the result of this method.
- Specified by:
getSchemaType
in interfaceNodeInfo
- Overrides:
getSchemaType
in classNodeWrapper
- Returns:
- For element and attribute nodes: the type annotation derived from schema validation (defaulting to xs:untyped and xs:untypedAtomic in the absence of schema validation). For comments, text nodes, processing instructions, and namespaces: null. For document nodes, either xs:untyped if the document has not been validated, or xs:anyType if it has.
- Since:
- 9.4
-
setUserData
public void setUserData(java.lang.String key, java.lang.Object value)
Set user data on the document node. The user data can be retrieved subsequently usinggetUserData(java.lang.String)
- Specified by:
setUserData
in interfaceDocumentInfo
- Parameters:
key
- A string giving the name of the property to be set. Clients are responsible for choosing a key that is likely to be unique. Must not be null. Keys used internally by Saxon are prefixed "saxon:".value
- The value to be set for the property. May be null, which effectively removes the existing value for the property.
-
getUserData
public java.lang.Object getUserData(java.lang.String key)
Get user data held in the document node. This retrieves properties previously set usingsetUserData(java.lang.String, java.lang.Object)
- Specified by:
getUserData
in interfaceDocumentInfo
- Parameters:
key
- A string giving the name of the property to be retrieved.- Returns:
- the value of the property, or null if the property has not been defined.
-
-