org.xbup.io.tree

Class XBTTreeDocument

java.lang.Object

org.xbup.io.tree.XBTTree

org.xbup.io.tree.XBTTreeDocument

All Implemented Interfaces:

java.io.Serializable, XBTDocument, XBTEditableDocument, UBStreamable

public class XBTTreeDocument
extends XBTTree
implements XBTEditableDocument

XBUP Level 1 XBTree Document.

Version:

0.1 wr20.0 2010/09/26

Author:

XBUP Project (http://xbup.org)

See Also:

Serialized Form

Field Summary

Fields inherited from class org.xbup.io.tree.XBTTree

rootContext

Constructor Summary

Constructors

Constructor and Description
XBTTreeDocument() Creates a new instance of XBTreeDocument
XBTTreeDocument(XBCatalog catalog)

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clear all data in this document
XBTBlock	createNewBlock(XBTBlock parent) Create new instance of block as next child for given block.
XBTBlock	findNodeByIndex(long index) Find node using depth-first traversal index.
int	fromFileUB()
int	fromStreamUB(java.io.InputStream stream) Method for reading values in UB Encoding from standard data stream.
long	getDocumentSize() Get size of the whole document.
java.io.InputStream	getExtended() Get extended data area.
byte[]	getExtendedArray()
long	getExtendedSize() Get size of extended data area.
java.lang.String	getFileName()
void	processSpec()
void	setExtended(java.io.InputStream source) Set extended data area.
void	setFileName(java.lang.String fileName)
void	setModified(boolean modified)
void	setRootBlock(XBTBlock block) Set root block of the document.
int	sizeUB() Method for reading size of data which would be saved in data stream.
int	toFileUB()
int	toStreamUB(java.io.OutputStream stream) Method for writting values in UB Encoding to standard data stream.
boolean	wasModified()

Methods inherited from class org.xbup.io.tree.XBTTree

getCatalog, getRootBlock, getRootContext, newNodeInstance, setCatalog, setRootBlock, setRootContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xbup.io.tree.XBTDocument

getRootBlock

Constructor Detail

XBTTreeDocument

public XBTTreeDocument()

Creates a new instance of XBTreeDocument

XBTTreeDocument

public XBTTreeDocument(XBCatalog catalog)

Method Detail

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

Overrides:

toStreamUB in class XBTTree

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

Overrides:

fromStreamUB in class XBTTree

Parameters:

stream - Stream to read

Returns:

Count of bytes read from stream

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

Overrides:

sizeUB in class XBTTree

Returns:

Count of bytes which would be saved

getExtended

public java.io.InputStream getExtended()

Description copied from interface: XBTDocument

Get extended data area.

Specified by:

getExtended in interface XBTDocument

Returns:

InputStream of providing read access to data area.

getExtendedArray

public byte[] getExtendedArray()

setExtended

public void setExtended(java.io.InputStream source)

Description copied from interface: XBTEditableDocument

Set extended data area.

Specified by:

setExtended in interface XBTEditableDocument

Parameters:

source - InputStream to use as data source for this document.

getExtendedSize

public long getExtendedSize()

Description copied from interface: XBTDocument

Get size of extended data area.

Specified by:

getExtendedSize in interface XBTDocument

Returns:

length of extended area in bytes.

clear

public void clear()

Description copied from interface: XBTEditableDocument

Clear all data in this document

Specified by:

clear in interface XBTEditableDocument

Overrides:

clear in class XBTTree

setRootBlock

public void setRootBlock(XBTBlock block)
                  throws XBProcessingException

Description copied from interface: XBTEditableDocument

Set root block of the document.

Specified by:

setRootBlock in interface XBTEditableDocument

Parameters:

block - the block to use as root block for this document.

Throws:

XBProcessingException

wasModified

public boolean wasModified()

setModified

public void setModified(boolean modified)

getFileName

public java.lang.String getFileName()

setFileName

public void setFileName(java.lang.String fileName)

fromFileUB

public int fromFileUB()
               throws java.io.IOException,
                      XBProcessingException

Throws:

java.io.IOException

XBProcessingException

toFileUB

public int toFileUB()
             throws java.io.IOException

Throws:

java.io.IOException

processSpec

public void processSpec()

Overrides:

processSpec in class XBTTree

findNodeByIndex

public XBTBlock findNodeByIndex(long index)

Description copied from interface: XBTEditableDocument

Find node using depth-first traversal index.

Specified by:

findNodeByIndex in interface XBTEditableDocument

Overrides:

findNodeByIndex in class XBTTree

Parameters:

index - order of the block in document.

Returns:

block if found else null.

createNewBlock

public XBTBlock createNewBlock(XBTBlock parent)

Description copied from interface: XBTEditableDocument

Create new instance of block as next child for given block.

Specified by:

createNewBlock in interface XBTEditableDocument

Parameters:

parent - block which would be set as parent block. Null for root node.

Returns:

newly created instance of this document.

getDocumentSize

public long getDocumentSize()

Description copied from interface: XBTDocument

Get size of the whole document. It is sum of the size of the root node if present + size of the extended area.

Specified by:

getDocumentSize in interface XBTDocument

Returns:

length of extended area in bytes.