org.elasticsearch.search

列挙型 MultiValueMode

java.lang.Object

java.lang.Enum<MultiValueMode>

org.elasticsearch.search.MultiValueMode

すべての実装されたインタフェース:

Serializable, Comparable<MultiValueMode>

public enum MultiValueMode
extends Enum<MultiValueMode>

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

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
static interface	MultiValueMode.UnsortedNumericDoubleValues Interface allowing custom value generators to be used in MultiValueMode.

列挙型定数のサマリー

列挙型定数

列挙型定数と説明
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.

メソッドのサマリー

修飾子とタイプ	メソッドと説明
static MultiValueMode	fromString(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)
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(String name) 指定した名前を持つこの型の列挙型定数を返します。
static MultiValueMode[]	values() この列挙型の定数を含む配列を宣言されている順序で返します。

クラスから継承されたメソッド java.lang.Enum

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

クラスから継承されたメソッド java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

列挙型定数の詳細

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.

メソッドの詳細

values

public static MultiValueMode[] values()

この列挙型の定数を含む配列を宣言されている順序で返します。 このメソッドは次のようにして定数を反復するために 使用できます:

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

戻り値:

この列挙型の定数を含む、宣言されている順序での配列

valueOf

public static MultiValueMode valueOf(String name)

指定した名前を持つこの型の列挙型定数を返します。 文字列は、この型の列挙型定数を宣言するのに使用した識別子と正確に 一致している必要があります。 (余分な空白文字を含めることはできません。)

パラメータ:

name - 返される列挙型定数の名前。

戻り値:

指定した名前の列挙型定数

例外:

IllegalArgumentException - この列挙型に、指定した名前の定数がない場合

NullPointerException - 引数がnullの場合

fromString

public static MultiValueMode fromString(String sortMode)

A case insensitive version of valueOf(String)

例外:

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 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

例外:

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 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

例外:

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 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

例外:

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 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

例外:

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)