Class DocumentWrapper

java.lang.Object

com.icl.saxon.jdom.NodeWrapper

com.icl.saxon.jdom.DocumentWrapper

All Implemented Interfaces:

DocumentInfo, NodeInfo, Source

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

Nested Class Summary

Nested classes/interfaces inherited from class NodeWrapper

NodeWrapper.AncestorEnumeration

Field Summary

Fields

Modifier and Type	Field	Description
protected String	baseURI
protected Hashtable	keyTable
protected NamePool	namePool

Fields inherited from class NodeWrapper

docWrapper, index, node, nodeType, parent

Fields inherited from interface NodeInfo

ATTRIBUTE, COMMENT, ELEMENT, NAMESPACE, NODE, NONE, NUMBER_OF_TYPES, PI, ROOT, TEXT

Constructor Summary

Constructors

Constructor	Description
DocumentWrapper(org.jdom.Document doc, String baseURI)

Method Summary

Modifier and Type	Method	Description
Hashtable	getKeyIndex(KeyManager keyManager, int fingerprint)	Get the index for a given key
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	setKeyIndex(KeyManager keyManager, int fingerprint, Hashtable index)	Set the index for a given key
void	setNamePool(NamePool pool)	Set the name pool used for all names in this document

Methods inherited from class NodeWrapper

compareOrder, copy, copyStringValue, generateId, getAttributeValue, getAttributeValue, getBaseURI, getDisplayName, getDocumentRoot, getEnumeration, getFingerprint, getLineNumber, getLocalName, getNameCode, getNode, getNodeType, getParent, getPrefix, getStringValue, getSystemId, getURI, hasChildNodes, isSameNodeInfo, makeWrapper, outputNamespaceNodes, setSystemId

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface NodeInfo

compareOrder, copy, copyStringValue, generateId, getAttributeValue, getAttributeValue, getBaseURI, getDisplayName, getDocumentRoot, getEnumeration, getFingerprint, getLineNumber, getLocalName, getNameCode, getNodeType, getParent, getPrefix, getStringValue, getSystemId, getURI, hasChildNodes, isSameNodeInfo, outputNamespaceNodes

Methods inherited from interface Source

isEmpty, setSystemId

Field Details

keyTable

protected Hashtable keyTable

namePool

protected NamePool namePool

baseURI

protected String baseURI

Constructor Details

DocumentWrapper

public DocumentWrapper(org.jdom.Document doc,
 String baseURI)

Method Details

setNamePool

public void setNamePool(NamePool pool)

Set the name pool used for all names in this document

Specified by:

setNamePool in interface DocumentInfo

getNamePool

public NamePool getNamePool()

Get the name pool used for the names in this document

Specified by:

getNamePool in interface DocumentInfo

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.

getKeyIndex

public Hashtable getKeyIndex(KeyManager keyManager,
 int fingerprint)

Get the index for a given key

Specified by:

getKeyIndex in interface DocumentInfo

Parameters:

keyManager - The key manager managing this key

fingerprint - The fingerprint of the name of the key (unique with the key manager)

keymanager - The key manager managing this key

Returns:

The index, if one has been built, in the form of a Hashtable that maps the key value to a list of nodes having that key value. If no index has been built, returns null.

setKeyIndex

public void setKeyIndex(KeyManager keyManager,
 int fingerprint,
 Hashtable index)

Set the index for a given key

Specified by:

setKeyIndex in interface DocumentInfo

Parameters:

keyManager - The key manager managing this key

fingerprint - The fingerprint of the name of the key (unique with the key manager)

index - the index, in the form of a Hashtable that maps the key value to a list of nodes having that key value

keymanager - The key manager managing this key

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