elasticmagic/dev.evo.elasticmagic.doc/BoundField

BoundField

open class BoundField<V, T>(name: String, type: FieldType<V, T>, params: Params, parent: FieldSet) : MappingField<T>

Represents field of a specific type. Usually it can be accessed as a document property.

Parameters

name

name of the field

type

type of the field

params

mapping parameters

parent

the FieldSet object to which the field is bound

Inheritors

BoundRuntimeField

BoundRoutingField

BoundFieldNamesField

BoundSourceField

Constructors

constructor(name: String, type: FieldType<V, T>, params: Params, parent: FieldSet)

Functions

open fun asc(mode: Sort.Mode? = null, numericType: Sort.NumericType? = null, missing: Sort.Missing? = null, unmappedType: FieldType<*, *>? = null, nested: Sort.Nested? = null): Sort

fun FieldOperations<String>.boost(boost: Float): BoostedField

A shortcut to get boosted field.

open fun desc(mode: Sort.Mode? = null, numericType: Sort.NumericType? = null, missing: Sort.Missing? = null, unmappedType: FieldType<*, *>? = null, nested: Sort.Nested? = null): Sort

deserializeTerm

open fun deserializeTerm(v: Any): T

open infix fun eq(term: T?): QueryExpression

open fun eq(term: T?, boost: Float? = null): QueryExpression

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

open fun format(format: String? = null): FieldFormat

open override fun getFieldName(): String

open override fun getFieldType(): FieldType<V, T>

getMappingParams

open override fun getMappingParams(): Params

fun getParent(): FieldSet

getQualifiedFieldName

open override fun getQualifiedFieldName(): String

open infix fun gt(other: T?): Range<T>

open infix fun gte(other: T?): Range<T>

open override fun hashCode(): Int

fun <V, T> BoundField<V, T>.list(): BoundField<MutableList<V?>, T>

open infix fun lt(other: T?): Range<T>

open infix fun lte(other: T?): Range<T>

fun FieldOperations<String>.match(text: String): QueryExpression

open infix fun ne(term: T?): QueryExpression

open fun ne(term: T?, boost: Float? = null): QueryExpression

open fun oneOf(vararg terms: T & Any): QueryExpression

open infix fun oneOf(terms: List<T & Any>): QueryExpression

open fun range(gt: T? = null, gte: T? = null, lt: T? = null, lte: T? = null, boost: Float? = null): Range<T>

open fun serializeTerm(v: T & Any): Any

open override fun toString(): String

open override fun toValue(): String