Class BinaryDocValuesField

  • All Implemented Interfaces:
    Direct Known Subclasses:
    DerefBytesDocValuesField, StraightBytesDocValuesField

    public class BinaryDocValuesField
    extends Field
    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:
    • Field Detail

      • TYPE

        public static final FieldType TYPE
        Type for straight bytes DocValues.
    • Constructor Detail

      • BinaryDocValuesField

        public BinaryDocValuesField​(java.lang.String name,
                                    BytesRef value)
        Create a new binary DocValues field.
        name - field name
        value - binary content
        java.lang.IllegalArgumentException - if the field name is null