Module org.apache.lucene.suggest

Package org.apache.lucene.search.suggest.document

Class CompletionFieldsProducer

java.lang.Object

org.apache.lucene.index.Fields

org.apache.lucene.codecs.FieldsProducer

org.apache.lucene.search.suggest.document.CompletionFieldsProducer

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<String>, Accountable

final class CompletionFieldsProducer
extends FieldsProducer
implements Accountable

Completion index (.cmp) is opened and read at instantiation to read in SuggestField numbers and their FST offsets in the Completion dictionary (.lkp).

Completion dictionary (.lkp) is opened at instantiation and a field's FST is loaded into memory the first time it is requested via terms(String).

NOTE: Only the footer is validated for Completion dictionary (.lkp) and not the checksum due to random access pattern and checksum validation being too costly at instantiation

Field Summary

Fields

Modifier and Type	Field	Description
private FieldsProducer	delegateFieldsProducer
private IndexInput	dictIn
private Map<String,CompletionsTermsReader>	readers

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

Modifier	Constructor	Description
(package private)	CompletionFieldsProducer(String codecName, SegmentReadState state, CompletionPostingsFormat.FSTLoadMode fstLoadMode)
private	CompletionFieldsProducer(FieldsProducer delegateFieldsProducer, Map<String,CompletionsTermsReader> readers)

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.
FieldsProducer	getMergeInstance()	Returns an instance optimized for merging.
Iterator<String>	iterator()	Returns an iterator that will step through all fields names.
long	ramBytesUsed()	Return the memory usage of this object in bytes.
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

delegateFieldsProducer

private FieldsProducer delegateFieldsProducer

readers

private Map<String,CompletionsTermsReader> readers

dictIn

private IndexInput dictIn

Constructor Details

CompletionFieldsProducer

private CompletionFieldsProducer(FieldsProducer delegateFieldsProducer,
 Map<String,CompletionsTermsReader> readers)

CompletionFieldsProducer

CompletionFieldsProducer(String codecName,
 SegmentReadState state,
 CompletionPostingsFormat.FSTLoadMode fstLoadMode)
                  throws IOException

Throws:

IOException

Method Details

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

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

getMergeInstance

public FieldsProducer getMergeInstance()

Description copied from class: FieldsProducer

Returns an instance optimized for merging. This instance may only be consumed in the thread that called FieldsProducer.getMergeInstance().

The default implementation returns this

Overrides:

getMergeInstance in class FieldsProducer

ramBytesUsed

public long ramBytesUsed()

Description copied from interface: Accountable

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

Specified by:

ramBytesUsed in interface Accountable

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).

Specified by:

getChildResources in interface Accountable

See Also:

• Accountables

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