Package org.apache.lucene.document
Class TextField
- java.lang.Object
-
- org.apache.lucene.document.Field
-
- org.apache.lucene.document.TextField
-
- All Implemented Interfaces:
IndexableField
public final class TextField extends Field
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
Fields Modifier and Type Field Description static FieldTypeTYPE_NOT_STOREDIndexed, tokenized, not stored.static FieldTypeTYPE_STOREDIndexed, tokenized, stored.-
Fields inherited from class org.apache.lucene.document.Field
fieldsData, name, tokenStream, type
-
-
Constructor Summary
Constructors Constructor Description TextField(String name, Reader reader)Creates 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidsetStringValue(String value)Expert: change the value of this field.StoredValuestoredValue()Stored value.-
Methods inherited from class org.apache.lucene.document.Field
binaryValue, fieldType, getCharSequenceValue, invertableType, name, numericValue, readerValue, setBytesValue, setBytesValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setReaderValue, setShortValue, setTokenStream, stringValue, tokenStream, tokenStreamValue, toString
-
-
-
-
Constructor Detail
-
TextField
public TextField(String name, Reader reader)
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
public TextField(String name, String value, Field.Store store)
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
public TextField(String name, TokenStream stream)
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
-
-
Method Detail
-
setStringValue
public void setStringValue(String value)
Description copied from class:FieldExpert: change the value of this field. This can be used during indexing to re-use a single Field instance to improve indexing speed by avoiding GC cost of new'ing and reclaiming Field instances. Typically a singleDocumentinstance is re-used as well. This helps most on small documents.Each Field instance should only be used once within a single
Documentinstance. See ImproveIndexingSpeed for details.- Overrides:
setStringValuein classField
-
storedValue
public StoredValue storedValue()
Description copied from interface:IndexableFieldStored value. This method is called to populate stored fields and must return a non-null value if the field stored.- Specified by:
storedValuein interfaceIndexableField- Overrides:
storedValuein classField
-
-