Class SortedDocValuesField
- All Implemented Interfaces:
IndexableField
BytesRef
value, 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 StoredField
instance.
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 inherited from class org.apache.lucene.document.Field
fieldsData, name, tokenStream, type
-
Constructor Summary
ConstructorDescriptionSortedDocValuesField
(String name, BytesRef bytes) Create a new sorted DocValues field. -
Method Summary
Modifier and TypeMethodDescriptionstatic Query
newSlowExactQuery
(String field, BytesRef value) Create a query for matching an exactBytesRef
value.static Query
newSlowRangeQuery
(String field, BytesRef lowerValue, BytesRef upperValue, boolean lowerInclusive, boolean upperInclusive) Create a range query that matches all documents whose value is betweenlowerValue
andupperValue
included.Methods inherited from class org.apache.lucene.document.Field
binaryValue, fieldType, getCharSequenceValue, name, numericValue, readerValue, setBytesValue, setBytesValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setReaderValue, setShortValue, setStringValue, setTokenStream, stringValue, tokenStream, tokenStreamValue, toString
-
Field Details
-
TYPE
Type for sorted bytes DocValues
-
-
Constructor Details
-
SortedDocValuesField
Create a new sorted DocValues field.- Parameters:
name
- field namebytes
- binary content- Throws:
IllegalArgumentException
- if the field name is null
-
-
Method Details
-
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 betweenlowerValue
andupperValue
included.You can have half-open ranges by setting
lowerValue = null
orupperValue = 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
Create a query for matching an exactBytesRef
value.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[])
.
-