Package org.apache.lucene.document
Class BinaryDocValuesField
java.lang.Object
org.apache.lucene.document.Field
org.apache.lucene.document.BinaryDocValuesField
- All Implemented Interfaces:
IndexableField
- Direct Known Subclasses:
DerefBytesDocValuesField
,StraightBytesDocValuesField
Field that stores a per-document
BytesRef
value.
The values are stored directly with no sharing, which is a good fit when
the fields don't share (many) values, such as a title field. If values
may be shared and sorted it's better to use SortedDocValuesField
.
Here's an example usage:
document.add(new BinaryDocValuesField(name, new BytesRef("hello")));
If you also need to store the value, you should add a
separate StoredField
instance.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.document.Field
Field.Index, Field.Store, Field.TermVector
-
Field Summary
FieldsFields inherited from class org.apache.lucene.document.Field
boost, fieldsData, name, tokenStream, type
-
Constructor Summary
ConstructorsConstructorDescriptionBinaryDocValuesField
(String name, BytesRef value) Create a new binary DocValues field. -
Method Summary
Methods inherited from class org.apache.lucene.document.Field
binaryValue, boost, fieldType, name, numericValue, readerValue, setBoost, setBytesValue, setBytesValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setReaderValue, setShortValue, setStringValue, setTokenStream, stringValue, tokenStream, tokenStreamValue, toString, translateFieldType
-
Field Details
-
TYPE
Type for straight bytes DocValues.
-
-
Constructor Details
-
BinaryDocValuesField
Create a new binary DocValues field.- Parameters:
name
- field namevalue
- binary content- Throws:
IllegalArgumentException
- if the field name is null
-