core/com.ekino.oss.metalastic.core/Field

Field

Base class for leaf metamodel fields, i.e. fields that do not contain nested fields.

A Field always belongs to a Container (an ObjectField/Document or a MultiField) that it registers itself with on construction, which makes path traversal and parent lookup possible.

Type Parameters

the Kotlin type carried by this field

Inheritors

Functions

fieldClass

fun fieldClass(): KClass<out T & Any>?

Returns the KClass for this field's type, or null if the type is not a concrete class (e.g., if it's a type parameter or complex type intersection).

fieldType

fun fieldType(): KType

Returns the Kotlin KType carried by this field, as captured at generation time.

isNestedPath

fun isNestedPath(): Boolean

Returns true if any ancestor container is marked as nested in Elasticsearch.

name

fun name(): String

Returns the local Elasticsearch field name, without any parent path segments.

nestedPaths

fun nestedPaths(): Sequence<String>

Returns the paths of the ancestor containers that are marked as nested, closest first.

parent

open override fun parent(): Container<*>

Returns the direct parent container in the metamodel hierarchy, or null for a root.

parents

fun parents(): Sequence<Container<*>>

Returns the sequence of ancestor containers, starting with the direct parent.

path

fun path(): String

Returns the dot-separated Elasticsearch path of this field, built from its ancestor chain.