Module org.elasticsearch.server

Package org.elasticsearch.index.fielddata

Class MultiValuedSortedBinaryDocValues

java.lang.Object

org.elasticsearch.index.fielddata.SortedBinaryDocValues

org.elasticsearch.index.fielddata.MultiValuedSortedBinaryDocValues

public abstract class MultiValuedSortedBinaryDocValues
extends SortedBinaryDocValues

Wrapper around BinaryDocValues to decode the typical multivalued encoding

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.index.fielddata.SortedBinaryDocValues

SortedBinaryDocValues.Sparsity, SortedBinaryDocValues.ValueMode

Method Summary

Modifier and Type	Method	Description
abstract boolean	advanceExact(int doc)	Advance this instance to the given document id
int	docValueCount()	Retrieves the number of values for the current document.
static MultiValuedSortedBinaryDocValues	from(org.apache.lucene.index.LeafReader leafReader, String valuesFieldName)
static MultiValuedSortedBinaryDocValues	from(org.apache.lucene.index.LeafReader leafReader, String valuesFieldName, org.apache.lucene.index.BinaryDocValues values)
abstract org.apache.lucene.util.BytesRef	nextValue()	Iterates to the next value in the current document.

Methods inherited from class org.elasticsearch.index.fielddata.SortedBinaryDocValues

getSparsity, getValueMode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

from

public static MultiValuedSortedBinaryDocValues from(org.apache.lucene.index.LeafReader leafReader,
 String valuesFieldName)
                                             throws IOException

Throws:

IOException

from

public static MultiValuedSortedBinaryDocValues from(org.apache.lucene.index.LeafReader leafReader,
 String valuesFieldName,
 org.apache.lucene.index.BinaryDocValues values)
                                             throws IOException

Throws:

IOException

docValueCount

public int docValueCount()

Description copied from class: SortedBinaryDocValues

Retrieves the number of values for the current document. This must always be greater than zero. It is illegal to call this method after SortedBinaryDocValues.advanceExact(int) returned false.

Specified by:

docValueCount in class SortedBinaryDocValues

advanceExact

public abstract boolean advanceExact(int doc)
                              throws IOException

Description copied from class: SortedBinaryDocValues

Advance this instance to the given document id

Specified by:

advanceExact in class SortedBinaryDocValues

Returns:

true if there is a value for this document

Throws:

IOException

nextValue

public abstract org.apache.lucene.util.BytesRef nextValue()
                                                   throws IOException

Description copied from class: SortedBinaryDocValues

Iterates to the next value in the current document. Do not call this more than SortedBinaryDocValues.docValueCount() times for the document. Note that the returned BytesRef might be reused across invocations.

Specified by:

nextValue in class SortedBinaryDocValues

Throws:

IOException