Interface IndexOrdinalsFieldData
-
- All Superinterfaces:
IndexComponent,IndexFieldData<AtomicOrdinalsFieldData>,IndexFieldData.Global<AtomicOrdinalsFieldData>
- All Known Implementing Classes:
AbstractIndexOrdinalsFieldData,ConstantIndexFieldData,GlobalOrdinalsIndexFieldData,GlobalOrdinalsIndexFieldData.Consumer,PagedBytesIndexFieldData,SortedSetDVOrdinalsIndexFieldData
public interface IndexOrdinalsFieldData extends IndexFieldData.Global<AtomicOrdinalsFieldData>
Specialization ofIndexFieldDatafor data that is indexed with ordinals.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.elasticsearch.index.fielddata.IndexFieldData
IndexFieldData.Builder, IndexFieldData.Global<FD extends AtomicFieldData>, IndexFieldData.XFieldComparatorSource
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description OrdinalMapgetOrdinalMap()Returns the underlyingOrdinalMapfor this fielddata or null if global ordinals are not needed (constant value or single segment).IndexOrdinalsFieldDataloadGlobal(DirectoryReader indexReader)Load a global view of the ordinals for the givenIndexReader, potentially from a cache.IndexOrdinalsFieldDatalocalGlobalDirect(DirectoryReader indexReader)Load a global view of the ordinals for the givenIndexReader.booleansupportsGlobalOrdinalsMapping()Whether this field data is able to provide a mapping between global and segment ordinals, by returning the underlyingOrdinalMap.-
Methods inherited from interface org.elasticsearch.index.IndexComponent
index
-
Methods inherited from interface org.elasticsearch.index.fielddata.IndexFieldData
clear, getFieldName, load, loadDirect, sortField
-
-
-
-
Method Detail
-
loadGlobal
IndexOrdinalsFieldData loadGlobal(DirectoryReader indexReader)
Load a global view of the ordinals for the givenIndexReader, potentially from a cache.- Specified by:
loadGlobalin interfaceIndexFieldData.Global<AtomicOrdinalsFieldData>
-
localGlobalDirect
IndexOrdinalsFieldData localGlobalDirect(DirectoryReader indexReader) throws Exception
Load a global view of the ordinals for the givenIndexReader.- Specified by:
localGlobalDirectin interfaceIndexFieldData.Global<AtomicOrdinalsFieldData>- Throws:
Exception
-
getOrdinalMap
OrdinalMap getOrdinalMap()
Returns the underlyingOrdinalMapfor this fielddata or null if global ordinals are not needed (constant value or single segment).
-
supportsGlobalOrdinalsMapping
boolean supportsGlobalOrdinalsMapping()
Whether this field data is able to provide a mapping between global and segment ordinals, by returning the underlyingOrdinalMap. If this method returns false, then callinggetOrdinalMap()will result in anUnsupportedOperationException.
-
-