elasticmagic/dev.evo.elasticmagic.doc/SubFields

SubFields

open class SubFields<V>(field: BoundField<V, V>) : FieldSet, FieldOperations<V>

Represents Elasticsearch multi-fields: https://www.elastic.co/guide/en/elasticsearch/reference/7.10/multi-fields.html

Constructors

fun <V> SubFields(field: BoundField<V, V>)

Types

UnboundSubFields

class UnboundSubFields<V, F : SubFields<V>>(unboundField: FieldSet.Field<V, V>, subFieldsFactory: (BoundField<V, V>) -> F)

Functions

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

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): V

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

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

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

operator fun get(name: String): MappingField<*>?

fun getAllFields(): Collection<MappingField<*>>

fun getBoundField(): BoundField<V, V>

inline fun <T> getFieldByName(name: String): MappingField<T>

open override fun getFieldName(): String

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

getQualifiedFieldName

open override fun getQualifiedFieldName(): String

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

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

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

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

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

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

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

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

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

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

open override fun toValue(): String

Extensions

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

A shortcut to get boosted field.

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