Interface IndexFieldData<FD extends AtomicFieldData>
-
- All Superinterfaces:
IndexComponent
- All Known Subinterfaces:
IndexFieldData.Global<FD>,IndexGeoPointFieldData,IndexNumericFieldData,IndexOrdinalsFieldData
- All Known Implementing Classes:
AbstractIndexFieldData,AbstractIndexOrdinalsFieldData,AbstractLatLonPointDVIndexFieldData,AbstractLatLonPointDVIndexFieldData.LatLonPointDVIndexFieldData,BinaryDVIndexFieldData,BytesBinaryDVIndexFieldData,ConstantIndexFieldData,GlobalOrdinalsIndexFieldData,GlobalOrdinalsIndexFieldData.Consumer,PagedBytesIndexFieldData,SortedNumericDVIndexFieldData,SortedSetDVOrdinalsIndexFieldData
public interface IndexFieldData<FD extends AtomicFieldData> extends IndexComponent
Thread-safe utility class that allows to get per-segment values via theload(LeafReaderContext)method.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interfaceIndexFieldData.Builderstatic interfaceIndexFieldData.Global<FD extends AtomicFieldData>static classIndexFieldData.XFieldComparatorSource
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidclear()Clears any resources associated with this field data.StringgetFieldName()The field name.FDload(LeafReaderContext context)Loads the atomic field data for the reader, possibly cached.FDloadDirect(LeafReaderContext context)Loads directly the atomic field data for the reader, ignoring any caching involved.SortFieldsortField(Object missingValue, MultiValueMode sortMode, IndexFieldData.XFieldComparatorSource.Nested nested, boolean reverse)Returns theSortFieldto use for sorting.-
Methods inherited from interface org.elasticsearch.index.IndexComponent
index
-
-
-
-
Method Detail
-
getFieldName
String getFieldName()
The field name.
-
load
FD load(LeafReaderContext context)
Loads the atomic field data for the reader, possibly cached.
-
loadDirect
FD loadDirect(LeafReaderContext context) throws Exception
Loads directly the atomic field data for the reader, ignoring any caching involved.- Throws:
Exception
-
sortField
SortField sortField(@Nullable Object missingValue, MultiValueMode sortMode, IndexFieldData.XFieldComparatorSource.Nested nested, boolean reverse)
Returns theSortFieldto use for sorting.
-
clear
void clear()
Clears any resources associated with this field data.
-
-