elasticmagic/dev.evo.elasticmagic.types

Package-level declarations

Types

BaseDateTimeType

abstract class BaseDateTimeType<V> : SimpleFieldType<V>

Base class for date types. Core module doesn't provide any specific implementations. One of implementation you can find inside kotlinx-datetime module.

object BooleanType : SimpleFieldType<Boolean>

Represents boolean values.

object ByteType : NumberType<Byte>

Integer field type represents signed integer value from Byte.MIN_VALUE to Byte.MAX_VALUE.

DoubleRangeType

object DoubleRangeType : RangeType<Double>

A range of double-precision floating point values.

object DoubleType : NumberType<Double>

Double field type represents double-precision floating point value.

class EnumFieldType<V : Enum<V>>(enumValues: Array<V>, fieldValue: EnumValue<V, *>, type: FieldType<*, *>, val termType: KClass<*>) : SimpleFieldType<V>

A field type that transforms enum variants to field values and vice verse.

fun interface EnumValue<V : Enum<V>, T>

An interface that provides field value for an enum. We need this interface hierarchy to be able to make multiple enum extension functions without signature clashing.

interface FieldType<V, T>

A field type is responsible for serialization/deserialization of document and term values. Term values are used in queries, aggregations etc.

object FloatRangeType : RangeType<Float>

A range of single-precision floating point values.

object FloatType : NumberType<Float>

Float field type represents single-precision floating point value.

fun interface IntEnumValue<V : Enum<V>> : EnumValue<V, Int>

An interface that provides integer field value for an enum.

object IntRangeType : RangeType<Int>

A range of signed 32-bit integers.

object IntType : NumberType<Int>

Integer field type represents signed integer value from Int.MIN_VALUE to Int.MAX_VALUE.

data class Join(val name: String, val parent: String? = null)

Join field value.

object JoinType : FieldType<Join, String>

Join field type represents parent-child relations between documents in an index.

KeywordEnumValue

fun interface KeywordEnumValue<V : Enum<V>> : EnumValue<V, String>

An interface that provides string field value for an enum.

object KeywordType : StringType

Keyword field type is used for not-analyzed strings.

object LongRangeType : RangeType<Long>

A range of signed 64-bit integers.

object LongType : NumberType<Long>

Long field type represents signed integer value from Long.MIN_VALUE to Long.MAX_VALUE.

class NestedType<V : BaseDocSource> : ObjectType<V>

Nested field type allows indexing array of objects as separate documents.

abstract class NumberType<V : Number> : SimpleFieldType<V>

Base class for numeric field types.

open class ObjectType<V : BaseDocSource> : FieldType<V, Nothing>

Object field type is used to represent sub-documents.

OptionalListType

class OptionalListType<V, T>(val type: FieldType<V, T>) : FieldType<MutableList<V?>, T>

Serializes/deserializes type into list of optional values. Used by dev.evo.elasticmagic.doc.DocSource.

data class Range<V>(val gt: V? = null, val gte: V? = null, val lt: V? = null, val lte: V? = null)

A class that represents field value for range types.

abstract class RangeType<V>(type: FieldType<V, V>) : FieldType<Range<V>, V>

A base class for range field types.

RequiredListType

class RequiredListType<V, T>(val type: FieldType<V, T>) : FieldType<MutableList<V & Any>, T>

Serializes/deserializes type into list of required values. Used by dev.evo.elasticmagic.doc.DocSource.

object ShortType : NumberType<Short>

Integer field type represents signed integer value from Short.MIN_VALUE to Short.MAX_VALUE.

SimpleFieldType

abstract class SimpleFieldType<V> : FieldType<V, V>

Base field type for types with the same field and term value types.

class SimpleListType<V>(val type: SimpleFieldType<V>) : SimpleFieldType<List<V & Any>>

Serializes/deserializes type into list of values. Might be used in aggregations.

abstract class StringType : SimpleFieldType<String>

Base class for string types.

object TextType : StringType

Text field type is used for full-text search.

ValueDeserializationException

class ValueDeserializationException(value: Any?, type: String, cause: Throwable? = null) : IllegalArgumentException

An exception for deserialization errors.

ValueSerializationException

class ValueSerializationException(value: Any?, cause: Throwable? = null) : IllegalArgumentException

An exception for serialization errors.

Functions

fun deErr(v: Any?, type: String, cause: Throwable? = null): Nothing

A shortcut to throw ValueDeserializationException.

fun serErr(v: Any?, cause: Throwable? = null): Nothing

A shortcut to throw ValueSerializationException.