Package org.apache.lucene.codecs.blockterms

Class BlockTermsReader

java.lang.Object

org.apache.lucene.index.Fields

org.apache.lucene.codecs.FieldsProducer

org.apache.lucene.codecs.blockterms.BlockTermsReader

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<String>, Accountable

public class BlockTermsReader
extends FieldsProducer

Handles a terms dict, but decouples all details of doc/freqs/positions reading to an instance of PostingsReaderBase. This class is reusable for codecs that use a different format for docs/freqs/positions (though codecs are also free to make their own terms dict impl).

This class also interacts with an instance of TermsIndexReaderBase, to abstract away the specific implementation of the terms dict index.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	BlockTermsReader.FieldAndTerm
private class	BlockTermsReader.FieldReader

Field Summary

Fields

Modifier and Type	Field	Description
private static final long	BASE_RAM_BYTES_USED
private static final long	FIELD_READER_RAM_BYTES_USED
private final TreeMap<String,BlockTermsReader.FieldReader>	fields
private final IndexInput	in
private TermsIndexReaderBase	indexReader
private final PostingsReaderBase	postingsReader

Fields inherited from class org.apache.lucene.index.Fields

EMPTY_ARRAY

Fields inherited from interface org.apache.lucene.util.Accountable

NULL_ACCOUNTABLE

Constructor Summary

Constructors

Constructor	Description
BlockTermsReader(TermsIndexReaderBase indexReader, PostingsReaderBase postingsReader, SegmentReadState state)

Method Summary

Modifier and Type	Method	Description
void	checkIntegrity()	Checks consistency of this reader.
void	close()
Collection<Accountable>	getChildResources()	Returns nested resources of this class.
Iterator<String>	iterator()	Returns an iterator that will step through all fields names.
long	ramBytesUsed()	Return the memory usage of this object in bytes.
private void	seekDir(IndexInput input)
int	size()	Returns the number of fields or -1 if the number of distinct field names is unknown.
Terms	terms(String field)	Get the Terms for this field.
String	toString()

Methods inherited from class org.apache.lucene.codecs.FieldsProducer

getMergeInstance

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

BASE_RAM_BYTES_USED

private static final long BASE_RAM_BYTES_USED

in

private final IndexInput in

postingsReader

private final PostingsReaderBase postingsReader

fields

private final TreeMap<String,BlockTermsReader.FieldReader> fields

indexReader

private TermsIndexReaderBase indexReader

FIELD_READER_RAM_BYTES_USED

private static final long FIELD_READER_RAM_BYTES_USED

Constructor Details

BlockTermsReader

public BlockTermsReader(TermsIndexReaderBase indexReader,
 PostingsReaderBase postingsReader,
 SegmentReadState state)
                 throws IOException

Throws:

IOException

Method Details

seekDir

private void seekDir(IndexInput input)
              throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class FieldsProducer

Throws:

IOException

iterator

public Iterator<String> iterator()

Description copied from class: Fields

Returns an iterator that will step through all fields names. This will not return null.

Specified by:

iterator in interface Iterable<String>

Specified by:

iterator in class Fields

terms

public Terms terms(String field)
            throws IOException

Description copied from class: Fields

Get the Terms for this field. This will return null if the field does not exist.

Specified by:

terms in class Fields

Throws:

IOException

size

public int size()

Description copied from class: Fields

Returns the number of fields or -1 if the number of distinct field names is unknown. If >= 0, Fields.iterator() will return as many field names.

Specified by:

size in class Fields

ramBytesUsed

public long ramBytesUsed()

Description copied from interface: Accountable

Return the memory usage of this object in bytes. Negative values are illegal.

getChildResources

public Collection<Accountable> getChildResources()

Description copied from interface: Accountable

Returns nested resources of this class. The result should be a point-in-time snapshot (to avoid race conditions).

See Also:

• Accountables

toString

public String toString()

Overrides:

toString in class Object

checkIntegrity

public void checkIntegrity()
                    throws IOException

Description copied from class: FieldsProducer

Checks consistency of this reader.

Note that this may be costly in terms of I/O, e.g. may involve computing a checksum value against large data files.

Specified by:

checkIntegrity in class FieldsProducer

Throws:

IOException