elasticmagic/dev.evo.elasticmagic.doc/DynamicTemplates

DynamicTemplates

abstract class DynamicTemplates : RootFieldSet

Constructors

Link copied to clipboard

Types

Link copied to clipboard
object Companion
Link copied to clipboard
sealed class DynamicField<V, T, F>
Link copied to clipboard
class Mapping(val index: Boolean? = null, val docValues: Boolean? = null, val store: Boolean? = null, val params: Params = Params())
Link copied to clipboard
Link copied to clipboard
class MappingTemplate<V, T, F>(    val name: String? = null,     val mapping: DynamicTemplates.DynamicField<V, T, F>,     val matchOptions: DynamicTemplates.MatchOptions)
Link copied to clipboard
sealed class MatchMappingType<V, T> : ToValue<String>
Link copied to clipboard
data class MatchOptions(    val match: String? = null,     val unmatch: String? = null,     val pathMatch: String? = null,     val pathUnmatch: String? = null,     val matchPattern: DynamicTemplates.MatchPattern? = null,     val matchMappingType: DynamicTemplates.MatchMappingType<*, *>? = null,     val params: Params? = null)
Link copied to clipboard
Link copied to clipboard
sealed class Runtime

Functions

Link copied to clipboard
operator fun get(name: String): MappingField<*>?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
inline fun <T> getFieldByName(name: String): MappingField<T>
Link copied to clipboard
open override fun getFieldName(): String
Link copied to clipboard
open override fun getQualifiedFieldName(): String
Link copied to clipboard
fun getTemplate(name: String): BoundMappingTemplate<*, *, *>?
Link copied to clipboard
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>
Link copied to clipboard
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>
Link copied to clipboard
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>
Link copied to clipboard
Link copied to clipboard
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.

Link copied to clipboard
open override fun toValue(): String

Inheritors

Link copied to clipboard