Interface IndexFieldData<FD extends LeafFieldData>
- 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
,IndexHistogramFieldData
,PagedBytesIndexFieldData
,SortedNumericDVIndexFieldData
,SortedSetDVOrdinalsIndexFieldData
public interface IndexFieldData<FD extends LeafFieldData> extends IndexComponent
Thread-safe utility class that allows to get per-segment values via the
load(LeafReaderContext)
method.-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
IndexFieldData.Builder
static interface
IndexFieldData.Global<FD extends LeafFieldData>
static class
IndexFieldData.XFieldComparatorSource
-
Method Summary
Modifier and Type Method Description void
clear()
Clears any resources associated with this field data.java.lang.String
getFieldName()
The field name.FD
load(org.apache.lucene.index.LeafReaderContext context)
Loads the atomic field data for the reader, possibly cached.FD
loadDirect(org.apache.lucene.index.LeafReaderContext context)
Loads directly the atomic field data for the reader, ignoring any caching involved.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 theSortField
to use for sorting.
-
Method Details
-
getFieldName
java.lang.String getFieldName()The field name. -
load
Loads the atomic field data for the reader, possibly cached. -
loadDirect
Loads directly the atomic field data for the reader, ignoring any caching involved.- Throws:
java.lang.Exception
-
sortField
org.apache.lucene.search.SortField sortField(@Nullable java.lang.Object missingValue, MultiValueMode sortMode, IndexFieldData.XFieldComparatorSource.Nested nested, boolean reverse)Returns theSortField
to use for sorting. -
newBucketedSort
BucketedSort newBucketedSort(BigArrays bigArrays, @Nullable 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. -
clear
void clear()Clears any resources associated with this field data.
-