org.treetank.saxon.wrapper

Class DocumentWrapper

java.lang.Object

org.treetank.saxon.wrapper.DocumentWrapper

All Implemented Interfaces:

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.NodeInfo, net.sf.saxon.om.ValueRepresentation<net.sf.saxon.om.NodeInfo>

public final class DocumentWrapper
extends Object
implements net.sf.saxon.om.DocumentInfo

DocumentWrapper

Wraps a Treetank document and represents a document treeData. Therefore it implements Saxon's DocumentInfo core interface and also represents a Node in Saxon's internal treeData implementation. Thus it extends NodeWrapper.

Author:

Johannes Lichtenberger, University of Konstanz, Sebastian Graf, University of Konstanz

Field Summary

Fields

Modifier and Type	Field and Description
protected long	documentNumber Unique document number.
protected static org.slf4j.Logger	LOGGER Log wrapper for better output.
protected String	mBaseURI Base URI of the document.
protected net.sf.saxon.Configuration	mConfig Saxon configuration.
protected ISession	mSession Treetank database.

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

ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES

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

EMPTY_VALUE_ARRAY

Constructor Summary

Constructors

Constructor and Description
DocumentWrapper(ISession pSession, net.sf.saxon.Configuration pConfig) Wrap a Treetank document.

Method Summary

Methods

Modifier and Type	Method and Description
net.sf.saxon.value.Value	atomize()
int	compareOrder(net.sf.saxon.om.NodeInfo arg0)
void	copy(net.sf.saxon.event.Receiver arg0, int arg1, int arg2)
void	generateId(net.sf.saxon.tree.util.FastStringBuffer arg0)
String	getAttributeValue(int arg0)
String	getAttributeValue(String arg0, String arg1)
String	getBaseURI()
int	getColumnNumber()
net.sf.saxon.Configuration	getConfiguration()
net.sf.saxon.om.NamespaceBinding[]	getDeclaredNamespaces(net.sf.saxon.om.NamespaceBinding[] arg0)
String	getDisplayName()
long	getDocumentNumber()
net.sf.saxon.om.DocumentInfo	getDocumentRoot()
int	getFingerprint()
int	getLineNumber()
String	getLocalPart()
int	getNameCode()
net.sf.saxon.om.NamePool	getNamePool()
int	getNodeKind()
NodeWrapper	getNodeWrapper()
net.sf.saxon.om.NodeInfo	getParent()
String	getPrefix()
net.sf.saxon.om.NodeInfo	getRoot()
net.sf.saxon.type.SchemaType	getSchemaType()
String	getStringValue()
CharSequence	getStringValueCS()
String	getSystemId()
int	getTypeAnnotation()
net.sf.saxon.om.SequenceIterator	getTypedValue()
String[]	getUnparsedEntity(String name)
Iterator<String>	getUnparsedEntityNames() Get the unparsed entity with a given name.
String	getURI()
Object	getUserData(String arg0)
boolean	hasChildNodes()
boolean	isId()
boolean	isIdref()
boolean	isNilled()
boolean	isSameNodeInfo(net.sf.saxon.om.NodeInfo arg0)
boolean	isTyped()
net.sf.saxon.tree.iter.AxisIterator	iterateAxis(byte arg0)
net.sf.saxon.tree.iter.AxisIterator	iterateAxis(byte arg0, net.sf.saxon.pattern.NodeTest arg1)
net.sf.saxon.om.NodeInfo	selectID(String ID, boolean getParent)
protected void	setBaseURI(String baseURI) Set the baseURI of the current document.
void	setConfiguration(net.sf.saxon.Configuration config) Set the configuration (containing the name pool used for all names in this document).
void	setSystemId(String arg0)
void	setUserData(String arg0, Object arg1)

Methods inherited from class java.lang.Object

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

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

equals, hashCode

Field Detail

LOGGER

protected static final org.slf4j.Logger LOGGER

Log wrapper for better output.

mSession

protected final transient ISession mSession

Treetank database.

mBaseURI

protected transient String mBaseURI

Base URI of the document.

mConfig

protected transient net.sf.saxon.Configuration mConfig

Saxon configuration.

documentNumber

protected transient long documentNumber

Unique document number.

Constructor Detail

DocumentWrapper

public DocumentWrapper(ISession pSession,
               net.sf.saxon.Configuration pConfig)
                throws org.treetank.exception.TTException

Wrap a Treetank document.

Parameters:

pSession - Treetank database.

pConfig - Configuration used.

Throws:

org.treetank.exception.TTException

Method Detail

getUnparsedEntity

public String[] getUnparsedEntity(String name)

Specified by:

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

getUnparsedEntityNames

public Iterator<String> getUnparsedEntityNames()

Get the unparsed entity with a given name.

Specified by:

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

Returns:

null: TreeTank does not provide access to unparsed entities.

selectID

public net.sf.saxon.om.NodeInfo selectID(String ID,
                                boolean getParent)

Specified by:

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

getNamePool

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

Specified by:

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

setConfiguration

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

Set the configuration (containing the name pool used for all names in this document). Calling this method allocates a unique number to the document (unique within the Configuration); this will form the basis for testing treeData identity.

Parameters:

config - The configuration.

getConfiguration

public net.sf.saxon.Configuration getConfiguration()

Specified by:

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

getBaseURI

public String getBaseURI()

Specified by:

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

setBaseURI

protected void setBaseURI(String baseURI)

Set the baseURI of the current document.

Parameters:

baseURI - Usually the absoulte path of the document.

getUserData

public Object getUserData(String arg0)

Specified by:

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

setUserData

public void setUserData(String arg0,
               Object arg1)

Specified by:

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

atomize

public net.sf.saxon.value.Value atomize()
                                 throws net.sf.saxon.trans.XPathException

Specified by:

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

Throws:

net.sf.saxon.trans.XPathException

compareOrder

public int compareOrder(net.sf.saxon.om.NodeInfo arg0)

Specified by:

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

copy

public void copy(net.sf.saxon.event.Receiver arg0,
        int arg1,
        int arg2)
          throws net.sf.saxon.trans.XPathException

Specified by:

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

Throws:

net.sf.saxon.trans.XPathException

generateId

public void generateId(net.sf.saxon.tree.util.FastStringBuffer arg0)

Specified by:

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

getAttributeValue

public String getAttributeValue(int arg0)

Specified by:

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

getColumnNumber

public int getColumnNumber()

Specified by:

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

getDisplayName

public String getDisplayName()

Specified by:

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

getDocumentNumber

public long getDocumentNumber()

Specified by:

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

getDocumentRoot

public net.sf.saxon.om.DocumentInfo getDocumentRoot()

Specified by:

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

getFingerprint

public int getFingerprint()

Specified by:

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

getLineNumber

public int getLineNumber()

Specified by:

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

getLocalPart

public String getLocalPart()

Specified by:

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

getNameCode

public int getNameCode()

Specified by:

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

getNodeKind

public int getNodeKind()

Specified by:

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

getParent

public net.sf.saxon.om.NodeInfo getParent()

Specified by:

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

getPrefix

public String getPrefix()

Specified by:

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

getRoot

public net.sf.saxon.om.NodeInfo getRoot()

Specified by:

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

getStringValue

public String getStringValue()

Specified by:

getStringValue in interface net.sf.saxon.om.Item<net.sf.saxon.om.NodeInfo>

Specified by:

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

Specified by:

getStringValue in interface net.sf.saxon.om.ValueRepresentation<net.sf.saxon.om.NodeInfo>

getSystemId

public String getSystemId()

Specified by:

getSystemId in interface Source

Specified by:

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

getTypeAnnotation

public int getTypeAnnotation()

Specified by:

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

getURI

public String getURI()

Specified by:

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

hasChildNodes

public boolean hasChildNodes()

Specified by:

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

isId

public boolean isId()

Specified by:

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

isIdref

public boolean isIdref()

Specified by:

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

isNilled

public boolean isNilled()

Specified by:

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

isSameNodeInfo

public boolean isSameNodeInfo(net.sf.saxon.om.NodeInfo arg0)

Specified by:

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

iterateAxis

public net.sf.saxon.tree.iter.AxisIterator iterateAxis(byte arg0)

Specified by:

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

iterateAxis

public net.sf.saxon.tree.iter.AxisIterator iterateAxis(byte arg0,
                                              net.sf.saxon.pattern.NodeTest arg1)

Specified by:

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

setSystemId

public void setSystemId(String arg0)

Specified by:

setSystemId in interface Source

getStringValueCS

public CharSequence getStringValueCS()

Specified by:

getStringValueCS in interface net.sf.saxon.om.Item<net.sf.saxon.om.NodeInfo>

Specified by:

getStringValueCS in interface net.sf.saxon.om.ValueRepresentation<net.sf.saxon.om.NodeInfo>

getTypedValue

public net.sf.saxon.om.SequenceIterator getTypedValue()
                                               throws net.sf.saxon.trans.XPathException

Specified by:

getTypedValue in interface net.sf.saxon.om.Item<net.sf.saxon.om.NodeInfo>

Throws:

net.sf.saxon.trans.XPathException

getNodeWrapper

public NodeWrapper getNodeWrapper()

getAttributeValue

public String getAttributeValue(String arg0,
                       String arg1)

Specified by:

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

getDeclaredNamespaces

public net.sf.saxon.om.NamespaceBinding[] getDeclaredNamespaces(net.sf.saxon.om.NamespaceBinding[] arg0)

Specified by:

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

getSchemaType

public net.sf.saxon.type.SchemaType getSchemaType()

Specified by:

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

isTyped

public boolean isTyped()

Specified by:

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