net.sf.saxon.jdom

Class DocumentWrapper

Implemented Interfaces:
DocumentInfo, Item, NodeInfo, Source, Item, NodeInfo, PullEvent, SiblingCountingNode, ValueRepresentation, VirtualNode

public class DocumentWrapper
extends NodeWrapper
implements DocumentInfo

The root node of an XPath tree that wraps a JDOM document node.

Author:
Michael H. Kay

Field Summary

protected String
baseURI
protected Configuration
config
protected int
documentNumber

Fields inherited from class net.sf.saxon.jdom.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.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(Document doc, String baseURI, Configuration config)
Create a Saxon wrapper for a JDOM document

Method Summary

Configuration
getConfiguration()
Get the configuration previously set using setConfiguration (or the default configuraton allocated automatically)
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
NodeInfo
selectID(String id)
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)
NodeWrapper
wrap(Object node)
Wrap a node in the JDOM document.

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

atomize, compareOrder, copy, equals, generateId, getAttributeValue, getBaseURI, getConfiguration, getDeclaredNamespaces, getDisplayName, getDocumentNumber, getDocumentRoot, getFingerprint, getLineNumber, getLocalPart, getNameCode, getNamePool, getNodeKind, getParent, getPrefix, getRoot, getSiblingPosition, getStringValue, getStringValueCS, getSystemId, getTypeAnnotation, getTypedValue, getURI, getUnderlyingNode, hasChildNodes, hashCode, isSameNodeInfo, iterateAxis, iterateAxis, makeWrapper, makeWrapper, setSystemId

Field Details

baseURI

protected String baseURI

config

protected Configuration config

documentNumber

protected int documentNumber

Constructor Details

DocumentWrapper

public DocumentWrapper(Document doc,
                       String baseURI,
                       Configuration config)
Create a Saxon wrapper for a JDOM document
Parameters:
doc - The JDOM document
baseURI - The base URI for all the nodes in the document

Method Details

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 interface NodeWrapper

getDocumentNumber

public int getDocumentNumber()
Get the unique document number
Specified by:
getDocumentNumber in interface NodeInfo
Overrides:
getDocumentNumber in interface 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 interface NodeWrapper

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

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:
null: JDOM does not provide any information about attribute types.

setConfiguration

public void setConfiguration(Configuration config)
Set the configuration (containing the name pool used for all names in this document)

wrap

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