org.treetank.node

Class DocumentRootNode

java.lang.Object

org.treetank.node.DocumentRootNode

All Implemented Interfaces:

IData, INode, IStructNode

public final class DocumentRootNode
extends Object
implements INode, IStructNode

DocumentNode

Node representing the root of a document. This node is guaranteed to exist in revision 0 and can not be removed.

Constructor Summary

Constructors

Constructor and Description
DocumentRootNode(NodeDelegate pNodeDel, StructNodeDelegate pStrucDel) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	decrementChildCount() Decrementing the child count.
boolean	equals(Object pObj)
long	getChildCount() Gets the number of children of the item.
long	getDataKey() Gets unique IData key.
long	getFirstChildKey() Gets key of the context item's first child.
com.google.common.hash.Funnel<IData>	getFunnel() Getting a Funnel for computing guava-based hashes.
long	getHash() Getting the persisted hash value for this node.
int	getKind() Gets the kind of the item (atomic value, element node, attribute node....).
long	getLeftSiblingKey() Gets key of the context item's left sibling.
long	getParentKey() Gets key of the context item's parent.
long	getRightSiblingKey() Gets key of the context item's right sibling.
int	getTypeKey() Gets value type of the item.
boolean	hasFirstChild() Declares, whether the item has a first child.
int	hashCode()
boolean	hasLeftSibling() Declares, whether the item has a left sibling.
boolean	hasParent() Declares, whether the item has a parent.
boolean	hasRightSibling() Declares, whether the item has a right sibling.
void	incrementChildCount() Incrementing the child count.
void	serialize(DataOutput pOutput) Serializing to given dataput
void	setFirstChildKey(long pKey) Setting the first child sibling key to this node.
void	setHash(long pHash) Setting the hash of this node including substructure.
void	setLeftSiblingKey(long pKey) Setting the left sibling key to this node.
void	setParentKey(long pKey) Setting the parent key.
void	setRightSiblingKey(long pKey) Setting the right sibling key to this node.
void	setTypeKey(int pTypeKey) Setting the type key.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DocumentRootNode

public DocumentRootNode(NodeDelegate pNodeDel,
                StructNodeDelegate pStrucDel)

Constructor.

Parameters:

pNodeDel - delegate for node properties

pStrucDel - delegate for struct properties

Method Detail

getKind

public int getKind()

Gets the kind of the item (atomic value, element node, attribute node....).

Specified by:

getKind in interface INode

Returns:

kind of item

getDataKey

public long getDataKey()

Gets unique IData key. This key should be set over the IBucketWriteTrx.incrementDataKey for getting the correct offset within retrievals.

Specified by:

getDataKey in interface IData

Returns:

datakey

getParentKey

public long getParentKey()

Gets key of the context item's parent.

Specified by:

getParentKey in interface INode

Returns:

parent key

getHash

public long getHash()

Getting the persisted hash value for this node.

Specified by:

getHash in interface INode

Returns:

the hash stored in this node

setHash

public void setHash(long pHash)

Setting the hash of this node including substructure.

Specified by:

setHash in interface INode

Parameters:

pHash - to be set

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object pObj)

Overrides:

equals in class Object

getTypeKey

public int getTypeKey()

Gets value type of the item.

Specified by:

getTypeKey in interface INode

Returns:

value type

hasParent

public boolean hasParent()

Declares, whether the item has a parent.

Specified by:

hasParent in interface INode

Returns:

true, if item has a parent

hasFirstChild

public boolean hasFirstChild()

Declares, whether the item has a first child.

Specified by:

hasFirstChild in interface IStructNode

Returns:

true, if item has a first child, otherwise false

hasLeftSibling

public boolean hasLeftSibling()

Declares, whether the item has a left sibling.

Specified by:

hasLeftSibling in interface IStructNode

Returns:

true, if item has a left sibling, otherwise false

hasRightSibling

public boolean hasRightSibling()

Declares, whether the item has a right sibling.

Specified by:

hasRightSibling in interface IStructNode

Returns:

true, if item has a right sibling, otherwise false

getChildCount

public long getChildCount()

Gets the number of children of the item.

Specified by:

getChildCount in interface IStructNode

Returns:

item's number of children

getFirstChildKey

public long getFirstChildKey()

Gets key of the context item's first child.

Specified by:

getFirstChildKey in interface IStructNode

Returns:

first child's key

getLeftSiblingKey

public long getLeftSiblingKey()

Gets key of the context item's left sibling.

Specified by:

getLeftSiblingKey in interface IStructNode

Returns:

left sibling key

getRightSiblingKey

public long getRightSiblingKey()

Gets key of the context item's right sibling.

Specified by:

getRightSiblingKey in interface IStructNode

Returns:

right sibling key

setRightSiblingKey

public void setRightSiblingKey(long pKey)

Setting the right sibling key to this node.

Specified by:

setRightSiblingKey in interface IStructNode

Parameters:

pKey - the new key to be set.

setLeftSiblingKey

public void setLeftSiblingKey(long pKey)

Setting the left sibling key to this node.

Specified by:

setLeftSiblingKey in interface IStructNode

Parameters:

pKey - the new key to be set.

setFirstChildKey

public void setFirstChildKey(long pKey)

Setting the first child sibling key to this node.

Specified by:

setFirstChildKey in interface IStructNode

Parameters:

pKey - the new key to be set.

decrementChildCount

public void decrementChildCount()

Decrementing the child count.

Specified by:

decrementChildCount in interface IStructNode

incrementChildCount

public void incrementChildCount()

Incrementing the child count.

Specified by:

incrementChildCount in interface IStructNode

setParentKey

public void setParentKey(long pKey)

Setting the parent key.

Specified by:

setParentKey in interface INode

Parameters:

pKey - the parent to be set.

setTypeKey

public void setTypeKey(int pTypeKey)

Setting the type key.

Specified by:

setTypeKey in interface INode

Parameters:

pTypeKey - the type to be set.

toString

public String toString()

Overrides:

toString in class Object

serialize

public void serialize(DataOutput pOutput)
               throws TTIOException

Serializing to given dataput

Specified by:

serialize in interface IData

Parameters:

pOutput - to serialize to

Throws:

TTIOException

getFunnel

public com.google.common.hash.Funnel<IData> getFunnel()

Description copied from interface: IData

Getting a Funnel for computing guava-based hashes.

Specified by:

getFunnel in interface IData

Returns:

a Funnel for this IData