Module org.apache.lucene.suggest

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

Class CompletionsTermsReader

java.lang.Object

org.apache.lucene.search.suggest.document.CompletionsTermsReader

All Implemented Interfaces:

Accountable

public final class CompletionsTermsReader
extends Object
implements Accountable

Holder for suggester and field-level info for a suggest field

Field Summary

Fields

Modifier and Type	Field	Description
private final IndexInput	dictIn
private final CompletionPostingsFormat.FSTLoadMode	fstLoadMode
final long	maxWeight	Maximum entry weight for the suggester
final long	minWeight	Minimum entry weight for the suggester
private final long	offset
private NRTSuggester	suggester
final byte	type	type of suggester (context-enabled or not)

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

NULL_ACCOUNTABLE

Constructor Summary

Constructors

Constructor	Description
CompletionsTermsReader(IndexInput dictIn, long offset, long minWeight, long maxWeight, byte type, CompletionPostingsFormat.FSTLoadMode fstLoadMode)	Creates a CompletionTermsReader to load a field-specific suggester from the index dictIn with offset

Method Summary

Modifier and Type	Method	Description
Collection<Accountable>	getChildResources()	Returns nested resources of this class.
long	ramBytesUsed()	Return the memory usage of this object in bytes.
NRTSuggester	suggester()	Returns the suggester for a field, if not loaded already, loads the appropriate suggester from CompletionDictionary

Methods inherited from class java.lang.Object

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

Field Details

minWeight

public final long minWeight

Minimum entry weight for the suggester

maxWeight

public final long maxWeight

Maximum entry weight for the suggester

type

public final byte type

type of suggester (context-enabled or not)

dictIn

private final IndexInput dictIn

offset

private final long offset

fstLoadMode

private final CompletionPostingsFormat.FSTLoadMode fstLoadMode

suggester

private NRTSuggester suggester

Constructor Details

CompletionsTermsReader

CompletionsTermsReader(IndexInput dictIn,
 long offset,
 long minWeight,
 long maxWeight,
 byte type,
 CompletionPostingsFormat.FSTLoadMode fstLoadMode)

Creates a CompletionTermsReader to load a field-specific suggester from the index dictIn with offset

Method Details

suggester

public NRTSuggester suggester()
                       throws IOException

Returns the suggester for a field, if not loaded already, loads the appropriate suggester from CompletionDictionary

Throws:

IOException

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