org.treetank.api

Interface INodeReadTrx

All Known Subinterfaces:

INodeWriteTrx

All Known Implementing Classes:

NodeReadTrx, NodeWriteTrx

public interface INodeReadTrx

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close shared read transaction and immediately release all resources.
INode	getNode() Getting the current node.
QName	getQNameOfCurrentNode() Getting the name of a current node.
String	getTypeOfCurrentNode() Getting the type of the current node.
String	getValueOfCurrentNode() Getting the value of the current node.
boolean	isClosed() Is this transaction closed?
boolean	moveTo(long pKey) Move cursor to a node by its node key.
boolean	moveToAttribute(int pIndex) Move cursor to attribute by its index.
boolean	moveToNamespace(int pIndex) Move cursor to namespace declaration by its index.
String	nameForKey(int pKey) Get name for key.

Method Detail

moveTo

boolean moveTo(long pKey)
               throws TTIOException

Move cursor to a node by its node key.

Parameters:

pKey - Key of node to select.

Returns:

True if the node with the given node key is selected.

Throws:

TTIOException - if retrieval fails (including non-existing of node)

moveToAttribute

boolean moveToAttribute(int pIndex)
                        throws TTIOException

Move cursor to attribute by its index.

Parameters:

pIndex - Index of attribute to move to.

Returns:

True if the attribute node is selected.

Throws:

TTIOException - if retrieval fails (including non-existing of node)

moveToNamespace

boolean moveToNamespace(int pIndex)
                        throws TTIOException

Move cursor to namespace declaration by its index.

Parameters:

pIndex - Index of attribute to move to.

Returns:

True if the namespace node is selected.

Throws:

TTIOException - if retrieval fails (including non-existing of node)

getValueOfCurrentNode

String getValueOfCurrentNode()

Getting the value of the current node.

Returns:

the current value of the node

getQNameOfCurrentNode

QName getQNameOfCurrentNode()

Getting the name of a current node.

Returns:

the QName of the node

getTypeOfCurrentNode

String getTypeOfCurrentNode()

Getting the type of the current node.

Returns:

the normal type of the node

nameForKey

String nameForKey(int pKey)

Get name for key. This is used for efficient key testing.

Parameters:

pKey - Key, i.e., local part key, URI key, or prefix key.

Returns:

String containing name for given key.

getNode

INode getNode()

Getting the current node.

Returns:

the node

close

void close()
           throws TTException

Close shared read transaction and immediately release all resources. This is an idempotent operation and does nothing if the transaction is already closed.

Throws:

TTException - If can't close Read Transaction.

isClosed

boolean isClosed()

Is this transaction closed?

Returns:

true if closed, false otherwise