Package org.basex.build

Class DiskBuilder

java.lang.Object

org.basex.core.jobs.Job

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-21, BSD License, Christian Gruen

Field Summary

Fields inherited from class org.basex.core.jobs.Job

state, updating

Constructor Summary

Constructors

Constructor	Description
DiskBuilder(String name, Parser parser, StaticOptions sopts, MainOptions opts)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	addAttr(int nameId, byte[] value, int dist, int uriId)	Adds an attribute to the database.
protected void	addDoc(byte[] value)	Adds a document node to the database.
protected void	addElem(int dist, int nameId, int asize, int uriId, 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 and returns the resulting database instance.
protected void	setSize(int pre, int size)	Stores a size value to the specified table position.

Methods inherited from class org.basex.build.Builder

binary, binaryDir, closeDoc, closeElem, comment, detailedInfo, emptyElem, openDoc, openElem, pi, progressInfo, shortInfo, text

Methods inherited from class org.basex.core.jobs.Job

active, addLocks, checkStop, jc, memory, popJob, pushJob, register, state, stop, stopped, timeout, unregister

Methods inherited from class java.lang.Object

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

Constructor Details

DiskBuilder

public DiskBuilder(String name,
 Parser parser,
 StaticOptions sopts,
 MainOptions opts)

Constructor.

Parameters:

name - name of database

parser - parser

sopts - static options

opts - main options

Method Details

build

public DiskData build()
               throws IOException

Description copied from class: Builder

Builds the database and returns the resulting database instance.

Specified by:

build in class Builder

Returns:

data database instance

Throws:

IOException - I/O exception

addDoc

protected void addDoc(byte[] value)
               throws 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:

IOException - I/O exception

addElem

protected void addElem(int dist,
 int nameId,
 int asize,
 int uriId,
 boolean ne)
                throws 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

nameId - id of element name

asize - number of attributes

uriId - id of namespace uri

ne - namespace flag (indicates if this element introduces new namespaces)

Throws:

IOException - I/O exception

addAttr

protected void addAttr(int nameId,
 byte[] value,
 int dist,
 int uriId)
                throws IOException

Description copied from class: Builder

Adds an attribute to the database.

Specified by:

addAttr in class Builder

Parameters:

nameId - id of attribute name

value - attribute value

dist - distance to parent

uriId - id of namespace uri

Throws:

IOException - I/O exception

addText

protected void addText(byte[] value,
 int dist,
 byte kind)
                throws 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

dist - distance to parent

kind - the node kind

Throws:

IOException - I/O exception

setSize

protected void setSize(int pre,
 int size)
                throws 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:

IOException - I/O exception