Class StringField

java.lang.Object
org.apache.lucene.document.Field
org.apache.lucene.document.StringField
All Implemented Interfaces:
IndexableField

public final class StringField extends Field
A field that is indexed but not tokenized: the entire String value is indexed as a single token. For example this might be used for a 'country' field or an 'id' field, or any field that you intend to use for sorting or access through the field cache.
  • Field Details

    • TYPE_NOT_STORED

      public static final FieldType TYPE_NOT_STORED
      Indexed, not tokenized, omits norms, indexes DOCS_ONLY, not stored.
    • TYPE_STORED

      public static final FieldType TYPE_STORED
      Indexed, not tokenized, omits norms, indexes DOCS_ONLY, stored
  • Constructor Details

    • StringField

      public StringField(String name, String value, Field.Store stored)
      Creates a new StringField.
      Parameters:
      name - field name
      value - String value
      stored - Store.YES if the content should also be stored
      Throws:
      IllegalArgumentException - if the field name or value is null.