org.basex.build

Class DiskBuilder

java.lang.Object

org.basex.core.Progress

org.basex.build.Builder

org.basex.build.DiskBuilder

public final class DiskBuilder
extends Builder

This class creates a database instance on disk. The storage layout is described in the Data class.

Author:

BaseX Team 2005-12, BSD License, Christian Gruen

Field Summary

Fields inherited from class org.basex.core.Progress

updating

Constructor Summary

Constructors

Constructor and Description
DiskBuilder(java.lang.String nm, Parser parse, Context ctx) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	abort() Aborts a failed or interrupted progress.
protected void	addAttr(int nm, byte[] value, int dist, int uri) Adds an attribute to the database.
protected void	addDoc(byte[] value) Adds a document node to the database.
protected void	addElem(int dist, int nm, int asize, int uri, boolean ne) Adds an element node to the database.
protected void	addText(byte[] value, int dist, byte kind) Adds a text node to the database.
DiskData	build() Builds the database by running the specified parser.
void	close() Closes open references.
protected void	setSize(int pre, int size) Stores a size value to the specified table position.

Methods inherited from class org.basex.build.Builder

comment, det, emptyElem, encoding, endDoc, endElem, pi, prog, startDoc, startElem, startNS, text, tit

Methods inherited from class org.basex.core.Progress

checkStop, detail, progress, progress, startTimeout, stop, stopTimeout, title

Methods inherited from class java.lang.Object

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

Constructor Detail

DiskBuilder

public DiskBuilder(java.lang.String nm,
           Parser parse,
           Context ctx)

Constructor.

Parameters:

nm - name of database

parse - parser

ctx - database context

Method Detail

build

public DiskData build()
               throws java.io.IOException

Description copied from class: Builder

Builds the database by running the specified parser.

Specified by:

build in class Builder

Returns:

data database instance

Throws:

java.io.IOException - I/O exception

abort

public void abort()

Description copied from class: Progress

Aborts a failed or interrupted progress.

Overrides:

abort in class Progress

close

public void close()
           throws java.io.IOException

Description copied from class: Builder

Closes open references.

Specified by:

close in class Builder

Throws:

java.io.IOException - I/O exception

addDoc

protected void addDoc(byte[] value)
               throws java.io.IOException

Description copied from class: Builder

Adds a document node to the database.

Specified by:

addDoc in class Builder

Parameters:

value - name of the document

Throws:

java.io.IOException - I/O exception

addElem

protected void addElem(int dist,
           int nm,
           int asize,
           int uri,
           boolean ne)
                throws java.io.IOException

Description copied from class: Builder

Adds an element node to the database. This method stores a preliminary size value; if this node has further descendants, Builder.setSize(int, int) must be called to set the final size value.

Specified by:

addElem in class Builder

Parameters:

dist - distance to parent

nm - the tag name reference

asize - number of attributes

uri - namespace uri reference

ne - namespace flag

Throws:

java.io.IOException - I/O exception

addAttr

protected void addAttr(int nm,
           byte[] value,
           int dist,
           int uri)
                throws java.io.IOException

Description copied from class: Builder

Adds an attribute to the database.

Specified by:

addAttr in class Builder

Parameters:

nm - attribute name

value - attribute value

dist - distance to parent

uri - namespace uri reference

Throws:

java.io.IOException - I/O exception

addText

protected void addText(byte[] value,
           int dist,
           byte kind)
                throws java.io.IOException

Description copied from class: Builder

Adds a text node to the database.

Specified by:

addText in class Builder

Parameters:

value - the token to be added (tag name or content)

dist - distance to parent

kind - the node kind

Throws:

java.io.IOException - I/O exception

setSize

protected void setSize(int pre,
           int size)
                throws java.io.IOException

Description copied from class: Builder

Stores a size value to the specified table position.

Specified by:

setSize in class Builder

Parameters:

pre - pre reference

size - value to be stored

Throws:

java.io.IOException - I/O exception