kform/tech.ostack.kform.validations/UniqueItems

UniqueItems

open class UniqueItems @JvmOverloads constructor(emitAllRepetitions: Boolean = true, val treatNullAsUnique: Boolean = true, code: String = DEFAULT_CODE, severity: ValidationIssueSeverity = ValidationIssueSeverity.Error) : UniqueItemsBy<Any?, Any?> (source)

Validation that ensures that a value does not contain repeated items. Values of type Collection, Array (including variants), and Table are supported.

Depending on emitAllRepetitions, an issue with the provided code (defaults to DEFAULT_CODE) is emitted for each pair of repeated items (when true), or only for the first found repetition (when false). emitAllRepetitions defaults to true.

Each emitted issue has a firstIndex and secondIndex data properties with the two indices of the conflicting items. When running this validation on a table, issues will also contain firstRowId and secondRowId data properties with the ids of the conflicting table rows.

Depending on treatNullAsUnique, null values can be considered unique. I.e. when true (the default), the value listOf(null, null) is considered to not contain repeated items.

This validation is not stateful and depends on all descendants of the value.

Parameters

emitAllRepetitions

Whether to emit an issue per each repeated item or only for the first repetition.

code

Issue code to use when two items of the value are repeated.

severity

Severity of the issue emitted when two items of the value are repeated.

Constructors

UniqueItems

@JvmOverloads

constructor(emitAllRepetitions: Boolean = true, treatNullAsUnique: Boolean = true, code: String = DEFAULT_CODE, severity: ValidationIssueSeverity = ValidationIssueSeverity.Error)

Types

Companion

object Companion

Properties

code

val code: String

Issue code to use when two items of the value are repeated.

dependencies

open override val dependencies: Map<String, DependencyInfo>

Dependencies of the validation. Mapping of keys to the paths this validation depends on. Keys can be used within a ValidationContext to access the value of the dependencies.

dependsOnDescendants

open override val dependsOnDescendants: Boolean = true

Whether the form manager should reevaluate this validation whenever a descendant of the value being validated changes. This is false by default.

emitAllRepetitions

val emitAllRepetitions: Boolean

Whether to emit an issue per each repeated item or only for the first repetition.

externalContextDependencies

open override val externalContextDependencies: Set<String>

Set of external context dependencies of the validation.

schema

protected val ValidationContext.schema: Schema<Any>

Schema of the value being validated.

selector

val selector: (item: Any?) -> Any?

Selector function used to specify the key of an item of the value.

severity

val severity: ValidationIssueSeverity

Severity of the issue emitted when two items of the value are repeated.

treatNullAsUnique

val treatNullAsUnique: Boolean

Whether to treat null values as being unique.

value

protected val ValidationContext.value: Any

Value being validated.

Functions

addDependency

@JvmName(name = "reifiedAddDependency")

protected inline fun <TDependency> addDependency(dependencyKey: String, path: String)

protected fun addDependency(dependencyKey: String, path: String)

@JvmName(name = "reifiedAddDependency")

protected inline fun <TDependency> addDependency(dependencyKey: String, path: Path)

protected fun addDependency(dependencyKey: String, path: Path)

Declares a dependency to path, accessible in the validation's context via key dependencyKey.

addExternalContextDependency

protected fun addExternalContextDependency(externalContextName: String)

Declares an external context dependency to externalContextName.

dependency

protected inline fun <TDependency> dependency(path: String, dependencyKey: String?): PropertyDelegateProvider<Validation<Any>, ReadOnlyProperty<ValidationContext, TDependency>>

protected inline fun <TDependency> dependency(path: Path, dependencyKey: String?): PropertyDelegateProvider<Validation<Any>, ReadOnlyProperty<ValidationContext, TDependency>>

Function used to declare a dependency to a path and delegate access to its value within a ValidationContext.

dependencyOrNull

protected inline fun <TDependency> dependencyOrNull(path: String, dependencyKey: String?): PropertyDelegateProvider<Validation<Any>, ReadOnlyProperty<ValidationContext, TDependency?>>

protected inline fun <TDependency> dependencyOrNull(path: Path, dependencyKey: String?): PropertyDelegateProvider<Validation<Any>, ReadOnlyProperty<ValidationContext, TDependency?>>

Function used to declare a dependency to a path and delegate access to its value within a ValidationContext.

externalContext

protected fun <TContext> externalContext(externalContextName: String?): PropertyDelegateProvider<Validation<Any>, ReadOnlyProperty<ValidationContext, TContext>>

Function used to declare a dependency to an external context and delegate access to its value within a ValidationContext.

externalContextOrNull

protected fun <TContext> externalContextOrNull(externalContextName: String?): PropertyDelegateProvider<Validation<Any>, ReadOnlyProperty<ValidationContext, TContext?>>

Function used to declare a dependency to an external context and delegate access to its value within a ValidationContext.

toString

open override fun toString(): String

validate

open override fun ValidationContext.validate(): Flow<ValidationIssue>

Runs the validation within a ValidationContext containing the value being validated and the value of all declared dependencies. Returns a flow over all found issues.