Class SortedSetDocValuesField
- All Implemented Interfaces:
IndexableField
BytesRef values, indexed for
faceting,grouping,joining. Here's an example usage:
document.add(new SortedSetDocValuesField(name, new BytesRef("hello")));
document.add(new SortedSetDocValuesField(name, new BytesRef("world")));
If you also need to store the value, you should add a separate StoredField instance.
Each value can be at most 32766 bytes long.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.document.Field
Field.Store -
Field Summary
FieldsFields inherited from class org.apache.lucene.document.Field
fieldsData, name, type -
Constructor Summary
ConstructorsConstructorDescriptionSortedSetDocValuesField(String name, BytesRef bytes) Create a new sorted DocValues field. -
Method Summary
Modifier and TypeMethodDescriptionstatic SortedSetDocValuesFieldindexedField(String name, BytesRef bytes) Creates a newSortedSetDocValuesFieldwith the specified 64-bit long value that also creates askip index.static QuerynewSlowExactQuery(String field, BytesRef value) Create a query for matching an exactBytesRefvalue.static QuerynewSlowRangeQuery(String field, BytesRef lowerValue, BytesRef upperValue, boolean lowerInclusive, boolean upperInclusive) Create a range query that matches all documents whose value is betweenlowerValueandupperValue.static QuerynewSlowSetQuery(String field, Collection<BytesRef> values) Create a query matching any of the specified values.Methods inherited from class org.apache.lucene.document.Field
binaryValue, fieldType, getCharSequenceValue, invertableType, name, numericValue, readerValue, setBytesValue, setBytesValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setReaderValue, setShortValue, setStringValue, setTokenStream, storedValue, stringValue, tokenStream, tokenStreamValue, toString
-
Field Details
-
TYPE
Type for sorted bytes DocValues
-
-
Constructor Details
-
SortedSetDocValuesField
Create a new sorted DocValues field.- Parameters:
name- field namebytes- binary content- Throws:
IllegalArgumentException- if the field name is null
-
-
Method Details
-
indexedField
Creates a newSortedSetDocValuesFieldwith the specified 64-bit long value that also creates askip index.- Parameters:
name- field namebytes- binary content- Throws:
IllegalArgumentException- if the field name is null
-
newSlowRangeQuery
public static Query newSlowRangeQuery(String field, BytesRef lowerValue, BytesRef upperValue, boolean lowerInclusive, boolean upperInclusive) Create a range query that matches all documents whose value is betweenlowerValueandupperValue.This query also works with fields that have indexed
SortedDocValuesFields.NOTE: Such queries cannot efficiently advance to the next match, which makes them slow if they are not ANDed with a selective query. As a consequence, they are best used wrapped in an
IndexOrDocValuesQuery, alongside a range query that executes on points, such asBinaryPoint.newRangeQuery(java.lang.String, byte[], byte[]). -
newSlowExactQuery
Create a query for matching an exactBytesRefvalue.This query also works with fields that have indexed
SortedDocValuesFields.NOTE: Such queries cannot efficiently advance to the next match, which makes them slow if they are not ANDed with a selective query. As a consequence, they are best used wrapped in an
IndexOrDocValuesQuery, alongside a range query that executes on points, such asBinaryPoint.newExactQuery(java.lang.String, byte[]). -
newSlowSetQuery
Create a query matching any of the specified values.This query also works with fields that have indexed
SortedDocValuesFields.NOTE: Such queries cannot efficiently advance to the next match, which makes them slow if they are not ANDed with a selective query. As a consequence, they are best used wrapped in an
IndexOrDocValuesQuery, alongside a set query that executes on postings, such asTermInSetQuery.
-