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, IndexHistogramFieldData, PagedBytesIndexFieldData, SortedNumericDVIndexFieldData, SortedSetDVOrdinalsIndexFieldData

public interface IndexFieldData<FD extends AtomicFieldData>
extends IndexComponent
Thread-safe utility class that allows to get per-segment values via the load(LeafReaderContext) method.
  • Method Details

    • getFieldName

      java.lang.String getFieldName()
      The field name.
    • load

      FD load​(org.apache.lucene.index.LeafReaderContext context)
      Loads the atomic field data for the reader, possibly cached.
    • loadDirect

      FD loadDirect​(org.apache.lucene.index.LeafReaderContext context) throws java.lang.Exception
      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 the SortField to use for sorting.
    • clear

      void clear()
      Clears any resources associated with this field data.