Package org.apache.lucene.document
Class TextField
java.lang.Object
org.apache.lucene.document.Field
org.apache.lucene.document.TextField
- All Implemented Interfaces:
IndexableField
A field that is indexed and tokenized, without term vectors. For example this would be used on a
'body' field, that contains the bulk of a document's text.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.document.Field
Field.Store
-
Field Summary
Modifier and TypeFieldDescriptionstatic final FieldType
Indexed, tokenized, not stored.static final FieldType
Indexed, tokenized, stored.Fields inherited from class org.apache.lucene.document.Field
fieldsData, name, tokenStream, type
-
Constructor Summary
ConstructorDescriptionCreates a new un-stored TextField with Reader value.TextField
(String name, String value, Field.Store store) Creates a new TextField with String value.TextField
(String name, TokenStream stream) Creates a new un-stored TextField with TokenStream value. -
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, tokenized, not stored. -
TYPE_STORED
Indexed, tokenized, stored.
-
-
Constructor Details
-
TextField
Creates a new un-stored TextField with Reader value.- Parameters:
name
- field namereader
- reader value- Throws:
IllegalArgumentException
- if the field name is nullNullPointerException
- if the reader is null
-
TextField
Creates a new TextField with String value.- Parameters:
name
- field namevalue
- string valuestore
- Store.YES if the content should also be stored- Throws:
IllegalArgumentException
- if the field name or value is null.
-
TextField
Creates a new un-stored TextField with TokenStream value.- Parameters:
name
- field namestream
- TokenStream value- Throws:
IllegalArgumentException
- if the field name is null.NullPointerException
- if the tokenStream is null
-