Package org.elasticsearch.index.fielddata.plain

Class SortedSetOrdinalsIndexFieldData

java.lang.Object

org.elasticsearch.index.fielddata.plain.SortedSetOrdinalsIndexFieldData

All Implemented Interfaces:

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

public class SortedSetOrdinalsIndexFieldData
extends java.lang.Object
implements IndexOrdinalsFieldData

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SortedSetOrdinalsIndexFieldData.Builder

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

IndexFieldData.Global<FD extends LeafFieldData>, IndexFieldData.XFieldComparatorSource

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	fieldName
protected Index	index

Constructor Summary

Constructors

Constructor	Description
SortedSetOrdinalsIndexFieldData(IndexSettings indexSettings, IndexFieldDataCache cache, java.lang.String fieldName, ValuesSourceType valuesSourceType, CircuitBreakerService breakerService, java.util.function.Function<org.apache.lucene.index.SortedSetDocValues,ScriptDocValues<?>> scriptFunction)

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears any resources associated with this field data.
java.lang.String	getFieldName()	The field name.
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).
ValuesSourceType	getValuesSourceType()	The ValuesSourceType of the underlying data.
Index	index()
LeafOrdinalsFieldData	load(org.apache.lucene.index.LeafReaderContext context)	Loads the atomic field data for the reader, possibly cached.
LeafOrdinalsFieldData	loadDirect(org.apache.lucene.index.LeafReaderContext context)	Loads directly the atomic field data for the reader, ignoring any caching involved.
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.
BucketedSort	newBucketedSort(BigArrays bigArrays, java.lang.Object missingValue, MultiValueMode sortMode, IndexFieldData.XFieldComparatorSource.Nested nested, SortOrder sortOrder, DocValueFormat format, int bucketSize, BucketedSort.ExtraData extra)	Build a sort implementation specialized for aggregations.
org.apache.lucene.search.SortField	sortField(java.lang.Object missingValue, MultiValueMode sortMode, IndexFieldData.XFieldComparatorSource.Nested nested, boolean reverse)	Returns the SortField to use for sorting.
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 java.lang.Object

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

Field Details

index

protected final Index index

fieldName

protected final java.lang.String fieldName

Constructor Details

SortedSetOrdinalsIndexFieldData

public SortedSetOrdinalsIndexFieldData(IndexSettings indexSettings, IndexFieldDataCache cache, java.lang.String fieldName, ValuesSourceType valuesSourceType, CircuitBreakerService breakerService, java.util.function.Function<org.apache.lucene.index.SortedSetDocValues,ScriptDocValues<?>> scriptFunction)

Method Details

getFieldName

public final java.lang.String getFieldName()

Description copied from interface: IndexFieldData

The field name.

Specified by:

getFieldName in interface IndexFieldData<LeafOrdinalsFieldData>

getValuesSourceType

public ValuesSourceType getValuesSourceType()

Description copied from interface: IndexFieldData

The ValuesSourceType of the underlying data. It's possible for fields that use the same IndexFieldData implementation to have different ValuesSourceTypes, such as in the case of Longs and Dates.

Specified by:

getValuesSourceType in interface IndexFieldData<LeafOrdinalsFieldData>

clear

public final void clear()

Description copied from interface: IndexFieldData

Clears any resources associated with this field data.

Specified by:

clear in interface IndexFieldData<LeafOrdinalsFieldData>

index

public final Index index()

Specified by:

index in interface IndexComponent

sortField

public org.apache.lucene.search.SortField sortField(@Nullable java.lang.Object missingValue, MultiValueMode sortMode, IndexFieldData.XFieldComparatorSource.Nested nested, boolean reverse)

Description copied from interface: IndexFieldData

Returns the SortField to use for sorting.

Specified by:

sortField in interface IndexFieldData<LeafOrdinalsFieldData>

newBucketedSort

public BucketedSort newBucketedSort(BigArrays bigArrays, java.lang.Object missingValue, MultiValueMode sortMode, IndexFieldData.XFieldComparatorSource.Nested nested, SortOrder sortOrder, DocValueFormat format, int bucketSize, BucketedSort.ExtraData extra)

Description copied from interface: IndexFieldData

Build a sort implementation specialized for aggregations.

Specified by:

newBucketedSort in interface IndexFieldData<LeafOrdinalsFieldData>

load

public LeafOrdinalsFieldData load(org.apache.lucene.index.LeafReaderContext context)

Description copied from interface: IndexFieldData

Loads the atomic field data for the reader, possibly cached.

Specified by:

load in interface IndexFieldData<LeafOrdinalsFieldData>

loadDirect

public LeafOrdinalsFieldData loadDirect(org.apache.lucene.index.LeafReaderContext context) throws java.lang.Exception

Description copied from interface: IndexFieldData

Loads directly the atomic field data for the reader, ignoring any caching involved.

Specified by:

loadDirect in interface IndexFieldData<LeafOrdinalsFieldData>

Throws:

java.lang.Exception

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<LeafOrdinalsFieldData>

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<LeafOrdinalsFieldData>

Specified by:

localGlobalDirect in interface IndexOrdinalsFieldData

Throws:

java.lang.Exception

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

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