net.sf.saxon.option.dom4j
Class DocumentWrapper

java.lang.Object
  extended by net.sf.saxon.option.dom4j.NodeWrapper
      extended by net.sf.saxon.option.dom4j.DocumentWrapper
All Implemented Interfaces:
Source, PullEvent, DocumentInfo, Item, NodeInfo, SiblingCountingNode, ValueRepresentation, 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:
Michael H. Kay

Field Summary
protected  String baseURI
           
protected  Configuration config
           
protected  long documentNumber
           
 
Fields inherited from class net.sf.saxon.option.dom4j.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
DocumentWrapper(org.dom4j.Document doc, String baseURI, Configuration config)
          Create a Saxon wrapper for a dom4j document
 
Method Summary
 Configuration getConfiguration()
          Get the configuration previously set using setConfiguration (or the default configuraton allocated automatically)
 long getDocumentNumber()
          Get the unique document number
 NamePool getNamePool()
          Get the name pool used for the names in this document
 int getTypeAnnotation()
          Get the type annotation.
 String[] getUnparsedEntity(String name)
          Get the unparsed entity with a given name
 Iterator<String> getUnparsedEntityNames()
          Get the list of unparsed entities defined in this document
 NodeInfo selectID(String id, boolean getParent)
          Get the element with a given ID, if any
 void setConfiguration(Configuration config)
          Set the configuration (containing the name pool used for all names in this document).
 NodeInfo wrap(Object node)
          Wrap a node in the dom4j document.
 
Methods inherited from class net.sf.saxon.option.dom4j.NodeWrapper
atomize, compareOrder, copy, generateId, getAttributeValue, getBaseURI, getColumnNumber, getDeclaredNamespaces, getDisplayName, getDocumentRoot, getFingerprint, getLineNumber, getLocalPart, getNameCode, getNodeKind, getParent, getPrefix, getRealNode, getRoot, getSiblingPosition, getStringValue, getStringValueCS, getSystemId, getTypedValue, getUnderlyingNode, getURI, hasChildNodes, isId, isIdref, isNilled, isSameNode, isSameNodeInfo, 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
atomize, compareOrder, copy, equals, generateId, getAttributeValue, getBaseURI, getColumnNumber, getDeclaredNamespaces, getDisplayName, getDocumentRoot, getFingerprint, getLineNumber, getLocalPart, getNameCode, getNodeKind, getParent, getPrefix, getRoot, getStringValue, getSystemId, getURI, hasChildNodes, hashCode, isId, isIdref, isNilled, isSameNodeInfo, iterateAxis, iterateAxis
 
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 String baseURI

documentNumber

protected long documentNumber
Constructor Detail

DocumentWrapper

public DocumentWrapper(org.dom4j.Document doc,
                       String baseURI,
                       Configuration config)
Create a Saxon wrapper for a dom4j document

Parameters:
doc - The dom4j document
baseURI - The base URI for all the nodes in the document
config - The Saxon configuration
Method Detail

wrap

public NodeInfo wrap(Object node)
Wrap a node in the dom4j 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

getDocumentNumber

public long getDocumentNumber()
Get the unique document number

Specified by:
getDocumentNumber in interface NodeInfo
Overrides:
getDocumentNumber in class NodeWrapper
Returns:
the document number of the document containing this node

selectID

public NodeInfo selectID(String id,
                         boolean getParent)
Get the element with a given ID, if any

Specified by:
selectID in interface DocumentInfo
Parameters:
id - the required ID value
getParent -
Returns:
null: dom4j does not provide any information about attribute types.

getUnparsedEntityNames

public Iterator<String> getUnparsedEntityNames()
Get the list of unparsed entities defined in this document

Specified by:
getUnparsedEntityNames in interface DocumentInfo
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

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

getConfiguration

public Configuration getConfiguration()
Get the configuration previously set using setConfiguration (or the default configuraton allocated automatically)

Specified by:
getConfiguration in interface NodeInfo
Overrides:
getConfiguration in class NodeWrapper
Returns:
the Configuration

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

setConfiguration

public void setConfiguration(Configuration config)
Set the configuration (containing the name pool used for all names in this document). Calling this method allocates a unique number to the document (unique within the Configuration); this will form the basis for testing node identity

Parameters:
config - the configuration

getTypeAnnotation

public int getTypeAnnotation()
Get the type annotation. Always XS_UNTYPED.

Specified by:
getTypeAnnotation in interface NodeInfo
Overrides:
getTypeAnnotation in class NodeWrapper
Returns:
UNTYPED or UNTYPED_ATOMIC


Copyright (c) Saxonica Limited. All rights reserved.