Interface IndexOrdinalsFieldData

All Superinterfaces:
IndexFieldData<LeafOrdinalsFieldData>, IndexFieldData.Global<LeafOrdinalsFieldData>
All Known Implementing Classes:
AbstractIndexOrdinalsFieldData, ConstantIndexFieldData, FlattenedFieldMapper.KeyedFlattenedFieldData, GlobalOrdinalsIndexFieldData, GlobalOrdinalsIndexFieldData.Consumer, PagedBytesIndexFieldData, SortedSetOrdinalsIndexFieldData

public interface IndexOrdinalsFieldData extends IndexFieldData.Global<LeafOrdinalsFieldData>
Specialization of IndexFieldData for data that is indexed with ordinals.
  • Method Details

    • loadGlobal

      IndexOrdinalsFieldData loadGlobal(org.apache.lucene.index.DirectoryReader indexReader)
      Load a global view of the ordinals for the given IndexReader, potentially from a cache.
      Specified by:
      loadGlobal in interface IndexFieldData.Global<LeafOrdinalsFieldData>
    • loadGlobalDirect

      IndexOrdinalsFieldData loadGlobalDirect(org.apache.lucene.index.DirectoryReader indexReader) throws Exception
      Load a global view of the ordinals for the given IndexReader.
      Specified by:
      loadGlobalDirect in interface IndexFieldData.Global<LeafOrdinalsFieldData>
      Throws:
      Exception
    • getOrdinalMap

      org.apache.lucene.index.OrdinalMap getOrdinalMap()
      Returns the underlying OrdinalMap 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 underlying OrdinalMap. If this method returns false, then calling getOrdinalMap() will result in an UnsupportedOperationException.