elasticmagic/dev.evo.elasticmagic.doc/SubDocument

SubDocument

abstract class SubDocument(field: DocSourceField, dynamic: Dynamic? = null) : BaseDocument, FieldOperations<Nothing>

Represents Elasticsearch sub-document.

Constructors

constructor(field: DocSourceField, dynamic: Dynamic? = null)

Types

UnboundSubDocument

class UnboundSubDocument<T : SubDocument>(name: String?, type: ObjectType<BaseDocSource>, params: Params, subDocumentFactory: (DocSourceField) -> T)

Properties

val options: MappingOptions

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

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

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

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

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

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

fun getBoundField(): DocSourceField

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

open override fun getFieldName(): String

open override fun getFieldType(): FieldType<BaseDocSource, Nothing>

fun getParent(): FieldSet

getQualifiedFieldName

open override fun getQualifiedFieldName(): String

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

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

fun SubDocument.list(): BoundField<MutableList<DynDocSource?>, Nothing>

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

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

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

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

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

fun <T : SubDocument> nested(factory: (DocSourceField) -> T, dynamic: Dynamic? = null, params: Params = Params()): SubDocument.UnboundSubDocument<T>

fun <T : SubDocument> nested(name: String?, factory: (DocSourceField) -> T, dynamic: Dynamic? = null, params: Params = Params()): SubDocument.UnboundSubDocument<T>

fun <T : SubDocument> obj(factory: (DocSourceField) -> T, enabled: Boolean? = null, dynamic: Dynamic? = null, params: Params = Params()): SubDocument.UnboundSubDocument<T>

fun <T : SubDocument> obj(name: String?, factory: (DocSourceField) -> T, enabled: Boolean? = null, dynamic: Dynamic? = null, params: Params = Params()): SubDocument.UnboundSubDocument<T>

fun <T : SubDocument> object(factory: (DocSourceField) -> T, enabled: Boolean? = null, dynamic: Dynamic? = null, params: Params = Params()): SubDocument.UnboundSubDocument<T>

fun <T : SubDocument> object(name: String?, factory: (DocSourceField) -> T, enabled: Boolean? = null, dynamic: Dynamic? = null, params: Params = Params()): SubDocument.UnboundSubDocument<T>

open fun oneOf(vararg terms: Nothing): QueryExpression

open infix fun oneOf(terms: List<Nothing>): QueryExpression

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

open fun serializeTerm(v: Nothing): Any

fun <V, F : SubFields<V>> FieldSet.Field<V, V>.subFields(factory: (BoundField<V, V>) -> F): SubFields.UnboundSubFields<V, F>

open override fun toValue(): String