Package org.apache.lucene.document
Class StringField
java.lang.Object
org.apache.lucene.document.Field
org.apache.lucene.document.StringField
- All Implemented Interfaces:
IndexableField
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. If you also need to sort
on this field, separately add a
SortedDocValuesField
to your document.-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.document.Field
Field.Store
-
Field Summary
Modifier and TypeFieldDescriptionstatic final FieldType
Indexed, not tokenized, omits norms, indexes DOCS_ONLY, not stored.static final FieldType
Indexed, not tokenized, omits norms, indexes DOCS_ONLY, storedFields inherited from class org.apache.lucene.document.Field
fieldsData, name, tokenStream, type
-
Constructor Summary
ConstructorDescriptionStringField
(String name, String value, Field.Store stored) Creates a new textual StringField, indexing the provided String value as a single token.StringField
(String name, BytesRef value, Field.Store stored) Creates a new binary StringField, indexing the provided binary (BytesRef) value as a single token. -
Method Summary
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_NOT_STORED
Indexed, not tokenized, omits norms, indexes DOCS_ONLY, not stored. -
TYPE_STORED
Indexed, not tokenized, omits norms, indexes DOCS_ONLY, stored
-
-
Constructor Details
-
StringField
Creates a new textual StringField, indexing the provided String value as a single token.- Parameters:
name
- field namevalue
- String valuestored
- Store.YES if the content should also be stored- Throws:
IllegalArgumentException
- if the field name or value is null.
-
StringField
Creates a new binary StringField, indexing the provided binary (BytesRef) value as a single token.- Parameters:
name
- field namevalue
- BytesRef value. The provided value is not cloned so you must not change it until the document(s) holding it have been indexed.stored
- Store.YES if the content should also be stored- Throws:
IllegalArgumentException
- if the field name or value is null.
-