elasticmagic/dev.evo.elasticmagic.doc/Document

Document

abstract class Document(val options: MappingOptions = MappingOptions()) : DynamicTemplates

Base class for describing a top level Elasticsearch document.

Constructors

fun Document( dynamic: Dynamic? = null, numericDetection: Boolean? = null, dateDetection: Boolean? = null, dynamicDateFormats: List<String>? = null)

Document

fun Document(options: MappingOptions = MappingOptions())

Types

RuntimeField

class RuntimeField<V>(val name: String?, val type: FieldType<V, V>, val script: Script)

Functions

get

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

getAllFields

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

getAllTemplates

fun getAllTemplates(): Collection<BoundMappingTemplate<*, *, *>>

getFieldByName

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

getFieldName

open override fun getFieldName(): String

getQualifiedFieldName

open override fun getQualifiedFieldName(): String

getTemplate

fun getTemplate(name: String): BoundMappingTemplate<*, *, *>?

nested

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>

obj

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>

object

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>

runtimeField

fun <V> runtimeField(name: String, type: FieldType<V, V>, script: Script): BoundRuntimeField<V>

subFields

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

template

fun template( name: String? = null, mapping: DynamicTemplates.Mapping, match: String? = null, unmatch: String? = null, pathMatch: String? = null, pathUnmatch: String? = null, matchPattern: DynamicTemplates.MatchPattern? = null, params: Params? = null): DynamicTemplates.MappingTemplate<Any, Any, BoundField<Any, Any>>

Template without field type.

fun template( name: String? = null, runtime: DynamicTemplates.Runtime.Simple, match: String? = null, unmatch: String? = null, pathMatch: String? = null, pathUnmatch: String? = null, matchPattern: DynamicTemplates.MatchPattern? = null, params: Params? = null): DynamicTemplates.MappingTemplate<Any, Any, BoundField<Any, Any>>

Template for a runtime field.

fun <V, T> template( name: String? = null, mapping: DynamicTemplates.Mapping, matchMappingType: DynamicTemplates.MatchMappingType<V, T>, match: String? = null, unmatch: String? = null, pathMatch: String? = null, pathUnmatch: String? = null, matchPattern: DynamicTemplates.MatchPattern? = null, params: Params? = null): DynamicTemplates.MappingTemplate<V, T, BoundField<V, T>>

Template with field type detected by JSON parser.

fun <V, T> template( name: String? = null, runtime: DynamicTemplates.Runtime.Simple, matchMappingType: DynamicTemplates.MatchMappingType<V, T>, match: String? = null, unmatch: String? = null, pathMatch: String? = null, pathUnmatch: String? = null, matchPattern: DynamicTemplates.MatchPattern? = null, params: Params? = null): DynamicTemplates.MappingTemplate<V, T, BoundField<V, T>>

Template for a runtime field which type is detected by a JSON parser.

fun <V, T> template( name: String? = null, runtime: DynamicTemplates.Runtime.Typed<V, T>, matchMappingType: DynamicTemplates.MatchMappingType<*, *>? = null, match: String? = null, unmatch: String? = null, pathMatch: String? = null, pathUnmatch: String? = null, matchPattern: DynamicTemplates.MatchPattern? = null, params: Params? = null): DynamicTemplates.MappingTemplate<V, T, BoundField<V, T>>

Template for a runtime field with a specified type.

fun <V, T> template( name: String? = null, mapping: FieldSet.Field<V, T>, matchMappingType: DynamicTemplates.MatchMappingType<*, *>? = null, match: String? = null, unmatch: String? = null, pathMatch: String? = null, pathUnmatch: String? = null, matchPattern: DynamicTemplates.MatchPattern? = null, params: Params? = null): DynamicTemplates.MappingTemplate<V, T, BoundField<V, T>>

Template with field type from mapping.

fun <F : SubDocument> template( name: String? = null, mapping: SubDocument.UnboundSubDocument<F>, matchMappingType: DynamicTemplates.MatchMappingType<*, *>? = null, match: String? = null, unmatch: String? = null, pathMatch: String? = null, pathUnmatch: String? = null, matchPattern: DynamicTemplates.MatchPattern? = null, params: Params? = null): DynamicTemplates.MappingTemplate<Any, Nothing, F>

Template for a sub-document field.

fun <V, F : SubFields<V>> template( name: String? = null, mapping: SubFields.UnboundSubFields<V, F>, matchMappingType: DynamicTemplates.MatchMappingType<*, *>? = null, match: String? = null, unmatch: String? = null, pathMatch: String? = null, pathUnmatch: String? = null, matchPattern: DynamicTemplates.MatchPattern? = null, params: Params? = null): DynamicTemplates.MappingTemplate<V, V, F>

Template for a field with sub-fields.

toValue

open override fun toValue(): String

Document

Constructors

Types

Functions

Properties