org.treetank.node.delegates

Class StructNodeDelegate

java.lang.Object

org.treetank.node.delegates.StructNodeDelegate

All Implemented Interfaces:

IData, INode, IStructNode

public class StructNodeDelegate
extends Object
implements IStructNode

Delegate method for all nodes building up the structure. That means that all nodes representing trees in Treetank are represented by an instance of the interface IStructNode namely containing the position of all related siblings, the first-child and all nodes defined by the NodeDelegate as well.

Author:

Sebastian Graf, University of Konstanz

Constructor Summary

Constructors

Constructor and Description
StructNodeDelegate(NodeDelegate pDel, long pFirstChild, long pRightSib, long pLeftSib, long pChildCount) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	decrementChildCount() Decrementing the child count.
boolean	equals(Object obj)
long	getChildCount() Gets the number of children of the item.
long	getDataKey() Delegate method for getNodeKey.
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() Delegate method for getHash.
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() Delegate method for getParentKey.
long	getRightSiblingKey() Gets key of the context item's right sibling.
int	getTypeKey() Delegate method for getTypeKey.
boolean	hasFirstChild() Declares, whether the item has a first child.
int	hashCode()
boolean	hasLeftSibling() Declares, whether the item has a left sibling.
boolean	hasParent() Delegate method for hasParent.
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) Delegate method for setHash.
void	setLeftSiblingKey(long pKey) Setting the left sibling key to this node.
void	setParentKey(long pParentKey) Delegate method for setParentKey.
void	setRightSiblingKey(long pKey) Setting the right sibling key to this node.
void	setTypeKey(int pTypeKey) Delegate method for setTypeKey.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

StructNodeDelegate

public StructNodeDelegate(NodeDelegate pDel,
                  long pFirstChild,
                  long pRightSib,
                  long pLeftSib,
                  long pChildCount)

Constructor.

Parameters:

pDel - to be set

pFirstChild - to be set

pRightSib - to be set

pLeftSib - to be set

pChildCount - to be set

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

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

getDataKey

public long getDataKey()

Delegate method for getNodeKey.

Specified by:

getDataKey in interface IData

Returns:

the key of the node

See Also:

NodeDelegate.getDataKey()

getParentKey

public long getParentKey()

Delegate method for getParentKey.

Specified by:

getParentKey in interface INode

Returns:

the key of the parent

See Also:

NodeDelegate.getParentKey()

setParentKey

public void setParentKey(long pParentKey)

Delegate method for setParentKey.

Specified by:

setParentKey in interface INode

Parameters:

pParentKey -

See Also:

NodeDelegate.setParentKey(long)

getHash

public long getHash()

Delegate method for getHash.

Specified by:

getHash in interface INode

Returns:

the hash

See Also:

NodeDelegate.getHash()

setHash

public void setHash(long pHash)

Delegate method for setHash.

Specified by:

setHash in interface INode

Parameters:

pHash -

See Also:

NodeDelegate.setHash(long)

getTypeKey

public int getTypeKey()

Delegate method for getTypeKey.

Specified by:

getTypeKey in interface INode

Returns:

the type of the node

See Also:

NodeDelegate.getTypeKey()

setTypeKey

public void setTypeKey(int pTypeKey)

Delegate method for setTypeKey.

Specified by:

setTypeKey in interface INode

Parameters:

pTypeKey -

See Also:

NodeDelegate.setTypeKey(int)

hasParent

public boolean hasParent()

Delegate method for hasParent.

Specified by:

hasParent in interface INode

Returns:

if the node has a parent

See Also:

NodeDelegate.hasParent()

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object