org.apache.lucene.codecs.blockterms

Class TermsIndexReaderBase

java.lang.Object

org.apache.lucene.codecs.blockterms.TermsIndexReaderBase

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

FixedGapTermsIndexReader, VariableGapTermsIndexReader

public abstract class TermsIndexReaderBase
extends java.lang.Object
implements java.io.Closeable

BlockTermsReader interacts with an instance of this class to manage its terms index. The writer must accept indexed terms (many pairs of BytesRef text + long fileOffset), and then this reader must be able to retrieve the nearest index term to a provided term text.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TermsIndexReaderBase.FieldIndexEnum Similar to TermsEnum, except, the only "metadata" it reports for a given indexed term is the long fileOffset into the main terms dictionary file.

Constructor Summary

Constructors

Constructor and Description
TermsIndexReaderBase()

Method Summary

Modifier and Type	Method and Description
abstract void	close()
abstract TermsIndexReaderBase.FieldIndexEnum	getFieldEnum(FieldInfo fieldInfo)
abstract boolean	supportsOrd()

Methods inherited from class java.lang.Object

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

Constructor Detail

TermsIndexReaderBase

public TermsIndexReaderBase()

Method Detail

getFieldEnum

public abstract TermsIndexReaderBase.FieldIndexEnum getFieldEnum(FieldInfo fieldInfo)

close

public abstract void close()
                    throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

supportsOrd

public abstract boolean supportsOrd()