org.cdlib.xtf.textIndexer
Class IndexRecord

Object
  extended by IndexRecord

public abstract class IndexRecord
extends Object

A single record within a IndexSource. Note that many source files have only one record, and that's okay.

Author:
Martin Haye

Constructor Summary
IndexRecord()
           
 
Method Summary
abstract  StructuredStore lazyStore()
          Empty storage in which to build the persistent version of the record (aka the "lazy tree"), or null to avoid building it.
abstract  int percentDone()
          Estimate of how much of the whole IndexSource will have been completed when this record is complete.
abstract  int recordNum()
          Numeric index of this record (zero if this is the only record
abstract  InputSource xmlSource()
          Source to read XML data from
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IndexRecord

public IndexRecord()
Method Detail

xmlSource

public abstract InputSource xmlSource()
                               throws IOException
Source to read XML data from

Throws:
IOException

recordNum

public abstract int recordNum()
Numeric index of this record (zero if this is the only record


percentDone

public abstract int percentDone()
Estimate of how much of the whole IndexSource will have been completed when this record is complete.


lazyStore

public abstract StructuredStore lazyStore()
Empty storage in which to build the persistent version of the record (aka the "lazy tree"), or null to avoid building it.