org.treetank.node.interfaces

Interface IStructNode

All Superinterfaces:

IData, INode

All Known Implementing Classes:

DocumentRootNode, ElementNode, StructNodeDelegate, TextNode

public interface IStructNode
extends INode

Class to denote that an INode has structural attributes. That means that a class can have pointers to neighbours.

Method Summary

Methods

Modifier and Type	Method and Description
void	decrementChildCount() Decrementing the child count.
long	getChildCount() Gets the number of children of the item.
long	getFirstChildKey() Gets key of the context item's first child.
long	getLeftSiblingKey() Gets key of the context item's left sibling.
long	getRightSiblingKey() Gets key of the context item's right sibling.
boolean	hasFirstChild() Declares, whether the item has a first child.
boolean	hasLeftSibling() Declares, whether the item has a left sibling.
boolean	hasRightSibling() Declares, whether the item has a right sibling.
void	incrementChildCount() Incrementing the child count.
void	setFirstChildKey(long pNodeKey) Setting the first child sibling key to this node.
void	setLeftSiblingKey(long pNodeKey) Setting the left sibling key to this node.
void	setRightSiblingKey(long pNodeKey) Setting the right sibling key to this node.

Methods inherited from interface org.treetank.node.interfaces.INode

getHash, getKind, getParentKey, getTypeKey, hasParent, setHash, setParentKey, setTypeKey

Methods inherited from interface org.treetank.api.IData

getDataKey, getFunnel, serialize

Method Detail

hasFirstChild

boolean hasFirstChild()

Declares, whether the item has a first child.

Returns:

true, if item has a first child, otherwise false

hasLeftSibling

boolean hasLeftSibling()

Declares, whether the item has a left sibling.

Returns:

true, if item has a left sibling, otherwise false

hasRightSibling

boolean hasRightSibling()

Declares, whether the item has a right sibling.

Returns:

true, if item has a right sibling, otherwise false

getChildCount

long getChildCount()

Gets the number of children of the item.

Returns:

item's number of children

getFirstChildKey

long getFirstChildKey()

Gets key of the context item's first child.

Returns:

first child's key

getLeftSiblingKey

long getLeftSiblingKey()

Gets key of the context item's left sibling.

Returns:

left sibling key

getRightSiblingKey

long getRightSiblingKey()

Gets key of the context item's right sibling.

Returns:

right sibling key

setRightSiblingKey

void setRightSiblingKey(long pNodeKey)

Setting the right sibling key to this node.

Parameters:

pNodeKey - the new key to be set.

setLeftSiblingKey

void setLeftSiblingKey(long pNodeKey)

Setting the left sibling key to this node.

Parameters:

pNodeKey - the new key to be set.

setFirstChildKey

void setFirstChildKey(long pNodeKey)

Setting the first child sibling key to this node.

Parameters:

pNodeKey - the new key to be set.

decrementChildCount

void decrementChildCount()

Decrementing the child count.

incrementChildCount

void incrementChildCount()

Incrementing the child count.