Class SortedDocValuesField
- java.lang.Object
-
- org.apache.lucene.document.Field
-
- org.apache.lucene.document.SortedDocValuesField
-
- All Implemented Interfaces:
IndexableField
public class SortedDocValuesField extends Field
Field that stores a per-documentBytesRefvalue, indexed for sorting. Here's an example usage:document.add(new SortedDocValuesField(name, new BytesRef("hello")));If you also need to store the value, you should add a separate
StoredFieldinstance.This 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
Fields Modifier and Type Field Description static FieldTypeTYPEType for sorted bytes DocValues-
Fields inherited from class org.apache.lucene.document.Field
fieldsData, name, tokenStream, type
-
-
Constructor Summary
Constructors Constructor Description SortedDocValuesField(String name, BytesRef bytes)Create a new sorted DocValues field.
-
Method Summary
All Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method Description 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 betweenlowerValueandupperValueincluded.static QuerynewSlowSetQuery(String field, Collection<BytesRef> values)Create a query matching any of the specified values.static QuerynewSlowSetQuery(String field, BytesRef... values)Deprecated, for removal: This API element is subject to removal in a future version.UsenewSlowSetQuery(String, Collection)instead.-
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 Detail
-
TYPE
public static final FieldType TYPE
Type for sorted bytes DocValues
-
-
Constructor Detail
-
SortedDocValuesField
public SortedDocValuesField(String name, BytesRef bytes)
Create a new sorted DocValues field.- Parameters:
name- field namebytes- binary content- Throws:
IllegalArgumentException- if the field name is null
-
-
Method Detail
-
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 betweenlowerValueandupperValueincluded.You can have half-open ranges by setting
lowerValue = nullorupperValue = null.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
public static Query newSlowExactQuery(String field, BytesRef value)
Create a query for matching an exactBytesRefvalue.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
@Deprecated(forRemoval=true, since="9.10") public static Query newSlowSetQuery(String field, BytesRef... values)
Deprecated, for removal: This API element is subject to removal in a future version.UsenewSlowSetQuery(String, Collection)instead.Create a query matching any of the specified values.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.
-
newSlowSetQuery
public static Query newSlowSetQuery(String field, Collection<BytesRef> values)
Create a query matching any of the specified values.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.
-
-