org.treetank.access

Class NodeWriteTrx

java.lang.Object

org.treetank.access.NodeWriteTrx

All Implemented Interfaces:

INodeReadTrx, INodeWriteTrx

public class NodeWriteTrx
extends Object
implements INodeWriteTrx

NodeWriteTrx

Single-threaded instance of only write transaction per session.

All methods throw NullPointerExceptions in case of null values for reference parameters.

Author:

Sebastian Graf, University of Konstanz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NodeWriteTrx.HashKind How is the Hash for this storage computed?

Constructor Summary

Constructors

Constructor and Description
NodeWriteTrx(ISession pSession, IBucketWriteTrx pPageWriteTrx, NodeWriteTrx.HashKind kind) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	abort() Abort all modifications of the exclusive write transaction.
static String	buildName(QName pQName) Building name consisting out of prefix and name.
void	close() Closing current NodeWriteTrx.
void	commit() ICommitStrategy all modifications of the exclusive write transaction.
INode	getNode() Getting the current node.
IBucketWriteTrx	getPageWtx() Getting the Page Transaction
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.
long	insertAttribute(QName pQName, String pValue) Insert attribute in currently selected node.
long	insertElementAsFirstChild(QName pQName) Insert new element node as first child of currently selected node.
long	insertElementAsRightSibling(QName pQName) Insert new element node as right sibling of currently selected node.
long	insertNamespace(QName pQName) Insert namespace declaration in currently selected node.
long	insertTextAsFirstChild(String pValue) Insert new text node as first child of currently selected node.
long	insertTextAsRightSibling(String pValue) Insert new text node as right sibling of currently selected 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.
void	remove() Remove currently selected node.
void	revertTo(long pRevision) Reverting all changes to the revision defined.
void	setQName(QName paramName) Set QName of node.
void	setURI(String paramUri) Set URI of node.
void	setValue(String pValue) Set value of node.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeWriteTrx

public NodeWriteTrx(ISession pSession,
            IBucketWriteTrx pPageWriteTrx,
            NodeWriteTrx.HashKind kind)
             throws TTException

Constructor.

Parameters:

pSession - state of the session

pPageWriteTrx - state of this transaction

Throws:

TTIOException - if the reading of the props is failing

TTUsageException - if paramMaxNodeCount < 0 or paramMaxTime < 0

TTException

Method Detail

insertElementAsFirstChild

public long insertElementAsFirstChild(QName pQName)
                               throws TTException,
                                      NullPointerException

Insert new element node as first child of currently selected node. The cursor is moved to the inserted node.

Specified by:

insertElementAsFirstChild in interface INodeWriteTrx

Parameters:

pQName - QName of node to insert

Returns:

key of inserted node

Throws:

TTException - if element node couldn't be inserted as first child

NullPointerException

insertElementAsRightSibling

public long insertElementAsRightSibling(QName pQName)
                                 throws TTException

Insert new element node as right sibling of currently selected node. The cursor is moved to the inserted node.

Specified by:

insertElementAsRightSibling in interface INodeWriteTrx

Parameters:

pQName - QName of the new node

Returns:

Key of inserted node. Already has a first child.

Throws:

TTException - if element node couldn't be inserted as right sibling

insertTextAsFirstChild

public long insertTextAsFirstChild(String pValue)
                            throws TTException

Insert new text node as first child of currently selected node. The cursor is moved to the inserted node.

Specified by:

insertTextAsFirstChild in interface INodeWriteTrx

Parameters:

pValue - value of node to insert

Returns:

Key of inserted node. Already has a first child.

Throws:

TTException - if text node couldn't be inserted as first child.

insertTextAsRightSibling

public long insertTextAsRightSibling(String pValue)
                              throws TTException

Insert new text node as right sibling of currently selected node. The cursor is moved to the inserted node.

Specified by:

insertTextAsRightSibling in interface INodeWriteTrx

Parameters:

pValue - value of node to insert

Returns:

Key of inserted node. the root node which is not allowed to have right siblings.

Throws:

TTException - if text node couldn't be inserted as right sibling

insertAttribute

public long insertAttribute(QName pQName,
                   String pValue)
                     throws TTException

Insert attribute in currently selected node. The cursor is moved to the inserted node.

Specified by:

insertAttribute in interface INodeWriteTrx

Parameters:

pQName - QName reference

pValue - value of inserted node

Returns:

key of inserted node

Throws:

TTException - if attribute couldn't be inserted.

insertNamespace

public long insertNamespace(QName pQName)
                     throws TTException

Insert namespace declaration in currently selected node. The cursor is moved to the inserted node.

Specified by:

insertNamespace in interface INodeWriteTrx

Parameters:

pQName - QName reference

Returns:

key of inserted node

Throws:

TTException - if attribute couldn't be inserted.

remove

public void remove()
            throws TTException

Remove currently selected node. This does automatically remove descendants. The cursor is located at the former right sibling. If there was no right sibling, it is located at the former left sibling. If there was no left sibling, it is located at the former parent.

Specified by:

remove in interface INodeWriteTrx

Throws:

TTException - if node couldn't be removed

setQName

public void setQName(QName paramName)
              throws TTException

Set QName of node.

Specified by:

setQName in interface INodeWriteTrx

Parameters:

paramName - New qualified name of node.

Throws:

TTIOException - If can't set Name in node.

TTException

setURI

public void setURI(String paramUri)
            throws TTException

Set URI of node.

Specified by:

setURI in interface INodeWriteTrx

Parameters:

paramUri - new URI of node

Throws:

TTIOException - if URI of node couldn't be set

TTException

setValue

public void setValue(String pValue)
              throws TTException

Set value of node.

Specified by:

setValue in interface INodeWriteTrx

Parameters:

pValue - new value of node

Throws:

TTIOException - if value couldn't be set

TTException

revertTo

public void revertTo(long pRevision)
              throws TTException

Reverting all changes to the revision defined. This command has to be finalized with a commit.

Specified by:

revertTo in interface INodeWriteTrx

Parameters:

pRevision - revert to the revision

Throws:

TTUsageException - if paramRevision < 0 or paramRevision > maxCommitedRev

TTIOException - if an I/O operation fails

TTException - if couldn't revert to revision

commit

public void commit()
            throws TTException

ICommitStrategy all modifications of the exclusive write transaction. Even commit if there are no modification at all.

Specified by:

commit in interface INodeWriteTrx

Throws:

TTException - if this revision couldn't be commited

abort

public void abort()
           throws TTException

Abort all modifications of the exclusive write transaction.

Specified by:

abort in interface INodeWriteTrx

Throws:

TTIOException - if this revision couldn't be aborted

TTException

close

public void close()
           throws TTException

Closing current NodeWriteTrx.

Specified by:

close in interface INodeReadTrx

Specified by:

close in interface INodeWriteTrx

Throws:

TTException - if write transaction couldn't be closed

moveTo

public boolean moveTo(long pKey)
               throws TTIOException

Move cursor to a node by its node key.

Specified by:

moveTo in interface INodeReadTrx

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

public boolean moveToAttribute(int pIndex)
                        throws TTIOException

Move cursor to attribute by its index.

Specified by:

moveToAttribute in interface INodeReadTrx

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

public boolean moveToNamespace(int pIndex)
                        throws TTIOException

Move cursor to namespace declaration by its index.

Specified by:

moveToNamespace in interface INodeReadTrx

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

public String getValueOfCurrentNode()

Getting the value of the current node.

Specified by:

getValueOfCurrentNode in interface INodeReadTrx

Returns:

the current value of the node

getQNameOfCurrentNode

public QName getQNameOfCurrentNode()

Getting the name of a current node.

Specified by:

getQNameOfCurrentNode in interface INodeReadTrx

Returns:

the QName of the node

getTypeOfCurrentNode

public String getTypeOfCurrentNode()

Getting the type of the current node.

Specified by:

getTypeOfCurrentNode in interface INodeReadTrx

Returns:

the normal type of the node

nameForKey

public String nameForKey(int pKey)

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

Specified by:

nameForKey in interface INodeReadTrx

Parameters:

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

Returns:

String containing name for given key.

getNode

public INode getNode()

Getting the current node.

Specified by:

getNode in interface INodeReadTrx

Returns:

the node

isClosed

public boolean isClosed()

Is this transaction closed?

Specified by:

isClosed in interface INodeReadTrx

Returns:

true if closed, false otherwise

getPageWtx

public IBucketWriteTrx getPageWtx()
                           throws TTException

Getting the Page Transaction

Specified by:

getPageWtx in interface INodeWriteTrx

Returns:

the stored IBucketWriteTrx.

Throws:

TTException

buildName

public static String buildName(QName pQName)

Building name consisting out of prefix and name. NamespaceUri is not used over here.

Parameters:

pQName - the QName of an element

Returns:

a string with [prefix:]localname

toString

public String toString()

Overrides:

toString in class Object