IndexableField

interface IndexableField

Represents a single field for indexing. IndexWriter consumes Iterable as a document.

Inheritors

Properties

Link copied to clipboard

Functions

Link copied to clipboard
abstract fun binaryValue(): BytesRef?

Non-null if this field has a binary value

Link copied to clipboard

IndexableFieldType describing the properties of this field.

Link copied to clipboard

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

Link copied to clipboard
abstract fun name(): String

Field name

Link copied to clipboard
abstract fun numericValue(): Number?

Non-null if this field has a numeric value

Link copied to clipboard
abstract fun readerValue(): Reader?

Non-null if this field has a Reader value

Link copied to clipboard
abstract fun storedValue(): StoredValue?

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

Link copied to clipboard
abstract fun stringValue(): String?

Non-null if this field has a string value

Link copied to clipboard
abstract 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.