org.basex.index

Class IndexBuilder

java.lang.Object

org.basex.core.Progress

org.basex.index.IndexBuilder

Direct Known Subclasses:

FTBuilder, ValueBuilder

public abstract class IndexBuilder
extends Progress

This interface defines the functions which are needed for building new index structures.

Author:

BaseX Team 2005-12, BSD License, Christian Gruen

Field Summary

Fields

Modifier and Type	Field and Description
protected int	csize Number of cached index structures.
protected Data	data Data reference.
protected boolean	merge Merge flag.
protected int	pre Current parsing value.
protected int	size Total parsing value.

Fields inherited from class org.basex.core.Progress

updating

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IndexBuilder(Data d) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
abstract Index	build() Builds the index structure and returns an index instance.
protected void	check() Checks if the command was interrupted, and prints some debug output.
protected boolean	memFull() Checks if enough memory is left to continue index building.
double	prog() Returns a progress value (0 - 1).
java.lang.String	tit() Returns short information on this process.

Methods inherited from class org.basex.core.Progress

abort, checkStop, det, 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

Field Detail

data

protected final Data data

Data reference.

size

protected final int size

Total parsing value.

pre

protected int pre

Current parsing value.

merge

protected boolean merge

Merge flag.

csize

protected int csize

Number of cached index structures.

Constructor Detail

IndexBuilder

protected IndexBuilder(Data d)

Constructor.

Parameters:

d - reference

Method Detail

build

public abstract Index build()
                     throws java.io.IOException

Builds the index structure and returns an index instance.

Returns:

index instance

Throws:

java.io.IOException - I/O Exception

check

protected final void check()

Checks if the command was interrupted, and prints some debug output.

memFull

protected final boolean memFull()
                         throws java.io.IOException

Checks if enough memory is left to continue index building.

Returns:

result of check

Throws:

java.io.IOException - I/O exception

tit

public final java.lang.String tit()

Description copied from class: Progress

Returns short information on this process. Can be overwritten to give more detailed information.

Overrides:

tit in class Progress

Returns:

header information

prog

public final double prog()

Description copied from class: Progress

Returns a progress value (0 - 1). Can be overwritten to give more detailed information.

Overrides:

prog in class Progress

Returns:

header information