net.sf.saxon.dom
Class DocumentWrapper

java.lang.Object
  extended bynet.sf.saxon.dom.NodeWrapper
      extended bynet.sf.saxon.dom.DocumentWrapper
All Implemented Interfaces:
DocumentInfo, Item, NodeInfo, SiblingCountingNode, javax.xml.transform.Source, 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  java.lang.String baseURI
           
protected  Configuration config
           
protected  int documentNumber
           
 
Fields inherited from class net.sf.saxon.dom.NodeWrapper
docWrapper, index, node, nodeKind
 
Fields inherited from interface net.sf.saxon.om.NodeInfo
ALL_NAMESPACES, EMPTY_NAMESPACE_LIST, LOCAL_NAMESPACES, NO_NAMESPACES
 
Constructor Summary
DocumentWrapper(org.w3c.dom.Document doc, java.lang.String baseURI, Configuration config)
           
 
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
 java.lang.String[] getUnparsedEntity(java.lang.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(java.lang.String id)
          Get the element with a given ID, if any
 void setConfiguration(Configuration config)
          Set the Configuration that contains this document
 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
compareOrder, copy, generateId, getAttributeValue, getBaseURI, getDeclaredNamespaces, getDisplayName, getDocumentRoot, getFingerprint, getLineNumber, getLocalPart, getNameCode, getNodeKind, getParent, getPrefix, getRoot, getSiblingPosition, getStringValue, getStringValue, getStringValueCS, getSystemId, getTypeAnnotation, getTypedValue, getUnderlyingNode, getURI, hasChildNodes, iterateAxis, iterateAxis, makeWrapper, makeWrapper, sendNamespaceDeclarations, setSystemId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface net.sf.saxon.om.NodeInfo
compareOrder, copy, generateId, getAttributeValue, getBaseURI, getDeclaredNamespaces, getDisplayName, getDocumentRoot, getFingerprint, getLineNumber, getLocalPart, getNameCode, getNodeKind, getParent, getPrefix, getRoot, getStringValue, getSystemId, getTypeAnnotation, getURI, hasChildNodes, iterateAxis, iterateAxis, sendNamespaceDeclarations
 
Methods inherited from interface javax.xml.transform.Source
setSystemId
 
Methods inherited from interface net.sf.saxon.om.Item
getStringValueCS, getTypedValue
 

Field Detail

config

protected Configuration config

baseURI

protected java.lang.String baseURI

documentNumber

protected int documentNumber
Constructor Detail

DocumentWrapper

public DocumentWrapper(org.w3c.dom.Document doc,
                       java.lang.String baseURI,
                       Configuration config)
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

setConfiguration

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

Specified by:
setConfiguration in interface DocumentInfo
Parameters:
config - The configuration to be used

getConfiguration

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

Specified by:
getConfiguration in interface NodeInfo
Overrides:
getConfiguration in class 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 class NodeWrapper
Returns:
the NamePool

getDocumentNumber

public int getDocumentNumber()
Get the unique document number

Specified by:
getDocumentNumber in interface NodeInfo
Overrides:
getDocumentNumber in class NodeWrapper

selectID

public NodeInfo selectID(java.lang.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.

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 class NodeWrapper
Returns:
true if this Node object and the supplied Node object represent the same node in the tree.

getUnparsedEntity

public java.lang.String[] getUnparsedEntity(java.lang.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