Package org.hibernate.search.backend.lucene.lowlevel.docvalues.impl

Class TextMultiValues

java.lang.Object

org.hibernate.search.backend.lucene.lowlevel.docvalues.impl.TextMultiValues

Direct Known Subclasses:

TextMultiValues.DocValuesTextMultiValues

public abstract class TextMultiValues
extends Object

A per-document, unordered sequence of text ordinals.

Essentially, this is a wrapper around SortedSetDocValues that may support joins, but does not guarantee that ordinals for a given documents are returned in ascending order.

Some of this code was copied and adapted from org.apache.lucene.index.SortedSetDocValues of Apache Lucene project.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	TextMultiValues.DocValuesTextMultiValues

Field Summary

Fields

Modifier and Type	Field	Description
static final TextMultiValues	EMPTY	An empty DoubleMultiValues instance that always returns false from advanceExact(int)

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TextMultiValues()	Sole constructor.

Method Summary

Modifier and Type	Method	Description
abstract boolean	advanceExact(int doc)	Advance this instance to the given document id
static TextMultiValues	fromDocValues(org.apache.lucene.index.SortedSetDocValues docValues)
abstract long	getValueCount()	Returns the number of unique values.
abstract boolean	hasNextValue()
abstract long	nextOrd()

Methods inherited from class java.lang.Object

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

Field Details

EMPTY

public static final TextMultiValues EMPTY

An empty DoubleMultiValues instance that always returns false from advanceExact(int)

Constructor Details

TextMultiValues

protected TextMultiValues()

Sole constructor. (For invocation by subclass constructors, typically implicit.)

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

hasNextValue

public abstract boolean hasNextValue()
                              throws IOException

Returns:

true if there is a next value for this document, i.e. if nextValue() can be called.

Throws:

IOException

nextOrd

public abstract long nextOrd()
                      throws IOException

Returns:

The next value for the current document. Can only be called after hasNextValue() returned true.

Throws:

IOException

getValueCount

public abstract long getValueCount()

Returns the number of unique values.

Returns:

number of unique values in this SortedDocValues. This is also equivalent to one plus the maximum ordinal.

fromDocValues

public static TextMultiValues fromDocValues(org.apache.lucene.index.SortedSetDocValues docValues)