Package org.apache.lucene.document
Class StoredField
java.lang.Object
org.apache.lucene.document.Field
org.apache.lucene.document.StoredField
- All Implemented Interfaces:
IndexableField
A field whose value is stored so that
IndexSearcher.doc(int)
and IndexReader.document()
will return the field and its value.-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.document.Field
Field.Store
-
Field Summary
FieldsFields inherited from class org.apache.lucene.document.Field
fieldsData, name, tokenStream, type
-
Constructor Summary
ConstructorsModifierConstructorDescriptionStoredField
(String name, byte[] value) Create a stored-only field with the given binary value.StoredField
(String name, byte[] value, int offset, int length) Create a stored-only field with the given binary value.StoredField
(String name, double value) Create a stored-only field with the given double value.StoredField
(String name, float value) Create a stored-only field with the given float value.StoredField
(String name, int value) Create a stored-only field with the given integer value.StoredField
(String name, long value) Create a stored-only field with the given long value.StoredField
(String name, CharSequence value, FieldType type) Expert: allows you to customize theFieldType
.StoredField
(String name, String value) Create a stored-only field with the given string value.StoredField
(String name, String value, FieldType type) Expert: allows you to customize theFieldType
.protected
StoredField
(String name, FieldType type) Expert: allows you to customize theFieldType
.StoredField
(String name, BytesRef value) Create a stored-only field with the given binary value.StoredField
(String name, BytesRef bytes, FieldType type) Expert: allows you to customize theFieldType
. -
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
Type for a stored-only field.
-
-
Constructor Details
-
StoredField
Expert: allows you to customize theFieldType
.- Parameters:
name
- field nametype
- customFieldType
for this field- Throws:
IllegalArgumentException
- if the field name or type is null.
-
StoredField
Expert: allows you to customize theFieldType
.NOTE: the provided byte[] is not copied so be sure not to change it until you're done with this field.
- Parameters:
name
- field namebytes
- byte array pointing to binary content (not copied)type
- customFieldType
for this field- Throws:
IllegalArgumentException
- if the field name, value or type is null.
-
StoredField
Create a stored-only field with the given binary value.NOTE: the provided byte[] is not copied so be sure not to change it until you're done with this field.
- Parameters:
name
- field namevalue
- byte array pointing to binary content (not copied)- Throws:
IllegalArgumentException
- if the field name or value is null.
-
StoredField
Create a stored-only field with the given binary value.NOTE: the provided byte[] is not copied so be sure not to change it until you're done with this field.
- Parameters:
name
- field namevalue
- byte array pointing to binary content (not copied)offset
- starting position of the byte arraylength
- valid length of the byte array- Throws:
IllegalArgumentException
- if the field name or value is null.
-
StoredField
Create a stored-only field with the given binary value.NOTE: the provided BytesRef is not copied so be sure not to change it until you're done with this field.
- Parameters:
name
- field namevalue
- BytesRef pointing to binary content (not copied)- Throws:
IllegalArgumentException
- if the field name or value is null.
-
StoredField
Create a stored-only field with the given string value.- Parameters:
name
- field namevalue
- string value- Throws:
IllegalArgumentException
- if the field name or value is null.
-
StoredField
Expert: allows you to customize theFieldType
.- Parameters:
name
- field namevalue
- string valuetype
- customFieldType
for this field- Throws:
IllegalArgumentException
- if the field name, value or type is null.
-
StoredField
Expert: allows you to customize theFieldType
.- Parameters:
name
- field namevalue
- CharSequence valuetype
- customFieldType
for this field- Throws:
IllegalArgumentException
- if the field name, value or type is null.
-
StoredField
Create a stored-only field with the given integer value.- Parameters:
name
- field namevalue
- integer value- Throws:
IllegalArgumentException
- if the field name is null.
-
StoredField
Create a stored-only field with the given float value.- Parameters:
name
- field namevalue
- float value- Throws:
IllegalArgumentException
- if the field name is null.
-
StoredField
Create a stored-only field with the given long value.- Parameters:
name
- field namevalue
- long value- Throws:
IllegalArgumentException
- if the field name is null.
-
StoredField
Create a stored-only field with the given double value.- Parameters:
name
- field namevalue
- double value- Throws:
IllegalArgumentException
- if the field name is null.
-