net.sf.saxon.dom
Class DocumentWrapper

java.lang.Object
  extended by net.sf.saxon.dom.NodeWrapper
      extended by net.sf.saxon.dom.DocumentWrapper
All Implemented Interfaces:
Source, DocumentInfo, Item, NodeInfo, SiblingCountingNode, VirtualNode

public class DocumentWrapper
extends NodeWrapper
implements DocumentInfo

The root node of an XPath tree. (Or equivalently, the tree itself).

This class should have been named Root; it is used not only for the root of a document, but also for the root of a result tree fragment, which is not constrained to contain a single top-level element.

Author:
Field Summary
protected  String baseURI
           
protected  int documentNumber
           
protected  NamePool namePool
           
 
Fields inherited from class net.sf.saxon.dom.NodeWrapper
docWrapper, index, node, nodeKind
 
Fields inherited from interface net.sf.saxon.om.NodeInfo
ALL_NAMESPACES, LOCAL_NAMESPACES, NO_NAMESPACES
 
Constructor Summary
DocumentWrapper(Document doc, String baseURI)
           
 
Method Summary
 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 isSameNode(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 setNamePool(NamePool pool)
          Set the name pool used for all names in this document
 NodeWrapper wrap(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, getDisplayName, getDocumentRoot, getFingerprint, getLineNumber, getLocalPart, getNameCode, getNodeKind, getParent, getRoot, getSiblingPosition, getStringValue, getStringValue, getSystemId, getTypeAnnotation, getTypedValue, getUnderlyingNode, getURI, hasChildNodes, iterateAxis, iterateAxis, makeWrapper, makeWrapper, outputNamespaceNodes, 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, getDisplayName, getDocumentRoot, getFingerprint, getLineNumber, getLocalPart, getNameCode, getNodeKind, getParent, getRoot, getStringValue, getSystemId, getTypeAnnotation, getURI, hasChildNodes, iterateAxis, iterateAxis, outputNamespaceNodes
 
Methods inherited from interface javax.xml.transform.Source
setSystemId
 
Methods inherited from interface net.sf.saxon.om.Item
getTypedValue
 

Field Detail

namePool

protected NamePool namePool

baseURI

protected String baseURI

documentNumber

protected int documentNumber
Constructor Detail

DocumentWrapper

public DocumentWrapper(Document doc,
                       String baseURI)
Method Detail

wrap

public NodeWrapper wrap(Node node)
Create a wrapper for a node in this document


setNamePool

public void setNamePool(NamePool pool)
Set the name pool used for all names in this document

Specified by:
setNamePool in interface DocumentInfo
Parameters:
pool - The name pool to be used

getNamePool

public NamePool getNamePool()
Get the name pool used for the names in this document

Specified by:
getNamePool in interface DocumentInfo
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 DocumentInfo
Specified by:
getDocumentNumber in interface NodeInfo
Overrides:
getDocumentNumber in class NodeWrapper
Returns:
the unique number identifying this document within the name pool

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.

isSameNode

public boolean isSameNode(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:
isSameNode in interface NodeInfo
Overrides:
isSameNode in class NodeWrapper
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.

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