org.treetank.access

Class NodeReadTrx

java.lang.Object

org.treetank.access.NodeReadTrx

All Implemented Interfaces:

INodeReadTrx

public class NodeReadTrx
extends Object
implements INodeReadTrx

NodeReadTrx

Read-only transaction with single-threaded cursor semantics. Each read-only transaction works on a given revision key.

Field Summary

Fields

Modifier and Type	Field and Description
protected IBucketReadTrx	mPageReadTrx State of transaction including all cached stuff.

Constructor Summary

Constructors

Constructor and Description
NodeReadTrx(IBucketReadTrx pPageTrx) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static QName	buildQName(String paramUri, String paramName) Building QName out of uri and name.
void	close() Close shared read transaction and immediately release all resources.
protected INode	getCurrentNode() Getter for superclasses.
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 the transaction closed?
boolean	moveTo(long pNodeKey) Move cursor to a node by its node key.
boolean	moveToAttribute(int mIndex) Move cursor to attribute by its index.
boolean	moveToNamespace(int mIndex) Move cursor to namespace declaration by its index.
String	nameForKey(int mKey) Get name for key.
protected void	setCurrentNode(INode paramCurrentNode) Setter for superclasses.
protected void	setPageTransaction(IBucketReadTrx pPageTrx) Replace the state of the transaction.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

mPageReadTrx

protected IBucketReadTrx mPageReadTrx

State of transaction including all cached stuff.

Constructor Detail

NodeReadTrx

public NodeReadTrx(IBucketReadTrx pPageTrx)
            throws TTException

Constructor.

Parameters:

pPageTrx - Transaction state to work with.

Throws:

TTIOException - if something odd happens within the creation process.

TTException

Method Detail

moveTo

public final boolean moveTo(long pNodeKey)
                     throws TTIOException

Move cursor to a node by its node key.

Specified by:

moveTo in interface INodeReadTrx

Parameters:

pNodeKey - Key of node to select.

Returns:

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

Throws:

TTIOException

moveToAttribute

public final boolean moveToAttribute(int mIndex)
                              throws TTIOException

Move cursor to attribute by its index.

Specified by:

moveToAttribute in interface INodeReadTrx

Parameters:

mIndex - 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

public final boolean moveToNamespace(int mIndex)
                              throws TTIOException

Move cursor to namespace declaration by its index.

Specified by:

moveToNamespace in interface INodeReadTrx

Parameters:

mIndex - 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

public final String getValueOfCurrentNode()

Getting the value of the current node.

Specified by:

getValueOfCurrentNode in interface INodeReadTrx

Returns:

the current value of the node

getQNameOfCurrentNode

public final QName getQNameOfCurrentNode()

Getting the name of a current node.

Specified by:

getQNameOfCurrentNode in interface INodeReadTrx

Returns:

the QName of the node

getTypeOfCurrentNode

public final String getTypeOfCurrentNode()

Getting the type of the current node.

Specified by:

getTypeOfCurrentNode in interface INodeReadTrx

Returns:

the normal type of the node

nameForKey

public final String nameForKey(int mKey)

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

Specified by:

nameForKey in interface INodeReadTrx

Parameters:

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

Returns:

String containing name for given key.

close

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

Specified by:

close in interface INodeReadTrx

Throws:

TTException - If can't close Read Transaction.

toString

public String toString()

Overrides:

toString in class Object

isClosed

public final boolean isClosed()

Is the transaction closed?

Specified by:

isClosed in interface INodeReadTrx

Returns:

True if the transaction was closed.

setPageTransaction

protected final void setPageTransaction(IBucketReadTrx pPageTrx)

Replace the state of the transaction.

Parameters:

pPageTrx - Page Read Trx

getCurrentNode

protected final INode getCurrentNode()

Getter for superclasses.

Returns:

The current node.

setCurrentNode

protected final void setCurrentNode(INode paramCurrentNode)

Setter for superclasses.

Parameters:

paramCurrentNode - The current node to set.

getNode

public final INode getNode()

Getting the current node.

Specified by:

getNode in interface INodeReadTrx

Returns:

the node

buildQName

public static final QName buildQName(String paramUri,
               String paramName)

Building QName out of uri and name. The name can have the prefix denoted with ":";

Parameters:

paramUri - the namespaceuri

paramName - the name including a possible prefix

Returns:

the QName obj