Class GlobalOrdinalsIndexFieldData
- java.lang.Object
-
- org.elasticsearch.index.AbstractIndexComponent
-
- org.elasticsearch.index.fielddata.ordinals.GlobalOrdinalsIndexFieldData
-
- All Implemented Interfaces:
org.apache.lucene.util.Accountable
,IndexFieldData<AtomicOrdinalsFieldData>
,IndexFieldData.Global<AtomicOrdinalsFieldData>
,IndexOrdinalsFieldData
,IndexComponent
public class GlobalOrdinalsIndexFieldData extends AbstractIndexComponent implements IndexOrdinalsFieldData, org.apache.lucene.util.Accountable
IndexFieldData
base class for concrete global ordinals implementations.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.elasticsearch.index.fielddata.IndexFieldData
IndexFieldData.Builder, IndexFieldData.CommonSettings, IndexFieldData.Global<FD extends AtomicFieldData>, IndexFieldData.XFieldComparatorSource
-
-
Field Summary
-
Fields inherited from class org.elasticsearch.index.AbstractIndexComponent
deprecationLogger, indexSettings, logger
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
GlobalOrdinalsIndexFieldData(IndexSettings indexSettings, java.lang.String fieldName, AtomicOrdinalsFieldData[] segmentAfd, org.apache.lucene.index.OrdinalMap ordinalMap, long memorySizeInBytes, java.util.function.Function<org.apache.lucene.index.SortedSetDocValues,ScriptDocValues<?>> scriptFunction)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear()
Clears any resources associated with this field data.java.util.Collection<org.apache.lucene.util.Accountable>
getChildResources()
java.lang.String
getFieldName()
The field name.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).AtomicOrdinalsFieldData
load(org.apache.lucene.index.LeafReaderContext context)
Loads the atomic field data for the reader, possibly cached.AtomicOrdinalsFieldData
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 givenIndexReader
, potentially from a cache.IndexOrdinalsFieldData
localGlobalDirect(org.apache.lucene.index.DirectoryReader indexReader)
Load a global view of the ordinals for the givenIndexReader
.long
ramBytesUsed()
org.apache.lucene.search.SortField
sortField(java.lang.Object missingValue, MultiValueMode sortMode, IndexFieldData.XFieldComparatorSource.Nested nested, boolean reverse)
Returns theSortField
to used for sorting.-
Methods inherited from class org.elasticsearch.index.AbstractIndexComponent
getIndexSettings, index
-
Methods inherited from interface org.elasticsearch.index.IndexComponent
index
-
-
-
-
Constructor Detail
-
GlobalOrdinalsIndexFieldData
protected GlobalOrdinalsIndexFieldData(IndexSettings indexSettings, java.lang.String fieldName, AtomicOrdinalsFieldData[] segmentAfd, org.apache.lucene.index.OrdinalMap ordinalMap, long memorySizeInBytes, java.util.function.Function<org.apache.lucene.index.SortedSetDocValues,ScriptDocValues<?>> scriptFunction)
-
-
Method Detail
-
loadDirect
public AtomicOrdinalsFieldData 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 interfaceIndexFieldData<AtomicOrdinalsFieldData>
- 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 givenIndexReader
, potentially from a cache.- Specified by:
loadGlobal
in interfaceIndexFieldData.Global<AtomicOrdinalsFieldData>
- Specified by:
loadGlobal
in interfaceIndexOrdinalsFieldData
-
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 givenIndexReader
.- Specified by:
localGlobalDirect
in interfaceIndexFieldData.Global<AtomicOrdinalsFieldData>
- Specified by:
localGlobalDirect
in interfaceIndexOrdinalsFieldData
- Throws:
java.lang.Exception
-
getFieldName
public java.lang.String getFieldName()
Description copied from interface:IndexFieldData
The field name.- Specified by:
getFieldName
in interfaceIndexFieldData<AtomicOrdinalsFieldData>
-
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 theSortField
to used for sorting.- Specified by:
sortField
in interfaceIndexFieldData<AtomicOrdinalsFieldData>
-
clear
public void clear()
Description copied from interface:IndexFieldData
Clears any resources associated with this field data.- Specified by:
clear
in interfaceIndexFieldData<AtomicOrdinalsFieldData>
-
ramBytesUsed
public long ramBytesUsed()
- Specified by:
ramBytesUsed
in interfaceorg.apache.lucene.util.Accountable
-
getChildResources
public java.util.Collection<org.apache.lucene.util.Accountable> getChildResources()
- Specified by:
getChildResources
in interfaceorg.apache.lucene.util.Accountable
-
load
public AtomicOrdinalsFieldData 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 interfaceIndexFieldData<AtomicOrdinalsFieldData>
-
getOrdinalMap
public org.apache.lucene.index.OrdinalMap getOrdinalMap()
Description copied from interface:IndexOrdinalsFieldData
Returns the underlyingOrdinalMap
for this fielddata or null if global ordinals are not needed (constant value or single segment).- Specified by:
getOrdinalMap
in interfaceIndexOrdinalsFieldData
-
-