org.teiid.query.xquery.saxon
Class DocumentWrapper

java.lang.Object
  org.teiid.query.xquery.saxon.NodeWrapper
      org.teiid.query.xquery.saxon.DocumentWrapper

All Implemented Interfaces:

javax.xml.transform.Source, net.sf.saxon.evpull.PullEvent, net.sf.saxon.om.DocumentInfo, net.sf.saxon.om.Item, net.sf.saxon.om.NodeInfo, net.sf.saxon.om.SiblingCountingNode, net.sf.saxon.om.ValueRepresentation, net.sf.saxon.om.VirtualNode

public class DocumentWrapper
extends NodeWrapper
implements net.sf.saxon.om.DocumentInfo

The root node of an XPath tree. (Or equivalently, the tree itself).

This class is used not only for a document, but also for the root of a document-less tree fragment.

Author:

Michael H. Kay, Wolfgang Hoschek (ported net.sf.saxon.jdom to XOM), Steve Hawkins (Ported to Saxon 9.1 for Teiid)

Field Summary

protected java.lang.String	baseURI
protected net.sf.saxon.Configuration	config
protected int	documentNumber

Fields inherited from class org.teiid.query.xquery.saxon.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(nu.xom.Node root, java.lang.String baseURI, net.sf.saxon.Configuration config)
Create a Saxon wrapper for a XOM root node

Method Summary

int	getColumnNumber()
net.sf.saxon.Configuration	getConfiguration() Get the configuration previously set using setConfiguration
long	getDocumentNumber() Get the unique document number for this document (the number is unique for all documents within a NamePool)
net.sf.saxon.om.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()
boolean	isId()
boolean	isIdref()
boolean	isNilled()
net.sf.saxon.om.NodeInfo	selectID(java.lang.String id, boolean getParent) Get the element with a given ID, if any
void	setConfiguration(net.sf.saxon.Configuration config) Set the configuration, which defines the name pool used for all names in this document.
net.sf.saxon.om.NodeInfo	wrap(nu.xom.Node node) Wrap a node in the XOM document.

Methods inherited from class org.teiid.query.xquery.saxon.NodeWrapper

atomize, compareOrder, copy, equals, generateId, getAttributeValue, getBaseURI, getDeclaredNamespaces, getDisplayName, getDocumentRoot, getFingerprint, getLineNumber, getLocalPart, getNameCode, getNodeKind, getParent, getPrefix, getRealNode, getRoot, getSiblingPosition, getStringValue, getStringValueCS, getSystemId, getTypeAnnotation, getTypedValue, getUnderlyingNode, getURI, hasChildNodes, hashCode, isSameNodeInfo, 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 net.sf.saxon.om.NodeInfo

atomize, compareOrder, copy, equals, generateId, getAttributeValue, getBaseURI, getDeclaredNamespaces, getDisplayName, getDocumentRoot, getFingerprint, getLineNumber, getLocalPart, getNameCode, getNodeKind, getParent, getPrefix, getRoot, getStringValue, getSystemId, getTypeAnnotation, getURI, hasChildNodes, hashCode, 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 net.sf.saxon.Configuration config

baseURI

protected java.lang.String baseURI

documentNumber

protected int documentNumber

Constructor Detail

DocumentWrapper

public DocumentWrapper(nu.xom.Node root,
                       java.lang.String baseURI,
                       net.sf.saxon.Configuration config)

Create a Saxon wrapper for a XOM root node

Parameters:

root - The XOM root node

baseURI - The base URI for all the nodes in the tree

config - The configuration which defines the name pool used for all names in this tree

Method Detail

wrap

public net.sf.saxon.om.NodeInfo wrap(nu.xom.Node node)

Wrap a node in the XOM 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

setConfiguration

public void setConfiguration(net.sf.saxon.Configuration config)

Set the configuration, which defines the name pool used for all names in this document. This is always called after a new document has been created. The implementation must register the name pool with the document, so that it can be retrieved using getNamePool(). It must also call NamePool.allocateDocumentNumber(), and return the relevant document number when getDocumentNumber() is subsequently called.

Parameters:

config - The configuration to be used

getConfiguration

public net.sf.saxon.Configuration getConfiguration()

Get the configuration previously set using setConfiguration

Specified by:

getConfiguration in interface net.sf.saxon.om.NodeInfo

Overrides:

getConfiguration in class NodeWrapper

getNamePool

public net.sf.saxon.om.NamePool getNamePool()

Get the name pool used for the names in this document

Specified by:

getNamePool in interface net.sf.saxon.om.NodeInfo

Overrides:

getNamePool in class NodeWrapper

Returns:

the name pool in which all the names used in this document are registered

getDocumentNumber

public long getDocumentNumber()

Get the unique document number for this document (the number is unique for all documents within a NamePool)

Specified by:

getDocumentNumber in interface net.sf.saxon.om.NodeInfo

Overrides:

getDocumentNumber in class NodeWrapper

Returns:

the unique number identifying this document within the name pool

selectID

public net.sf.saxon.om.NodeInfo selectID(java.lang.String id,
                                         boolean getParent)

Get the element with a given ID, if any

Specified by:

selectID in interface net.sf.saxon.om.DocumentInfo

Parameters:

id - the required ID value

getParent - true if running the element-with-id() function rather than the id() function; the difference is that in the case of an element of type xs:ID, the parent of the element should be returned, not the element itself.

Returns:

the element with the given ID, or null if there is no such ID present (or if the parser has not notified attributes as being of type ID).

getUnparsedEntity

public java.lang.String[] getUnparsedEntity(java.lang.String name)

Get the unparsed entity with a given name

Specified by:

getUnparsedEntity in interface net.sf.saxon.om.DocumentInfo

Parameters:

name - the name of the entity

Returns:

null: XOM does not provide access to unparsed entities

getUnparsedEntityNames

public java.util.Iterator getUnparsedEntityNames()

Specified by:

getUnparsedEntityNames in interface net.sf.saxon.om.DocumentInfo

getColumnNumber

public int getColumnNumber()

Specified by:

getColumnNumber in interface net.sf.saxon.om.NodeInfo

Overrides:

getColumnNumber in class NodeWrapper

isId

public boolean isId()

Specified by:

isId in interface net.sf.saxon.om.NodeInfo

Overrides:

isId in class NodeWrapper

isIdref

public boolean isIdref()

Specified by:

isIdref in interface net.sf.saxon.om.NodeInfo

Overrides:

isIdref in class NodeWrapper

isNilled

public boolean isNilled()

Specified by:

isNilled in interface net.sf.saxon.om.NodeInfo

Overrides:

isNilled in class NodeWrapper