Class SortedDocValuesField

java.lang.Object
org.apache.lucene.document.Field
org.apache.lucene.document.SortedDocValuesField
All Implemented Interfaces:
IndexableField
Direct Known Subclasses:
SortedBytesDocValuesField

public class SortedDocValuesField extends Field

Field that stores a per-document 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.

  • Field Details

    • TYPE

      public static final FieldType TYPE
      Type for sorted bytes DocValues
  • Constructor Details

    • SortedDocValuesField

      public SortedDocValuesField(String name, BytesRef bytes)
      Create a new sorted DocValues field.
      Parameters:
      name - field name
      bytes - binary content
      Throws:
      IllegalArgumentException - if the field name is null