Module org.elasticsearch.server

Package org.elasticsearch.index.fielddata

Class SortedBinaryDocValues

java.lang.Object

org.elasticsearch.index.fielddata.SortedBinaryDocValues

Direct Known Subclasses:

IpScriptDocValues, MultiValuedSortedBinaryDocValues, SortingBinaryDocValues, SourceValueFetcherSortedBinaryIndexFieldData.SourceValueFetcherSortedBinaryDocValues

public abstract class SortedBinaryDocValues
extends Object

A list of per-document binary values, sorted according to BytesRef.compareTo(BytesRef). There might be dups however.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SortedBinaryDocValues.Sparsity	Describes the sparsity of the values for a field.
static enum	SortedBinaryDocValues.ValueMode	The per-document value mode for a field.

Constructor Summary

Constructors

Constructor	Description
SortedBinaryDocValues()

Method Summary

Modifier and Type	Method	Description
abstract boolean	advanceExact(int doc)	Advance this instance to the given document id
abstract int	docValueCount()	Retrieves the number of values for the current document.
SortedBinaryDocValues.Sparsity	getSparsity()	Indicates the sparsity of the values for this field.
SortedBinaryDocValues.ValueMode	getValueMode()	Indicates the per-document value mode for this field.
abstract org.apache.lucene.util.BytesRef	nextValue()	Iterates to the next value in the current document.

Methods inherited from class java.lang.Object

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

Constructor Details

SortedBinaryDocValues

public SortedBinaryDocValues()

Method Details

advanceExact

public abstract boolean advanceExact(int doc)
                              throws IOException

Advance this instance to the given document id

Returns:

true if there is a value for this document

Throws:

IOException

docValueCount

public abstract int docValueCount()

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

nextValue

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

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

Throws:

IOException

getSparsity

public SortedBinaryDocValues.Sparsity getSparsity()

Indicates the sparsity of the values for this field.

getValueMode

public SortedBinaryDocValues.ValueMode getValueMode()

Indicates the per-document value mode for this field.