org.xbup.io.tree

Interface XBTEditableDocument

All Superinterfaces:

XBTDocument

All Known Implementing Classes:

XBTTreeDocument

public interface XBTEditableDocument
extends XBTDocument

Basic interface for editable XBUP document level 1.

Version:

0.1 wr20.0 2010/09/15

Author:

XBUP Project (http://xbup.org)

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.
void	setExtended(java.io.InputStream source) Set extended data area.
void	setRootBlock(XBTBlock block) Set root block of the document.

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

getDocumentSize, getExtended, getExtendedSize, getRootBlock

Method Detail

setExtended

void setExtended(java.io.InputStream source)

Set extended data area.

Parameters:

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

setRootBlock

void setRootBlock(XBTBlock block)
                  throws XBProcessingException

Set root block of the document.

Parameters:

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

Throws:

XBProcessingException

clear

void clear()

Clear all data in this document

findNodeByIndex

XBTBlock findNodeByIndex(long index)

Find node using depth-first traversal index.

Parameters:

index - order of the block in document.

Returns:

block if found else null.

createNewBlock

XBTBlock createNewBlock(XBTBlock parent)

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

Parameters:

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

Returns:

newly created instance of this document.