org.xbup.io.tree

Class XBTreeNode

java.lang.Object

org.xbup.io.tree.XBTreeNode

All Implemented Interfaces:

java.io.Serializable, javax.swing.tree.TreeNode, XBBlock, XBEditableBlock, XBConversible, XBRConversible, UBStreamable

public class XBTreeNode
extends java.lang.Object
implements XBEditableBlock, javax.swing.tree.TreeNode, UBStreamable, XBRConversible

XBUP Level 0 Tree Node.

Version:

0.1 wr20.0 2010/09/26

Author:

XBUP Project (http://xbup.org)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XBTreeNode.MyXBListener

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
int	attrSizeUB()
XBTreeNode	clone()
XBTreeNode	clone(boolean recursive)
XBListener	convertFromXB() Get instance for conversion content from XB level 1 data to object.
XBListener	convertFromXBR(boolean recursive) Get instance for conversion content from XB level 0 data to object.
XBProvider	convertToXB() Get instance for conversion content of object to XB level 0 data.
XBProvider	convertToXBR(boolean recursive) Get instance for conversion content of object to XB level 0 data.
XBTreeNode	findNodeByIndex(long index) Find Node on given depth-first order index (recursive, no cache)
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
long	getBlockSize() Get block size
java.io.InputStream	getData() Get node data
byte[]	getDataArray()
int	getDataSize() Get data size
XBTreeNode	getChildAt(int childIndex) Get children of given index
int	getChildCount() Get count of children
java.util.List<XBBlock>	getChildren() Get list of all children
int	getIndex(javax.swing.tree.TreeNode node) Return index of child
int	getNodeIndex() Get index in depth-first order
int	getNodeIndexAfter()
XBTreeNode	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)
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.
XBTreeNode	newNodeInstance(XBTreeNode parent) TODO: This is stub, because I'm to lazy to think about proper solution
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	setData(java.io.InputStream source) Set node data
void	setDataNode(boolean dataNode) Set data node
void	setChildAt(XBBlock block, int childIndex) Set children of given index
void	setChildCount(int count) Get count of children
void	setChildren(java.util.List<XBBlock> children) Set list of all children
void	setParent(XBBlock 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()

Methods inherited from class java.lang.Object

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

Constructor Detail

XBTreeNode

public XBTreeNode()

Creates a new instance of XBTreeNode

XBTreeNode

public XBTreeNode(XBTreeNode parent)

Creates a new instance of XBTreeNode.

Parameters:

parent - Set it as parent node

Method Detail

getParent

public XBTreeNode getParent()

Description copied from interface: XBBlock

Get parent block or null if block has no parent.

Specified by:

getParent in interface javax.swing.tree.TreeNode

Specified by:

getParent in interface XBBlock

Returns:

Parent block.

getChildAt

public XBTreeNode getChildAt(int childIndex)

Description copied from interface: XBBlock

Get children of given index

Specified by:

getChildAt in interface javax.swing.tree.TreeNode

Specified by:

getChildAt in interface XBBlock

getChildCount

public int getChildCount()

Description copied from interface: XBBlock

Get count of children

Specified by:

getChildCount in interface javax.swing.tree.TreeNode

Specified by:

getChildCount in interface XBBlock

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

getNodeIndex

public int getNodeIndex()

Get index in depth-first order

getNodeIndexAfter

public int getNodeIndexAfter()

findNodeByIndex

public XBTreeNode 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

childrenFromStreamUB

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

Parameters:

maxSize - Maximum size of bytes to consume. Otherwise Exception. Zero means terminated block.

Throws:

java.io.IOException

XBProcessingException

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: XBBlock

Get List of attributes in order of appearance

Specified by:

getAttributes in interface XBBlock

setAttributes

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

Description copied from interface: XBEditableBlock

Set List of attributes in order of appearance

Specified by:

setAttributes in interface XBEditableBlock

isDataNode

public boolean isDataNode()

Description copied from interface: XBBlock

Returns whether this block is data block.

Specified by:

isDataNode in interface XBBlock

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: XBBlock

Get count of attributes

Specified by:

getAttributesCount in interface XBBlock

getAttribute

public UBNatural getAttribute(int index)

Description copied from interface: XBBlock

Gets attribute of given index

Specified by:

getAttribute in interface XBBlock

getChildren

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

Description copied from interface: XBBlock

Get list of all children

Specified by:

getChildren in interface XBBlock

setChildren

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

Description copied from interface: XBEditableBlock

Set list of all children

Specified by:

setChildren in interface XBEditableBlock

setParent

public void setParent(XBBlock parent)

Description copied from interface: XBEditableBlock

Set parent block

Specified by:

setParent in interface XBEditableBlock

setData

public void setData(java.io.InputStream source)

Description copied from interface: XBEditableBlock

Set node data

Specified by:

setData in interface XBEditableBlock

getData

public java.io.InputStream getData()

Description copied from interface: XBBlock

Get node data

Specified by:

getData in interface XBBlock

getDataArray

public byte[] getDataArray()

getDataSize

public int getDataSize()

Description copied from interface: XBBlock

Get data size

Specified by:

getDataSize in interface XBBlock

isTerminated

public boolean isTerminated()

Description copied from interface: XBBlock

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

Specified by:

isTerminated in interface XBBlock

Returns:

true, if this is in terminated mode

setTerminated

public void setTerminated(boolean terminated)

Description copied from interface: XBEditableBlock

Set terminated node

Specified by:

setTerminated in interface XBEditableBlock

clone

public XBTreeNode clone()

Overrides:

clone in class java.lang.Object

clone

public XBTreeNode clone(boolean recursive)

convertToXBR

public XBProvider convertToXBR(boolean recursive)

Description copied from interface: XBRConversible

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

Specified by:

convertToXBR in interface XBRConversible

Parameters:

recursive - flag whether instance shall support full or shallow conversion

Returns:

instance of conversion class or null if conversion is not supported

convertFromXBR

public XBListener convertFromXBR(boolean recursive)

Description copied from interface: XBRConversible

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

Specified by:

convertFromXBR in interface XBRConversible

Parameters:

recursive - flag whether instance shall support full or shallow conversion

Returns:

instance of conversion class or null if conversion is not supported

convertToXB

public XBProvider convertToXB()

Description copied from interface: XBConversible

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

Specified by:

convertToXB in interface XBConversible

Returns:

instance of conversion class or null if conversion is not supported

convertFromXB

public XBListener convertFromXB()

Description copied from interface: XBConversible

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

Specified by:

convertFromXB in interface XBConversible

Returns:

instance of conversion class or null if conversion is not supported

setDataNode

public void setDataNode(boolean dataNode)

Description copied from interface: XBEditableBlock

Set data node

Specified by:

setDataNode in interface XBEditableBlock

setAttributesCount

public void setAttributesCount(int count)

Description copied from interface: XBEditableBlock

Set count of attributes

Specified by:

setAttributesCount in interface XBEditableBlock

setAttribute

public void setAttribute(UBNatural attribute,
                int index)

Description copied from interface: XBEditableBlock

Set attribute of given index

Specified by:

setAttribute in interface XBEditableBlock

setChildCount

public void setChildCount(int count)

Description copied from interface: XBEditableBlock

Get count of children

Specified by:

setChildCount in interface XBEditableBlock

setChildAt

public void setChildAt(XBBlock block,
              int childIndex)

Description copied from interface: XBEditableBlock

Set children of given index

Specified by:

setChildAt in interface XBEditableBlock

getBlockSize

public long getBlockSize()

Description copied from interface: XBBlock

Get block size

Specified by:

getBlockSize in interface XBBlock

newNodeInstance

public XBTreeNode newNodeInstance(XBTreeNode parent)

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