org.treetank.saxon.wrapper

Class NodeWrapper

java.lang.Object

org.treetank.saxon.wrapper.NodeWrapper

All Implemented Interfaces:

Source, net.sf.saxon.evpull.PullEvent, 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>, net.sf.saxon.tree.wrapper.SiblingCountingNode, net.sf.saxon.tree.wrapper.VirtualNode

public class NodeWrapper
extends Object
implements net.sf.saxon.om.NodeInfo, net.sf.saxon.tree.wrapper.VirtualNode, net.sf.saxon.tree.wrapper.SiblingCountingNode

NodeWrapper

Wraps a Treetank treeData into Saxon's internal representation of a treeData. It therefore implements Saxon's core interface NodeInfo as well as two others:

NodeInfo

The NodeInfo interface represents a treeData in Saxon's implementation of the XPath 2.0 data model.

VirtualNode

This interface is implemented by NodeInfo implementations that act as wrappers on some underlying tree. It provides a method to access the real treeData underlying the virtual treeData, for use by applications that need to drill down to the underlying data.

SiblingCountingNode

Interface that extends NodeInfo by providing a method to get the position of a treeData relative to its siblings.

Author:

Johannes Lichtenberger, University of Konstanz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	NodeWrapper.SaxonEnumeration SaxonEnumeration

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	LOGGER Log wrapper for better output.
protected DocumentWrapper	mDocWrapper Document wrapper.
protected long	mKey Key of treeData.
protected int	nodeKind Kind of current treeData.
protected QName	qName QName of current treeData.
protected org.treetank.data.interfaces.ITreeData	treeData Treetank treeData.

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

ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NodeWrapper(DocumentWrapper pDocWrapper, long pNodekeyToStart) A treeData in the XML parse tree.

Method Summary

Methods

Modifier and Type	Method and Description
net.sf.saxon.value.Value	atomize()
int	compareOrder(net.sf.saxon.om.NodeInfo node)
void	copy(net.sf.saxon.event.Receiver out, int copyOption, int locationId) Copy this treeData to a given outputter (deep copy).
void	generateId(net.sf.saxon.tree.util.FastStringBuffer buf)
String	getAttributeValue(int fingerprint)
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()
net.sf.saxon.om.NodeInfo	getParent()
String	getPrefix()
Object	getRealNode()
net.sf.saxon.om.NodeInfo	getRoot()
net.sf.saxon.type.SchemaType	getSchemaType()
int	getSiblingPosition()
String	getStringValue() getStringValue() just calls getStringValueCS().
CharSequence	getStringValueCS()
String	getSystemId()
int	getTypeAnnotation() Get the type annotation.
net.sf.saxon.om.SequenceIterator	getTypedValue()
Object	getUnderlyingNode()
String	getURI()
boolean	hasChildNodes()
boolean	isId() Not supported.
boolean	isIdref()
boolean	isNilled()
boolean	isSameNodeInfo(net.sf.saxon.om.NodeInfo other)
net.sf.saxon.tree.iter.AxisIterator	iterateAxis(byte axisNumber)
net.sf.saxon.tree.iter.AxisIterator	iterateAxis(byte axisNumber, net.sf.saxon.pattern.NodeTest nodeTest)
void	setSystemId(String systemId)

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

nodeKind

protected final transient int nodeKind

Kind of current treeData.

mDocWrapper

protected transient DocumentWrapper mDocWrapper

Document wrapper.

LOGGER

protected static final org.slf4j.Logger LOGGER

Log wrapper for better output.

mKey

protected final transient long mKey

Key of treeData.

treeData

protected final transient org.treetank.data.interfaces.ITreeData treeData

Treetank treeData.

qName

protected final transient QName qName

QName of current treeData.

Constructor Detail

NodeWrapper

protected NodeWrapper(DocumentWrapper pDocWrapper,
           long pNodekeyToStart)
               throws org.treetank.exception.TTException

A treeData in the XML parse tree. Wrap a Treetank treeData.

Parameters:

pDocWrapper - Document wrapper

pNodekeyToStart - NodeKey to move to.

Throws:

org.treetank.exception.TTException

Method Detail

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 node)

Specified by:

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

copy

public void copy(net.sf.saxon.event.Receiver out,
        int copyOption,
        int locationId)
          throws net.sf.saxon.trans.XPathException

Copy this treeData to a given outputter (deep copy).

Specified by:

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

Throws:

net.sf.saxon.trans.XPathException

See Also:

NodeInfo.copy(Receiver, int, int)

generateId

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

Specified by:

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

getAttributeValue

public String getAttributeValue(int fingerprint)

Specified by:

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

getBaseURI

public String getBaseURI()

Specified by:

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

getColumnNumber

public int getColumnNumber()

Specified by:

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

getConfiguration

public net.sf.saxon.Configuration getConfiguration()

Specified by:

getConfiguration 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

getNamePool

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

Specified by:

getNamePool 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 final String getStringValue()

getStringValue() just calls getStringValueCS().

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>

getStringValueCS

public final 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>

getSystemId

public String getSystemId()

Specified by:

getSystemId in interface Source

Specified by:

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

getTypeAnnotation

public int getTypeAnnotation()

Get the type annotation.

Specified by:

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

Returns:

UNTYPED or UNTYPED_ATOMIC.

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()

Not supported.

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 other)

Specified by:

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

iterateAxis

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

Specified by:

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

iterateAxis

public net.sf.saxon.tree.iter.AxisIterator iterateAxis(byte axisNumber,
                                              net.sf.saxon.pattern.NodeTest nodeTest)

Specified by:

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

setSystemId

public void setSystemId(String systemId)

Specified by:

setSystemId in interface Source

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

getRealNode

public Object getRealNode()

Specified by:

getRealNode in interface net.sf.saxon.tree.wrapper.VirtualNode

getUnderlyingNode

public Object getUnderlyingNode()

Specified by:

getUnderlyingNode in interface net.sf.saxon.tree.wrapper.VirtualNode

getSiblingPosition

public int getSiblingPosition()

Specified by:

getSiblingPosition in interface net.sf.saxon.tree.wrapper.SiblingCountingNode

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