net.sf.saxon.option.jdom

Class DocumentWrapper

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 StringbaseURI
protected Configurationconfig
protected longdocumentNumber
Constructor Summary
DocumentWrapper(Document doc, String baseURI, Configuration config)
Create a Saxon wrapper for a JDOM document
Method Summary
ConfigurationgetConfiguration()
Get the configuration previously set using setConfiguration (or the default configuraton allocated automatically)
longgetDocumentNumber()
Get the unique document number
NamePoolgetNamePool()
Get the name pool used for the names in this document
intgetTypeAnnotation()
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
NodeInfoselectID(String id, boolean getParent)
Get the element with a given ID, if any
voidsetConfiguration(Configuration config)
Set the configuration (containing the name pool used for all names in this document)
NodeWrapperwrap(Object node)
Wrap a node in the JDOM document.

Field Detail

baseURI

protected String baseURI

config

protected Configuration config

documentNumber

protected long documentNumber

Constructor Detail

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 config The Saxon Configuration

Method Detail

getConfiguration

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

getDocumentNumber

public long getDocumentNumber()
Get the unique document number

getNamePool

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

getTypeAnnotation

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

getUnparsedEntity

public String[] getUnparsedEntity(String name)
Get the unparsed entity with a given name

Parameters: name the name of the entity

Returns: null: JDOM does not provide access to unparsed entities

getUnparsedEntityNames

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

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

selectID

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

Parameters: id the required ID value getParent

Returns: the element node with the given ID if there is one, otherwise null.

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