Package org.elasticsearch.index.fielddata.plain

Class AbstractIndexOrdinalsFieldData

java.lang.Object

org.elasticsearch.index.AbstractIndexComponent

org.elasticsearch.index.fielddata.plain.AbstractIndexFieldData<AtomicOrdinalsFieldData>

org.elasticsearch.index.fielddata.plain.AbstractIndexOrdinalsFieldData

All Implemented Interfaces:

IndexFieldData<AtomicOrdinalsFieldData>, IndexFieldData.Global<AtomicOrdinalsFieldData>, IndexOrdinalsFieldData, IndexComponent

Direct Known Subclasses:

ConstantIndexFieldData, PagedBytesIndexFieldData

public abstract class AbstractIndexOrdinalsFieldData
extends AbstractIndexFieldData<AtomicOrdinalsFieldData>
implements IndexOrdinalsFieldData

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.index.fielddata.plain.AbstractIndexFieldData

AbstractIndexFieldData.PerValueEstimator

Nested classes/interfaces inherited from interface org.elasticsearch.index.fielddata.IndexFieldData

IndexFieldData.Builder, IndexFieldData.Global<FD extends AtomicFieldData>, IndexFieldData.XFieldComparatorSource

Field Summary

Fields

Modifier and Type	Field	Description
protected CircuitBreakerService	breakerService

Fields inherited from class org.elasticsearch.index.fielddata.plain.AbstractIndexFieldData

cache

Fields inherited from class org.elasticsearch.index.AbstractIndexComponent

deprecationLogger, indexSettings, logger

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractIndexOrdinalsFieldData(IndexSettings indexSettings, java.lang.String fieldName, IndexFieldDataCache cache, CircuitBreakerService breakerService, double minFrequency, double maxFrequency, int minSegmentSize)

Method Summary

Modifier and Type	Method	Description
protected AtomicOrdinalsFieldData	empty(int maxDoc)
protected org.apache.lucene.index.TermsEnum	filter(org.apache.lucene.index.Terms terms, org.apache.lucene.index.TermsEnum iterator, org.apache.lucene.index.LeafReader reader)
org.apache.lucene.index.OrdinalMap	getOrdinalMap()	Returns the underlying OrdinalMap for this fielddata or null if global ordinals are not needed (constant value or single segment).
IndexOrdinalsFieldData	loadGlobal(org.apache.lucene.index.DirectoryReader indexReader)	Load a global view of the ordinals for the given IndexReader, potentially from a cache.
IndexOrdinalsFieldData	localGlobalDirect(org.apache.lucene.index.DirectoryReader indexReader)	Load a global view of the ordinals for the given IndexReader.
boolean	supportsGlobalOrdinalsMapping()	Whether this field data is able to provide a mapping between global and segment ordinals, by returning the underlying OrdinalMap.

Methods inherited from class org.elasticsearch.index.fielddata.plain.AbstractIndexFieldData

clear, getFieldName, load

Methods inherited from class org.elasticsearch.index.AbstractIndexComponent

getIndexSettings, index

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.index.IndexComponent

index

Methods inherited from interface org.elasticsearch.index.fielddata.IndexFieldData

clear, getFieldName, load, loadDirect, sortField

Field Details

breakerService

protected final CircuitBreakerService breakerService

Constructor Details

AbstractIndexOrdinalsFieldData

protected AbstractIndexOrdinalsFieldData(IndexSettings indexSettings, java.lang.String fieldName, IndexFieldDataCache cache, CircuitBreakerService breakerService, double minFrequency, double maxFrequency, int minSegmentSize)

Method Details

getOrdinalMap

public org.apache.lucene.index.OrdinalMap getOrdinalMap()

Description copied from interface: IndexOrdinalsFieldData

Returns the underlying OrdinalMap for this fielddata or null if global ordinals are not needed (constant value or single segment).

Specified by:

getOrdinalMap in interface IndexOrdinalsFieldData

loadGlobal

public IndexOrdinalsFieldData loadGlobal(org.apache.lucene.index.DirectoryReader indexReader)

Description copied from interface: IndexOrdinalsFieldData

Load a global view of the ordinals for the given IndexReader, potentially from a cache.

Specified by:

loadGlobal in interface IndexFieldData.Global<AtomicOrdinalsFieldData>

Specified by:

loadGlobal in interface IndexOrdinalsFieldData

localGlobalDirect

public IndexOrdinalsFieldData localGlobalDirect(org.apache.lucene.index.DirectoryReader indexReader) throws java.lang.Exception

Description copied from interface: IndexOrdinalsFieldData

Load a global view of the ordinals for the given IndexReader.

Specified by:

localGlobalDirect in interface IndexFieldData.Global<AtomicOrdinalsFieldData>

Specified by:

localGlobalDirect in interface IndexOrdinalsFieldData

Throws:

java.lang.Exception

empty

protected AtomicOrdinalsFieldData empty(int maxDoc)

Specified by:

empty in class AbstractIndexFieldData<AtomicOrdinalsFieldData>

Parameters:

maxDoc - of the current reader

Returns:

an empty field data instances for field data lookups of empty segments (returning no values)

filter

protected org.apache.lucene.index.TermsEnum filter(org.apache.lucene.index.Terms terms, org.apache.lucene.index.TermsEnum iterator, org.apache.lucene.index.LeafReader reader) throws java.io.IOException

Throws:

java.io.IOException

supportsGlobalOrdinalsMapping

public boolean supportsGlobalOrdinalsMapping()

Description copied from interface: IndexOrdinalsFieldData

Whether this field data is able to provide a mapping between global and segment ordinals, by returning the underlying OrdinalMap. If this method returns false, then calling IndexOrdinalsFieldData.getOrdinalMap() will result in an UnsupportedOperationException.

Specified by:

supportsGlobalOrdinalsMapping in interface IndexOrdinalsFieldData