org.xbup.io.tree

Class XBTTreeNode

java.lang.Object

org.xbup.io.tree.XBTTreeNode

All Implemented Interfaces:

java.io.Serializable, javax.swing.tree.TreeNode, XBTBlock, XBTEditableBlock, XBTConversible, XBTRConversible, UBStreamable

public class XBTTreeNode
extends java.lang.Object
implements javax.swing.tree.TreeNode, XBTEditableBlock, UBStreamable, XBTRConversible

XBUP Level 1 Tree Node.

Version:

0.1 wr20.0 2011/05/01

Author:

XBUP Project (http://xbup.org)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	XBTTreeNode.XBParamExtractor Class for extracting specified param from tokens

Constructor Summary

Constructors

Constructor and Description
XBTTreeNode() Creates a new instance of XBTTreeNode
XBTTreeNode(XBTTreeNode parent) Creates a new instance of XBTTreeNode.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttribute(UBNatural attribute)
int	attrSizeUB()
void	clearAttributes()
XBTTreeNode	clone()
XBTTreeNode	clone(boolean recursive)
XBTListener	convertFromXBT() Get instance for conversion content from XB level 1 data to object.
XBTListener	convertFromXBTR(boolean recursive) Get instance for conversion content from XB level 1 data to object.
XBTProvider	convertToXBT() Get instance for conversion content of object to XB level 1 data.
XBTProvider	convertToXBTR(boolean recursive) Get instance for conversion content of object to XB level 1 data.
XBTTreeNode	findNodeByIndex(long index) Find Node on given depth-first order index (recursive, no cache)
XBTTreeNode	followPointer(int index)
int	fromStreamUB(java.io.InputStream stream) Method for reading values in UB Encoding from standard data stream.
int	fromStreamUB(java.io.InputStream stream, boolean terminable)
boolean	getAllowsChildren() Returns true if the receiver allows children.
UBNatural	getAttribute(int index) Gets attribute of given index
java.util.List<UBNatural>	getAttributes() Get List of attributes in order of appearance
int	getAttributesCount() Get count of attributes
int	getAttrValue(int index)
int	getBlockIndex() Get index in depth-first order
long	getBlockSize() Get block size
XBBlockType	getBlockType() Get block type.
java.io.InputStream	getData() Get node data
byte[]	getDataArray()
int	getDataSize() Get data size
XBTTreeNode	getChildAt(int childIndex) Get children of given index
int	getChildCount() Get count of children
java.util.List<XBTBlock>	getChildren() Get list of all children
int	getIndex(javax.swing.tree.TreeNode node) Return index of child
int	getNodeIndexAfter()
XBTBlock	getParam(XBACatalog catalog, long paramId)
XBTConversible	getParameter(int index) Get specific parameter convertor from current block.
XBTTreeNode	getParent() Get parent block or null if block has no parent.
int	getSubNodesCount() Get count of all subnodes
java.util.Enumeration	children()
int	childrenFromStreamUB(java.io.InputStream stream, int maxSize) Reads all children blocks.
int	childrenSizeUB()
int	childrenToStreamUB(java.io.OutputStream stream)
boolean	isDataNode() Returns whether this block is data block.
boolean	isLeaf()
boolean	isTerminated() Returns whether this block is using sequence of children ended with termination block.
XBTTreeNode	newNodeInstance(XBTTreeNode parent) TODO: This is stub, because I'm to lazy to think about proper solution
void	processSpec(XBCatalog catalog, XBContext parentContext) Performs tree depth specification processing
void	removeAttribute(int index)
void	setAttribute(UBNatural attribute, int index) Set attribute of given index
void	setAttributes(java.util.List<UBNatural> attributes) Set List of attributes in order of appearance
void	setAttributesCount(int count) Set count of attributes
void	setBlockType(XBBlockType blockType)
void	setData(java.io.InputStream source) Set node data
void	setDataNode(boolean dataNode) Set data node
void	setChildAt(XBTBlock block, int childIndex) Set children of given index
void	setChildCount(int count) Get count of children
void	setChildren(java.util.List<XBTBlock> children) Set list of all children
void	setParent(XBTBlock parent) Set parent block
void	setTerminated(boolean terminated) Set terminated node
int	sizeUB() Method for reading size of data which would be saved in data stream.
int	toStreamUB(java.io.OutputStream stream) Method for writting values in UB Encoding to standard data stream.
java.lang.String	toString()
void	toXBTEvents(XBTListener target)
void	toXBTEvents(XBTListener target, boolean recursive)

Methods inherited from class java.lang.Object

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

Constructor Detail

XBTTreeNode

public XBTTreeNode()

Creates a new instance of XBTTreeNode

XBTTreeNode

public XBTTreeNode(XBTTreeNode parent)

Creates a new instance of XBTTreeNode.

Parameters:

parent - Set it as parent node

Method Detail

processSpec

public void processSpec(XBCatalog catalog,
               XBContext parentContext)

Performs tree depth specification processing

followPointer

public XBTTreeNode followPointer(int index)

getAttrValue

public int getAttrValue(int index)

childrenFromStreamUB

public int childrenFromStreamUB(java.io.InputStream stream,
                       int maxSize)
                         throws java.io.IOException,
                                XBProcessingException

Reads all children blocks.

Parameters:

stream - Source input stream

maxSize - Maximum size of bytes to consume. Otherwise Exception.

Throws:

java.io.IOException

XBProcessingException

toXBTEvents

public void toXBTEvents(XBTListener target,
               boolean recursive)
                 throws XBProcessingException,
                        java.io.IOException

Throws:

XBProcessingException

java.io.IOException

toXBTEvents

public void toXBTEvents(XBTListener target)
                 throws XBProcessingException,
                        java.io.IOException

Throws:

XBProcessingException

java.io.IOException

getBlockType

public XBBlockType getBlockType()

Description copied from interface: XBTBlock

Get block type.

Specified by:

getBlockType in interface XBTBlock

Returns:

Block type.

getParent

public XBTTreeNode getParent()

Description copied from interface: XBTBlock

Get parent block or null if block has no parent.

Specified by:

getParent in interface javax.swing.tree.TreeNode

Specified by:

getParent in interface XBTBlock

Returns:

Parent block.

getChildAt

public XBTTreeNode getChildAt(int childIndex)

Description copied from interface: XBTBlock

Get children of given index

Specified by:

getChildAt in interface javax.swing.tree.TreeNode

Specified by:

getChildAt in interface XBTBlock

getChildCount

public int getChildCount()

Description copied from interface: XBTBlock

Get count of children

Specified by:

getChildCount in interface javax.swing.tree.TreeNode

Specified by:

getChildCount in interface XBTBlock

getIndex

public int getIndex(javax.swing.tree.TreeNode node)

Return index of child

Specified by:

getIndex in interface javax.swing.tree.TreeNode

getSubNodesCount

public int getSubNodesCount()

Get count of all subnodes

getBlockIndex

public int getBlockIndex()

Get index in depth-first order

Specified by:

getBlockIndex in interface XBTBlock

getNodeIndexAfter

public int getNodeIndexAfter()

findNodeByIndex

public XBTTreeNode findNodeByIndex(long index)

Find Node on given depth-first order index (recursive, no cache)

getAllowsChildren

public boolean getAllowsChildren()

Returns true if the receiver allows children.

Specified by:

getAllowsChildren in interface javax.swing.tree.TreeNode

isLeaf

public boolean isLeaf()

Specified by:

isLeaf in interface javax.swing.tree.TreeNode

children

public java.util.Enumeration children()

Specified by:

children in interface javax.swing.tree.TreeNode

toStreamUB

public int toStreamUB(java.io.OutputStream stream)
               throws java.io.IOException

Description copied from interface: UBStreamable

Method for writting values in UB Encoding to standard data stream.

Specified by:

toStreamUB in interface UBStreamable

Parameters:

stream - Stream to write

Returns:

Count of bytes written to stream

Throws:

java.io.IOException

fromStreamUB

public int fromStreamUB(java.io.InputStream stream)
                 throws java.io.IOException,
                        XBProcessingException

Description copied from interface: UBStreamable

Method for reading values in UB Encoding from standard data stream.

Specified by:

fromStreamUB in interface UBStreamable

Parameters:

stream - Stream to read

Returns:

Count of bytes read from stream

Throws:

java.io.IOException

XBProcessingException

fromStreamUB

public int fromStreamUB(java.io.InputStream stream,
               boolean terminable)
                 throws java.io.IOException,
                        XBProcessingException

Parameters:

terminable - Specify if termitor can be read

Throws:

java.io.IOException

XBProcessingException

childrenToStreamUB

public int childrenToStreamUB(java.io.OutputStream stream)
                       throws java.io.IOException

Throws:

java.io.IOException

sizeUB

public int sizeUB()

Description copied from interface: UBStreamable

Method for reading size of data which would be saved in data stream.

Specified by:

sizeUB in interface UBStreamable

Returns:

Count of bytes which would be saved

childrenSizeUB

public int childrenSizeUB()

attrSizeUB

public int attrSizeUB()

getAttributes

public java.util.List<UBNatural> getAttributes()

Description copied from interface: XBTBlock

Get List of attributes in order of appearance

Specified by:

getAttributes in interface XBTBlock

setAttributes

public void setAttributes(java.util.List<UBNatural> attributes)

Description copied from interface: XBTEditableBlock

Set List of attributes in order of appearance

Specified by:

setAttributes in interface XBTEditableBlock

isDataNode

public boolean isDataNode()

Description copied from interface: XBTBlock

Returns whether this block is data block.

Specified by:

isDataNode in interface XBTBlock

Returns:

true, if this is data block

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getAttributesCount

public int getAttributesCount()

Description copied from interface: XBTBlock

Get count of attributes

Specified by:

getAttributesCount in interface XBTBlock

getAttribute

public UBNatural getAttribute(int index)

Description copied from interface: XBTBlock

Gets attribute of given index

Specified by:

getAttribute in interface XBTBlock

getChildren

public java.util.List<XBTBlock> getChildren()

Description copied from interface: XBTBlock

Get list of all children

Specified by:

getChildren in interface XBTBlock

setChildren

public void setChildren(java.util.List<XBTBlock> children)

Description copied from interface: XBTEditableBlock

Set list of all children

Specified by:

setChildren in interface XBTEditableBlock

setParent

public void setParent(XBTBlock parent)

Description copied from interface: XBTEditableBlock

Set parent block

Specified by:

setParent in interface XBTEditableBlock

setData

public void setData(java.io.InputStream source)

Description copied from interface: XBTEditableBlock

Set node data

Specified by:

setData in interface XBTEditableBlock

getData

public java.io.InputStream getData()

Description copied from interface: XBTBlock

Get node data

Specified by:

getData in interface XBTBlock

getDataArray

public byte[] getDataArray()

getDataSize

public int getDataSize()

Description copied from interface: XBTBlock

Get data size

Specified by:

getDataSize in interface XBTBlock

isTerminated

public boolean isTerminated()

Description copied from interface: XBTBlock

Returns whether this block is using sequence of children ended with termination block.

Specified by:

isTerminated in interface XBTBlock

Returns:

true, if this is in terminated mode

setTerminated

public void setTerminated(boolean terminated)

Description copied from interface: XBTEditableBlock

Set terminated node

Specified by:

setTerminated in interface XBTEditableBlock

clone

public XBTTreeNode clone()

Overrides:

clone in class java.lang.Object

clone

public XBTTreeNode clone(boolean recursive)

convertToXBTR

public XBTProvider convertToXBTR(boolean recursive)

Description copied from interface: XBTRConversible

Get instance for conversion content of object to XB level 1 data.

Specified by:

convertToXBTR in interface XBTRConversible

Parameters:

recursive - flag whether instance shall support full or shallow conversion

Returns:

instance of conversion class or null if conversion is not supported

convertFromXBTR

public XBTListener convertFromXBTR(boolean recursive)

Description copied from interface: XBTRConversible

Get instance for conversion content from XB level 1 data to object.

Specified by:

convertFromXBTR in interface XBTRConversible

Parameters:

recursive - flag whether instance shall support full or shallow conversion

Returns:

instance of conversion class or null if conversion is not supported

convertToXBT

public XBTProvider convertToXBT()

Description copied from interface: XBTConversible

Get instance for conversion content of object to XB level 1 data.

Specified by:

convertToXBT in interface XBTConversible

Returns:

instance of conversion class or null if conversion is not supported

convertFromXBT

public XBTListener convertFromXBT()

Description copied from interface: XBTConversible

Get instance for conversion content from XB level 1 data to object.

Specified by:

convertFromXBT in interface XBTConversible

Returns:

instance of conversion class or null if conversion is not supported

setDataNode

public void setDataNode(boolean dataNode)

Description copied from interface: XBTEditableBlock

Set data node

Specified by:

setDataNode in interface XBTEditableBlock

setAttributesCount

public void setAttributesCount(int count)

Description copied from interface: XBTEditableBlock

Set count of attributes

Specified by:

setAttributesCount in interface XBTEditableBlock

setAttribute

public void setAttribute(UBNatural attribute,
                int index)

Description copied from interface: XBTEditableBlock

Set attribute of given index

Specified by:

setAttribute in interface XBTEditableBlock

setChildCount

public void setChildCount(int count)

Description copied from interface: XBTEditableBlock

Get count of children

Specified by:

setChildCount in interface XBTEditableBlock

setChildAt

public void setChildAt(XBTBlock block,
              int childIndex)

Description copied from interface: XBTEditableBlock

Set children of given index

Specified by:

setChildAt in interface XBTEditableBlock

newNodeInstance

public XBTTreeNode newNodeInstance(XBTTreeNode parent)

TODO: This is stub, because I'm to lazy to think about proper solution

getBlockSize

public long getBlockSize()

Description copied from interface: XBTBlock

Get block size

Specified by:

getBlockSize in interface XBTBlock

setBlockType

public void setBlockType(XBBlockType blockType)

Parameters:

blockType - the blockType to set

clearAttributes

public void clearAttributes()

addAttribute

public void addAttribute(UBNatural attribute)

removeAttribute

public void removeAttribute(int index)

getParameter

public XBTConversible getParameter(int index)

Get specific parameter convertor from current block.

Parameters:

index - index of requested parameter

Returns:

requested parameter

getParam

public XBTBlock getParam(XBACatalog catalog,
                long paramId)