org.treetank.node

Class AtomicValue

java.lang.Object

org.treetank.node.AtomicValue

All Implemented Interfaces:

IData, INode, IValNode

public class AtomicValue
extends Object
implements INode, IValNode

AtomicValue

An item represents either an atomic value or a node. An atomic value is a value in the value space of an atomic type, as defined in XMLSchema 1.1. (Definition: Atomic types are anyAtomicType and all types derived from it.)

Constructor Summary

Constructors

Constructor and Description
AtomicValue(boolean pValue) Constructor.
AtomicValue(byte[] pValue, int pType) Constructor.
AtomicValue(Number pValue, Type pType) Constructor.
AtomicValue(String pValue, Type pType) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getBool() Returns the atomic value as a boolean.
long	getDataKey() Gets unique IData key.
double	getDBL() Returns the atomic value as a double.
float	getFLT() Returns the atomic value as a float.
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	getInt() Returns the atomic value as an integer.
int	getKind() Gets the kind of the item (atomic value, element node, attribute node....).
long	getParentKey() Gets key of the context item's parent.
byte[]	getRawValue() Return a byte array representation of the item's value.
String	getType() Getting the type of the value.
int	getTypeKey() Gets value type of the item.
boolean	hasParent() Declares, whether the item has a parent.
boolean	isFullText() Check if is fulltext.
boolean	isFullTextLeaf() Test if the lead is tes.
boolean	isFullTextRoot() Test if the root is full text.
void	serialize(DataOutput pOutput) Serializing to given dataput
void	setHash(long hash) Setting the hash of this node including substructure.
void	setNodeKey(long pNodeKey) Setting the node key for an item
void	setParentKey(long paramKey) Setting the parent key.
void	setTypeKey(int paramType) Setting the type key.
void	setValue(byte[] paramVal) Setting the value key.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AtomicValue

public AtomicValue(byte[] pValue,
           int pType)

Constructor. Initializes the internal state.

Parameters:

pValue - the value of the Item

pType - the item's type

AtomicValue

public AtomicValue(boolean pValue)

Constructor. Initializes the internal state.

Parameters:

pValue - the value of the Item

AtomicValue

public AtomicValue(Number pValue,
           Type pType)

Constructor. Initializes the internal state.

Parameters:

pValue - the value of the Item

pType - the item's type

AtomicValue

public AtomicValue(String pValue,
           Type pType)

Constructor. Initializes the internal state.

Parameters:

pValue - the value of the Item

pType - the item's type

Method Detail

getParentKey

public long getParentKey()

Gets key of the context item's parent.

Specified by:

getParentKey in interface INode

Returns:

parent key

hasParent

public boolean hasParent()

Declares, whether the item has a parent.

Specified by:

hasParent in interface INode

Returns:

true, if item has a parent

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

setNodeKey

public void setNodeKey(long pNodeKey)

Setting the node key for an item

Parameters:

pNodeKey - to be set

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

isFullText

public boolean isFullText()

Check if is fulltext.

Returns:

true if fulltext, false otherwise

isFullTextLeaf

public boolean isFullTextLeaf()

Test if the lead is tes.

Returns:

true if fulltest leaf, false otherwise

isFullTextRoot

public boolean isFullTextRoot()

Test if the root is full text.

Returns:

true if fulltest root, false otherwise

getTypeKey

public final int getTypeKey()

Gets value type of the item.

Specified by:

getTypeKey in interface INode

Returns:

value type

getType

public final String getType()

Getting the type of the value.

Returns:

the type of this value

getInt

public int getInt()

Returns the atomic value as an integer.

Returns:

the value as an integer

getBool

public boolean getBool()

Returns the atomic value as a boolean.

Returns:

the value as a boolean

getFLT

public float getFLT()

Returns the atomic value as a float.

Returns:

the value as a float

getDBL

public double getDBL()

Returns the atomic value as a double.

Returns:

the value as a double

setHash

public void setHash(long hash)

Description copied from interface: INode

Setting the hash of this node including substructure.

Specified by:

setHash in interface INode

Parameters:

hash - to be set

getHash

public long getHash()

Description copied from interface: INode

Getting the persisted hash value for this node.

Specified by:

getHash in interface INode

Returns:

the hash stored in this node

setParentKey

public void setParentKey(long paramKey)

Description copied from interface: INode

Setting the parent key.

Specified by:

setParentKey in interface INode

Parameters:

paramKey - the parent to be set.

setTypeKey

public void setTypeKey(int paramType)

Description copied from interface: INode

Setting the type key.

Specified by:

setTypeKey in interface INode

Parameters:

paramType - the type to be set.

getRawValue

public byte[] getRawValue()

Return a byte array representation of the item's value.

Specified by:

getRawValue in interface IValNode

Returns:

returns the value of the item

setValue

public void setValue(byte[] paramVal)

Setting the value key.

Specified by:

setValue in interface IValNode

Parameters:

paramVal - the value 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()

Getting a Funnel for computing guava-based hashes.

Specified by:

getFunnel in interface IData

Returns:

a Funnel for this IData