org.elasticsearch.search

Enum MultiValueMode

java.lang.Object

java.lang.Enum<MultiValueMode>

org.elasticsearch.search.MultiValueMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MultiValueMode>, Writeable

public enum MultiValueMode
extends java.lang.Enum<MultiValueMode>
implements Writeable

Defines what values to pick in the case a document contains multiple values for a particular field.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MultiValueMode.UnsortedNumericDoubleValues Interface allowing custom value generators to be used in MultiValueMode.

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Enum Constant Summary

Enum Constants

Enum Constant and Description
AVG Pick the average of all the values.
MAX Pick the highest value.
MEDIAN Pick the median of the values.
MIN Pick the lowest value.
SUM Pick the sum of all the values.

Method Summary

Modifier and Type	Method and Description
static MultiValueMode	fromString(java.lang.String sortMode) A case insensitive version of valueOf(String)
protected org.apache.lucene.util.BytesRef	pick(org.apache.lucene.index.BinaryDocValues values, org.apache.lucene.util.BytesRefBuilder builder, org.apache.lucene.search.DocIdSetIterator docItr, int startDoc, int endDoc)
protected double	pick(MultiValueMode.UnsortedNumericDoubleValues values, double missingValue, int doc)
protected int	pick(org.apache.lucene.index.RandomAccessOrds values, int doc)
protected org.apache.lucene.util.BytesRef	pick(SortedBinaryDocValues values, org.apache.lucene.util.BytesRef missingValue, int doc)
protected int	pick(org.apache.lucene.index.SortedDocValues values, org.apache.lucene.search.DocIdSetIterator docItr, int startDoc, int endDoc)
protected long	pick(org.apache.lucene.index.SortedNumericDocValues values, long missingValue, org.apache.lucene.search.DocIdSetIterator docItr, int startDoc, int endDoc)
protected long	pick(org.apache.lucene.index.SortedNumericDocValues values, long missingValue, int doc)
protected double	pick(SortedNumericDoubleValues values, double missingValue, org.apache.lucene.search.DocIdSetIterator docItr, int startDoc, int endDoc)
protected double	pick(SortedNumericDoubleValues values, double missingValue, int doc)
static MultiValueMode	readMultiValueModeFrom(StreamInput in)
NumericDoubleValues	select(MultiValueMode.UnsortedNumericDoubleValues values, double missingValue) Return a NumericDoubleValues instance that can be used to sort documents with this mode and the provided values.
org.apache.lucene.index.SortedDocValues	select(org.apache.lucene.index.RandomAccessOrds values) Return a SortedDocValues instance that can be used to sort documents with this mode and the provided values.
org.apache.lucene.index.SortedDocValues	select(org.apache.lucene.index.RandomAccessOrds values, org.apache.lucene.util.BitSet rootDocs, org.apache.lucene.search.DocIdSetIterator innerDocs) Return a SortedDocValues instance that can be used to sort root documents with this mode, the provided values and filters for root/inner documents.
org.apache.lucene.index.BinaryDocValues	select(SortedBinaryDocValues values, org.apache.lucene.util.BytesRef missingValue) Return a BinaryDocValues instance that can be used to sort documents with this mode and the provided values.
org.apache.lucene.index.BinaryDocValues	select(SortedBinaryDocValues values, org.apache.lucene.util.BytesRef missingValue, org.apache.lucene.util.BitSet rootDocs, org.apache.lucene.search.DocIdSetIterator innerDocs, int maxDoc) Return a BinaryDocValues instance that can be used to sort root documents with this mode, the provided values and filters for root/inner documents.
org.apache.lucene.index.NumericDocValues	select(org.apache.lucene.index.SortedNumericDocValues values, long missingValue) Return a NumericDocValues instance that can be used to sort documents with this mode and the provided values.
org.apache.lucene.index.NumericDocValues	select(org.apache.lucene.index.SortedNumericDocValues values, long missingValue, org.apache.lucene.util.BitSet rootDocs, org.apache.lucene.search.DocIdSetIterator innerDocs, int maxDoc) Return a NumericDocValues instance that can be used to sort root documents with this mode, the provided values and filters for root/inner documents.
NumericDoubleValues	select(SortedNumericDoubleValues values, double missingValue) Return a NumericDoubleValues instance that can be used to sort documents with this mode and the provided values.
NumericDoubleValues	select(SortedNumericDoubleValues values, double missingValue, org.apache.lucene.util.BitSet rootDocs, org.apache.lucene.search.DocIdSetIterator innerDocs, int maxDoc) Return a NumericDoubleValues instance that can be used to sort root documents with this mode, the provided values and filters for root/inner documents.
static MultiValueMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MultiValueMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
void	writeTo(StreamOutput out) Write this into the StreamOutput.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUM

public static final MultiValueMode SUM

Pick the sum of all the values.

AVG

public static final MultiValueMode AVG

Pick the average of all the values.

MEDIAN

public static final MultiValueMode MEDIAN

Pick the median of the values.

MIN

public static final MultiValueMode MIN

Pick the lowest value.

MAX

public static final MultiValueMode MAX

Pick the highest value.

Method Detail

values

public static MultiValueMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MultiValueMode c : MultiValueMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MultiValueMode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

fromString

public static MultiValueMode fromString(java.lang.String sortMode)

A case insensitive version of valueOf(String)

Throws:

java.lang.IllegalArgumentException - if the given string doesn't match a sort mode or is null.

select

public org.apache.lucene.index.NumericDocValues select(org.apache.lucene.index.SortedNumericDocValues values,
                                                       long missingValue)

Return a NumericDocValues instance that can be used to sort documents with this mode and the provided values. When a document has no value, missingValue is returned. Allowed Modes: SUM, AVG, MEDIAN, MIN, MAX

pick

protected long pick(org.apache.lucene.index.SortedNumericDocValues values,
                    long missingValue,
                    int doc)

select

public org.apache.lucene.index.NumericDocValues select(org.apache.lucene.index.SortedNumericDocValues values,
                                                       long missingValue,
                                                       org.apache.lucene.util.BitSet rootDocs,
                                                       org.apache.lucene.search.DocIdSetIterator innerDocs,
                                                       int maxDoc)
                                                throws java.io.IOException

Return a NumericDocValues instance that can be used to sort root documents with this mode, the provided values and filters for root/inner documents. For every root document, the values of its inner documents will be aggregated. If none of the inner documents has a value, then missingValue is returned. Allowed Modes: SUM, AVG, MIN, MAX NOTE: Calling the returned instance on docs that are not root docs is illegal The returned instance can only be evaluate the current and upcoming docs

Throws:

java.io.IOException

pick

protected long pick(org.apache.lucene.index.SortedNumericDocValues values,
                    long missingValue,
                    org.apache.lucene.search.DocIdSetIterator docItr,
                    int startDoc,
                    int endDoc)

select

public NumericDoubleValues select(SortedNumericDoubleValues values,
                                  double missingValue)

Return a NumericDoubleValues instance that can be used to sort documents with this mode and the provided values. When a document has no value, missingValue is returned. Allowed Modes: SUM, AVG, MEDIAN, MIN, MAX

pick

protected double pick(SortedNumericDoubleValues values,
                      double missingValue,
                      int doc)

select

public NumericDoubleValues select(SortedNumericDoubleValues values,
                                  double missingValue,
                                  org.apache.lucene.util.BitSet rootDocs,
                                  org.apache.lucene.search.DocIdSetIterator innerDocs,
                                  int maxDoc)
                           throws java.io.IOException

Return a NumericDoubleValues instance that can be used to sort root documents with this mode, the provided values and filters for root/inner documents. For every root document, the values of its inner documents will be aggregated. If none of the inner documents has a value, then missingValue is returned. Allowed Modes: SUM, AVG, MIN, MAX NOTE: Calling the returned instance on docs that are not root docs is illegal The returned instance can only be evaluate the current and upcoming docs

Throws:

java.io.IOException

pick

protected double pick(SortedNumericDoubleValues values,
                      double missingValue,
                      org.apache.lucene.search.DocIdSetIterator docItr,
                      int startDoc,
                      int endDoc)

select

public org.apache.lucene.index.BinaryDocValues select(SortedBinaryDocValues values,
                                                      org.apache.lucene.util.BytesRef missingValue)

Return a BinaryDocValues instance that can be used to sort documents with this mode and the provided values. When a document has no value, missingValue is returned. Allowed Modes: MIN, MAX

pick

protected org.apache.lucene.util.BytesRef pick(SortedBinaryDocValues values,
                                               org.apache.lucene.util.BytesRef missingValue,
                                               int doc)

select

public org.apache.lucene.index.BinaryDocValues select(SortedBinaryDocValues values,
                                                      org.apache.lucene.util.BytesRef missingValue,
                                                      org.apache.lucene.util.BitSet rootDocs,
                                                      org.apache.lucene.search.DocIdSetIterator innerDocs,
                                                      int maxDoc)
                                               throws java.io.IOException

Return a BinaryDocValues instance that can be used to sort root documents with this mode, the provided values and filters for root/inner documents. For every root document, the values of its inner documents will be aggregated. If none of the inner documents has a value, then missingValue is returned. Allowed Modes: MIN, MAX NOTE: Calling the returned instance on docs that are not root docs is illegal The returned instance can only be evaluate the current and upcoming docs

Throws:

java.io.IOException

pick

protected org.apache.lucene.util.BytesRef pick(org.apache.lucene.index.BinaryDocValues values,
                                               org.apache.lucene.util.BytesRefBuilder builder,
                                               org.apache.lucene.search.DocIdSetIterator docItr,
                                               int startDoc,
                                               int endDoc)

select

public org.apache.lucene.index.SortedDocValues select(org.apache.lucene.index.RandomAccessOrds values)

Return a SortedDocValues instance that can be used to sort documents with this mode and the provided values. Allowed Modes: MIN, MAX

pick

protected int pick(org.apache.lucene.index.RandomAccessOrds values,
                   int doc)

select

public org.apache.lucene.index.SortedDocValues select(org.apache.lucene.index.RandomAccessOrds values,
                                                      org.apache.lucene.util.BitSet rootDocs,
                                                      org.apache.lucene.search.DocIdSetIterator innerDocs)
                                               throws java.io.IOException

Return a SortedDocValues instance that can be used to sort root documents with this mode, the provided values and filters for root/inner documents. For every root document, the values of its inner documents will be aggregated. Allowed Modes: MIN, MAX NOTE: Calling the returned instance on docs that are not root docs is illegal The returned instance can only be evaluate the current and upcoming docs

Throws:

java.io.IOException

pick

protected int pick(org.apache.lucene.index.SortedDocValues values,
                   org.apache.lucene.search.DocIdSetIterator docItr,
                   int startDoc,
                   int endDoc)

select

public NumericDoubleValues select(MultiValueMode.UnsortedNumericDoubleValues values,
                                  double missingValue)

Return a NumericDoubleValues instance that can be used to sort documents with this mode and the provided values. When a document has no value, missingValue is returned. Allowed Modes: SUM, AVG, MIN, MAX

pick

protected double pick(MultiValueMode.UnsortedNumericDoubleValues values,
                      double missingValue,
                      int doc)

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

java.io.IOException

readMultiValueModeFrom

public static MultiValueMode readMultiValueModeFrom(StreamInput in)
                                             throws java.io.IOException

Throws:

java.io.IOException