Package org.apache.lucene.facet
Class MultiDoubleValues
- java.lang.Object
-
- org.apache.lucene.facet.MultiDoubleValues
-
public abstract class MultiDoubleValues extends Object
Per-segment, per-document double values, which can be calculated at search-time. Documents may produce multiple values. See alsoDoubleValues
for a single-valued version.Currently meant only for use within the faceting module. Could be further generalized and made available for more use-cases outside faceting if there is a desire to do so.
- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Constructor Summary
Constructors Constructor Description MultiDoubleValues()
Instantiates a new MultiDoubleValues
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description abstract boolean
advanceExact(int doc)
Advance to exactlydoc
and return whetherdoc
has a value.abstract long
getValueCount()
Retrieves the number of values for the current document.abstract double
nextValue()
Iterates to the next value in the current document.
-
-
-
Method Detail
-
getValueCount
public abstract long getValueCount()
Retrieves the number of values for the current document. This must always be greater than zero. It is illegal to call this method afteradvanceExact(int)
returnedfalse
.
-
nextValue
public abstract double nextValue() throws IOException
Iterates to the next value in the current document. Do not call this more thangetValueCount()
times for the document.- Throws:
IOException
-
advanceExact
public abstract boolean advanceExact(int doc) throws IOException
Advance to exactlydoc
and return whetherdoc
has a value.- Throws:
IOException
-
-