org.treetank.api

Interface INodeWriteTrx

All Superinterfaces:

INodeReadTrx

All Known Implementing Classes:

NodeWriteTrx

public interface INodeWriteTrx
extends INodeReadTrx

INodeWriteTrx

Description

Interface to access nodes based on the Key/ParentKey/FirstChildKey/LeftSiblingKey/RightSiblingKey/ChildCount encoding. This encoding keeps the children ordered but has no knowledge of the global node ordering. The underlying tree is accessed in a cursor-like fashion.

Method Summary

Methods

Modifier and Type	Method and Description
void	abort() Abort all modifications of the exclusive write transaction.
void	close() Closing current NodeWriteTrx.
void	commit() ICommitStrategy all modifications of the exclusive write transaction.
IBucketWriteTrx	getPageWtx() Getting the Page Transaction
long	insertAttribute(QName pName, String pValue) Insert attribute in currently selected node.
long	insertElementAsFirstChild(QName pName) Insert new element node as first child of currently selected node.
long	insertElementAsRightSibling(QName pFromKey) Insert new element node as right sibling of currently selected node.
long	insertNamespace(QName pName) 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.
void	remove() Remove currently selected node.
void	revertTo(long pRev) Reverting all changes to the revision defined.
void	setQName(QName pName) Set QName of node.
void	setURI(String pUri) Set URI of node.
void	setValue(String pValue) Set value of node.

Methods inherited from interface org.treetank.api.INodeReadTrx

getNode, getQNameOfCurrentNode, getTypeOfCurrentNode, getValueOfCurrentNode, isClosed, moveTo, moveToAttribute, moveToNamespace, nameForKey

Method Detail

insertElementAsFirstChild

long insertElementAsFirstChild(QName pName)
                               throws TTException

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

Parameters:

pName - QName of node to insert

Returns:

key of inserted node

Throws:

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

insertTextAsFirstChild

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.

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.

insertElementAsRightSibling

long insertElementAsRightSibling(QName pFromKey)
                                 throws TTException

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

Parameters:

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

insertTextAsRightSibling

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.

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

long insertAttribute(QName pName,
                   String pValue)
                     throws TTException

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

Parameters:

pName - QName reference

pValue - value of inserted node

Returns:

key of inserted node

Throws:

TTException - if attribute couldn't be inserted.

insertNamespace

long insertNamespace(QName pName)
                     throws TTException

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

Parameters:

pName - QName reference

Returns:

key of inserted node

Throws:

TTException - if attribute couldn't be inserted.

remove

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.

Throws:

TTException - if node couldn't be removed

setQName

void setQName(QName pName)
              throws TTException

Set QName of node.

Parameters:

pName - New qualified name of node.

Throws:

TTIOException - If can't set Name in node.

TTException

setURI

void setURI(String pUri)
            throws TTException

Set URI of node.

Parameters:

pUri - new URI of node

Throws:

TTIOException - if URI of node couldn't be set

TTException

setValue

void setValue(String pValue)
              throws TTException

Set value of node.

Parameters:

pValue - new value of node

Throws:

TTIOException - if value couldn't be set

TTException

commit

void commit()
            throws TTException

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

Throws:

TTException - if this revision couldn't be commited

abort

void abort()
           throws TTException

Abort all modifications of the exclusive write transaction.

Throws:

TTIOException - if this revision couldn't be aborted

TTException

revertTo

void revertTo(long pRev)
              throws TTException

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

Parameters:

pRev - revert to the revision

Throws:

TTException - if couldn't revert to revision

close

void close()
           throws TTException

Closing current NodeWriteTrx.

Specified by:

close in interface INodeReadTrx

Throws:

TTException - if write transaction couldn't be closed

getPageWtx

IBucketWriteTrx getPageWtx()
                           throws TTException

Getting the Page Transaction

Returns:

the stored IBucketWriteTrx.

Throws:

TTException