Class ValuesSource.Bytes.WithOrdinals
java.lang.Object
org.opensearch.search.aggregations.support.ValuesSource
org.opensearch.search.aggregations.support.ValuesSource.Bytes
org.opensearch.search.aggregations.support.ValuesSource.Bytes.WithOrdinals
- Direct Known Subclasses:
ValuesSource.Bytes.WithOrdinals.FieldData
- Enclosing class:
- ValuesSource.Bytes
public abstract static class ValuesSource.Bytes.WithOrdinals extends ValuesSource.Bytes
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ValuesSource.Bytes.WithOrdinals.FieldData
Nested classes/interfaces inherited from class org.opensearch.search.aggregations.support.ValuesSource.Bytes
ValuesSource.Bytes.Script, ValuesSource.Bytes.WithOrdinals, ValuesSource.Bytes.WithScript
Nested classes/interfaces inherited from class org.opensearch.search.aggregations.support.ValuesSource
ValuesSource.Bytes, ValuesSource.GeoPoint, ValuesSource.Numeric, ValuesSource.Range
-
Field Summary
Fields Modifier and Type Field Description static ValuesSource.Bytes.WithOrdinals
EMPTY
-
Constructor Summary
Constructors Constructor Description WithOrdinals()
-
Method Summary
Modifier and Type Method Description DocValueBits
docsWithValue(org.apache.lucene.index.LeafReaderContext context)
long
globalMaxOrd(org.apache.lucene.search.IndexSearcher indexSearcher)
abstract java.util.function.LongUnaryOperator
globalOrdinalsMapping(org.apache.lucene.index.LeafReaderContext context)
Returns a mapping from segment ordinals to global ordinals.abstract org.apache.lucene.index.SortedSetDocValues
globalOrdinalsValues(org.apache.lucene.index.LeafReaderContext context)
boolean
hasGlobalOrdinals()
Check if this values source supports using global ordinalsabstract org.apache.lucene.index.SortedSetDocValues
ordinalsValues(org.apache.lucene.index.LeafReaderContext context)
boolean
supportsGlobalOrdinalsMapping()
Whether this values source is able to provide a mapping between global and segment ordinals, by returning the underlyingOrdinalMap
.Methods inherited from class org.opensearch.search.aggregations.support.ValuesSource.Bytes
roundingPreparer
Methods inherited from class org.opensearch.search.aggregations.support.ValuesSource
bytesValues, needsScores
-
Field Details
-
Constructor Details
-
WithOrdinals
public WithOrdinals()
-
-
Method Details
-
docsWithValue
public DocValueBits docsWithValue(org.apache.lucene.index.LeafReaderContext context) throws java.io.IOException- Overrides:
docsWithValue
in classValuesSource.Bytes
- Throws:
java.io.IOException
-
ordinalsValues
public abstract org.apache.lucene.index.SortedSetDocValues ordinalsValues(org.apache.lucene.index.LeafReaderContext context) throws java.io.IOException- Throws:
java.io.IOException
-
globalOrdinalsValues
public abstract org.apache.lucene.index.SortedSetDocValues globalOrdinalsValues(org.apache.lucene.index.LeafReaderContext context) throws java.io.IOException- Throws:
java.io.IOException
-
supportsGlobalOrdinalsMapping
public boolean supportsGlobalOrdinalsMapping()Whether this values source is able to provide a mapping between global and segment ordinals, by returning the underlyingOrdinalMap
. If this method returns false, then callingglobalOrdinalsMapping(org.apache.lucene.index.LeafReaderContext)
will result in anUnsupportedOperationException
. -
hasGlobalOrdinals
public boolean hasGlobalOrdinals()Description copied from class:ValuesSource
Check if this values source supports using global ordinals- Overrides:
hasGlobalOrdinals
in classValuesSource
-
globalOrdinalsMapping
public abstract java.util.function.LongUnaryOperator globalOrdinalsMapping(org.apache.lucene.index.LeafReaderContext context) throws java.io.IOExceptionReturns a mapping from segment ordinals to global ordinals.- Throws:
java.io.IOException
-
globalMaxOrd
public long globalMaxOrd(org.apache.lucene.search.IndexSearcher indexSearcher) throws java.io.IOException- Throws:
java.io.IOException
-