Term

class Term : Comparable<Term> , Accountable

A Term represents a word from text. This is the unit of search. It is composed of two elements, the text of the word, as a string, and the name of the field that the text occurred in.

Note that terms may represent more than words from text fields, but also things like dates, email addresses, urls, etc.

Constructors

Term

@JvmOverloads

constructor(fld: String, bytes: BytesRef = BytesRef())

Constructs a Term with the given field and empty text. This serves two purposes: 1) reuse of a Term with the same field. 2) pattern for a query.

constructor(fld: String, bytesBuilder: BytesRefBuilder)

Constructs a Term with the given field and the bytes from a builder.

constructor(fld: String, text: String)

Constructs a Term with the given field and text.

Types

Companion

object Companion

Properties

bytes

var bytes: BytesRef

childResources

open val childResources: MutableCollection<Accountable>

Returns nested resources of this class. The result should be a point-in-time snapshot (to avoid race conditions).

field

var field: String

Functions

bytes

fun bytes(): BytesRef

Returns the bytes of this term, these should not be modified.

compareTo

open operator override fun compareTo(other: Term): Int

Compares two terms, returning a negative integer if this term belongs before the argument, zero if this term is equal to the argument, and a positive integer if this term belongs after the argument.

equals

open operator override fun equals(obj: Any?): Boolean

field

fun field(): String

Returns the field of this term. The field indicates the part of a document which this term came from.

hashCode

open override fun hashCode(): Int

ramBytesUsed

open override fun ramBytesUsed(): Long

Return the memory usage of this object in bytes. Negative values are illegal.

set

fun set(fld: String, bytes: BytesRef)

Resets the field and text of a Term.

text

fun text(): String

Returns the text of this term. In the case of words, this is simply the text of the word. In the case of dates and other types, this is an encoding of the object as a string.

toString

open override fun toString(): String