Package org.basex.build

Class MemBuilder

java.lang.Object

org.basex.core.jobs.Job

org.basex.build.Builder

org.basex.build.MemBuilder

public final class MemBuilder
extends Builder

This class creates a database instance in main memory. The storage layout is described in the Data class.

Author:

BaseX Team 2005-24, BSD License, Christian Gruen

Field Summary

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

state, updating

Constructor Summary

Constructors

Constructor	Description
MemBuilder(String name, Parser parser)	Constructor.
MemBuilder(Parser parser)	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.
MemData	build()	Builds the database and returns the resulting database instance.
static MemData	build(String name, Parser parser)	Builds a main memory database instance with the specified name.
static MemData	build(Parser parser)	Builds a main memory database instance.
static MemData	build(IO input)	Builds a main memory database instance.
Data	data()	Returns the data reference.
MemBuilder	init()	Initializes the builder.
protected void	setSize(int pre, int size)	Stores a size value to the specified table position.

Methods inherited from class org.basex.build.Builder

binariesDir, binary, 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 Detail

MemBuilder

public MemBuilder(Parser parser)

Constructor.

Parameters:

parser - parser

MemBuilder

public MemBuilder(String name,
                  Parser parser)

Constructor.

Parameters:

name - name of database

parser - parser

Method Detail

build

public static MemData build(IO input)
                     throws IOException

Builds a main memory database instance.

Parameters:

input - input

Returns:

data database instance

Throws:

IOException - I/O exception

build

public static MemData build(Parser parser)
                     throws IOException

Builds a main memory database instance.

Parameters:

parser - parser

Returns:

data database instance

Throws:

IOException - I/O exception

build

public static MemData build(String name,
                            Parser parser)
                     throws IOException

Builds a main memory database instance with the specified name.

Parameters:

name - name of database

parser - parser

Returns:

data database instance

Throws:

IOException - I/O exception

build

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

init

public MemBuilder init()

Initializes the builder.

Returns:

self reference

data

public Data data()

Returns the data reference.

Returns:

data reference

addDoc

protected void addDoc(byte[] value)

Description copied from class: Builder

Adds a document node to the database.

Specified by:

addDoc in class Builder

Parameters:

value - name of the document

addElem

protected void addElem(int dist,
                       int nameId,
                       int asize,
                       int uriId,
                       boolean ne)

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)

addAttr

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

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

addText

protected void addText(byte[] value,
                       int dist,
                       byte kind)

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

setSize

protected void setSize(int pre,
                       int size)

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