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, or any field that you intend to use for sorting
or access through the field cache.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.document.Field
Field.Index, Field.Store, Field.TermVector
-
Field Summary
FieldsModifier 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
boost, fieldsData, name, tokenStream, type
-
Constructor Summary
ConstructorsConstructorDescriptionStringField
(String name, String value, Field.Store stored) Creates a new StringField. -
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_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 StringField.- 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.
-