Interface IndexOrdinalsFieldData
- All Superinterfaces:
IndexFieldData<LeafOrdinalsFieldData>
,IndexFieldData.Global<LeafOrdinalsFieldData>
- All Known Implementing Classes:
AbstractIndexOrdinalsFieldData
,ConstantIndexFieldData
,GlobalOrdinalsIndexFieldData
,GlobalOrdinalsIndexFieldData.Consumer
,PagedBytesIndexFieldData
,SortedSetOrdinalsIndexFieldData
public interface IndexOrdinalsFieldData extends IndexFieldData.Global<LeafOrdinalsFieldData>
Specialization of
IndexFieldData
for 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 LeafFieldData>, IndexFieldData.XFieldComparatorSource
-
Method Summary
Modifier and Type Method Description org.apache.lucene.index.OrdinalMap
getOrdinalMap()
Returns the underlyingOrdinalMap
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 givenIndexReader
, potentially from a cache.IndexOrdinalsFieldData
loadGlobalDirect(org.apache.lucene.index.DirectoryReader indexReader)
Load a global view of the ordinals for the givenIndexReader
.boolean
supportsGlobalOrdinalsMapping()
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.fielddata.IndexFieldData
getFieldName, getValuesSourceType, load, loadDirect, newBucketedSort, sortField
-
Method Details
-
loadGlobal
Load a global view of the ordinals for the givenIndexReader
, potentially from a cache.- Specified by:
loadGlobal
in interfaceIndexFieldData.Global<LeafOrdinalsFieldData>
-
loadGlobalDirect
IndexOrdinalsFieldData loadGlobalDirect(org.apache.lucene.index.DirectoryReader indexReader) throws java.lang.ExceptionLoad a global view of the ordinals for the givenIndexReader
.- Specified by:
loadGlobalDirect
in interfaceIndexFieldData.Global<LeafOrdinalsFieldData>
- Throws:
java.lang.Exception
-
getOrdinalMap
org.apache.lucene.index.OrdinalMap getOrdinalMap()Returns the underlyingOrdinalMap
for 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
.
-