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, 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

Fields
Modifier and Type Field Description

protected java.lang.String baseURI

protected Configuration config

protected int documentNumber

protected boolean domLevel3
- 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 class net.sf.saxon.dom.NodeWrapper
  docWrapper, index, node, nodeKind, span
- Fields inherited from interface net.sf.saxon.om.ValueRepresentation
  EMPTY_VALUE_ARRAY

Fields
Modifier and Type	Field	Description
`protected java.lang.String`	`baseURI`
`protected Configuration`	`config`
`protected int`	`documentNumber`
`protected boolean`	`domLevel3`

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 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
`java.util.Iterator`	`getUnparsedEntityNames()`	Get the list of unparsed entities defined in this document
`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 interface net.sf.saxon.om.Item
getStringValueCS, getTypedValue

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, getTypeAnnotation, getURI, hasChildNodes, hashCode, isId, isIdref, isNilled, iterateAxis, iterateAxis

Methods inherited from class net.sf.saxon.dom.NodeWrapper
atomize, compareOrder, copy, equals, generateId, getAttributeValue, getBaseURI, getColumnNumber, getDeclaredNamespaces, getDisplayName, getDocumentRoot, getFingerprint, getLineNumber, getLocalPart, getNameCode, getNodeKind, getParent, getPrefix, getRoot, getSiblingPosition, getStringValue, getStringValueCS, getSystemId, getTypeAnnotation, 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 javax.xml.transform.Source
isEmpty, setSystemId

- Field Detail
  - config
```
protected Configuration config
```
  - baseURI
```
protected java.lang.String baseURI
```
  - documentNumber
```
protected int 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 node
    
    baseURI - the base URI of the document
    
    config - 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
    
    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
  - getConfiguration
```
public Configuration getConfiguration()
```
    Get the configuration previously set using setConfiguration
    
    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
  - getDocumentNumber
```
public int 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(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
    
    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 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 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

Class DocumentWrapper

Field Summary

Fields inherited from interface net.sf.saxon.om.NodeInfo

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

Fields inherited from interface net.sf.saxon.om.ValueRepresentation

Constructor Summary

Method Summary

Methods inherited from interface net.sf.saxon.om.Item

Methods inherited from interface net.sf.saxon.om.NodeInfo

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

Methods inherited from class java.lang.Object

Methods inherited from interface javax.xml.transform.Source

Field Detail

config

baseURI

documentNumber

domLevel3

Constructor Detail

DocumentWrapper

Method Detail

wrap

setConfiguration

getConfiguration

getNamePool

getDocumentNumber

selectID

isSameNodeInfo

getUnparsedEntityNames

getUnparsedEntity