core/org.gnit.lucenekmp.document/StoredField

StoredField

class StoredField : Field

A field whose value is stored so that IndexSearcher.storedFields and IndexReader.storedFields will return the field and its value.

Constructors

constructor(name: String, bytes: BytesRef, type: FieldType)

Expert: allows you to customize the FieldType.

constructor(name: String, value: ByteArray)

Create a stored-only field with the given binary value.

constructor(name: String, value: ByteArray, offset: Int, length: Int)

Create a stored-only field with the given binary value.

constructor(name: String, value: BytesRef)

Create a stored-only field with the given binary value.

constructor(name: String, value: StoredFieldDataInput)

Create a stored-only field with the given data input value.

constructor(name: String, value: String)

Create a stored-only field with the given string value.

constructor(name: String, value: String, type: FieldType)

Expert: allows you to customize the FieldType.

constructor(name: String, value: CharSequence, type: FieldType)

Expert: allows you to customize the FieldType.

constructor(name: String, value: Int)

Create a stored-only field with the given integer value.

constructor(name: String, value: Float)

Create a stored-only field with the given float value.

constructor(name: String, value: Long)

Create a stored-only field with the given long value.

constructor(name: String, value: Double)

Create a stored-only field with the given double value.

Types

object Companion

Properties

charSequenceValue

open override val charSequenceValue: CharSequence?

Functions

open override fun binaryValue(): BytesRef?

Non-null if this field has a binary value

open override fun fieldType(): IndexableFieldType

Returns the FieldType for this field.

open override fun invertableType(): InvertableType

Describes how this field should be inverted. This must return a non-null value if the field indexes terms and postings.

open override fun name(): String

Field name

open override fun numericValue(): Number?

Non-null if this field has a numeric value

open override fun readerValue(): Reader?

The value of the field as a Reader, or null. If null, the String value or binary value is used. Exactly one of stringValue(), readerValue(), and binaryValue() must be set.

fun setBytesValue(value: ByteArray)

open fun setBytesValue(value: BytesRef)

Expert: change the value of this field. See .setStringValue.

fun setByteValue(value: Byte)

Expert: change the value of this field. See .setStringValue.

open fun setDoubleValue(value: Double)

Expert: change the value of this field. See .setStringValue.

open fun setFloatValue(value: Float)

Expert: change the value of this field. See .setStringValue.

open fun setIntValue(value: Int)

Expert: change the value of this field. See .setStringValue.

open fun setLongValue(value: Long)

Expert: change the value of this field. See .setStringValue.

fun setReaderValue(value: Reader)

Expert: change the value of this field. See .setStringValue.

fun setShortValue(value: Short)

Expert: change the value of this field. See .setStringValue.

open fun setStringValue(value: String)

Expert: 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 single Document instance is re-used as well. This helps most on small documents.

fun setTokenStream(tokenStream: TokenStream)

Expert: sets the token stream to be used for indexing.

open override fun storedValue(): StoredValue?

Stored value. This method is called to populate stored fields and must return a non-null value if the field stored.

open override fun stringValue(): String?

The value of the field as a String, or null. If null, the Reader value or binary value is used. Exactly one of stringValue(), readerValue(), and binaryValue() must be set.

open override fun tokenStream(analyzer: Analyzer, reuse: TokenStream?): TokenStream?

Creates the TokenStream used for indexing this field. If appropriate, implementations should use the given Analyzer to create the TokenStreams.

tokenStreamValue

fun tokenStreamValue(): TokenStream?

The TokenStream for this field to be used when indexing, or null. If null, the Reader value or String value is analyzed to produce the indexed tokens.

open override fun toString(): String

Prints a Field for human consumption.