IndexOrdinalsFieldData (elasticsearch-extend 3.2 API)

All Superinterfaces:

IndexComponent, IndexFieldData<AtomicOrdinalsFieldData>, IndexFieldData.Global<AtomicOrdinalsFieldData>

All Known Implementing Classes:

AbstractIndexOrdinalsFieldData, ConstantIndexFieldData, GlobalOrdinalsIndexFieldData, GlobalOrdinalsIndexFieldData.Consumer, PagedBytesIndexFieldData, SortedSetDVOrdinalsIndexFieldData
```
public interface IndexOrdinalsFieldData
extends IndexFieldData.Global<AtomicOrdinalsFieldData>
```
Specialization of IndexFieldData for data that is indexed with ordinals.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.elasticsearch.index.fielddata.IndexFieldData
  IndexFieldData.Builder, IndexFieldData.Global<FD extends AtomicFieldData>, IndexFieldData.XFieldComparatorSource

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`OrdinalMap`	`getOrdinalMap()`	Returns the underlying `OrdinalMap` for this fielddata or null if global ordinals are not needed (constant value or single segment).
`IndexOrdinalsFieldData`	`loadGlobal(DirectoryReader indexReader)`	Load a global view of the ordinals for the given `IndexReader`, potentially from a cache.
`IndexOrdinalsFieldData`	`localGlobalDirect(DirectoryReader indexReader)`	Load a global view of the ordinals for the given `IndexReader`.
`boolean`	`supportsGlobalOrdinalsMapping()`	Whether this field data is able to provide a mapping between global and segment ordinals, by returning the underlying `OrdinalMap`.

Methods inherited from interface org.elasticsearch.index.IndexComponent
index

Methods inherited from interface org.elasticsearch.index.fielddata.IndexFieldData
clear, getFieldName, load, loadDirect, sortField

- Method Detail
  - loadGlobal
```
IndexOrdinalsFieldData loadGlobal(DirectoryReader indexReader)
```
    Load a global view of the ordinals for the given IndexReader, potentially from a cache.
    
    Specified by:
    
    loadGlobal in interface IndexFieldData.Global<AtomicOrdinalsFieldData>
  - localGlobalDirect
```
IndexOrdinalsFieldData localGlobalDirect(DirectoryReader indexReader)
                                  throws Exception
```
    Load a global view of the ordinals for the given IndexReader.
    
    Specified by:
    
    localGlobalDirect in interface IndexFieldData.Global<AtomicOrdinalsFieldData>
    
    Throws:
    
    Exception
  - getOrdinalMap
```
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.