org.basex.index
Class IndexBuilder

java.lang.Object
  extended by org.basex.core.Progress
      extended by org.basex.index.IndexBuilder
Direct Known Subclasses:
FTBuilder, PathBuilder, ValueBuilder

public abstract class IndexBuilder
extends Progress

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

Author:
Workgroup DBIS, University of Konstanz 2005-10, ISC License, Christian Gruen

Method Summary
abstract  Index build()
          Builds the index structure and returns an index instance.
 double prog()
          Returns progress information.
 String tit()
          Returns short information on this process.
 
Methods inherited from class org.basex.core.Progress
abort, checkStop, det, detail, progress, progress, stop, title
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

build

public abstract Index build()
                     throws IOException
Builds the index structure and returns an index instance.

Returns:
index instance
Throws:
IOException - IO Exception

tit

public final 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 progress information. Can be overwritten to give more detailed information.

Overrides:
prog in class Progress
Returns:
header information