wow-query/me.ahoo.wow.query.schema/QueryValueSchema

QueryValueSchema

class QueryValueSchema(val kind: QueryValueKind, val title: String? = null, val description: String? = null, enumValues: List<JsonNode>? = null, enumDescriptions: Map<JsonNode, String> = emptyMap(), valueTypes: Set<QueryValueType> = if (kind == QueryValueKind.OBJECT) setOf(QueryValueType.OBJECT) else emptySet(), properties: Map<String, QueryValueSchema> = emptyMap(), val items: QueryValueSchema? = null, val additionalProperties: QueryValueSchema? = null, alternatives: List<QueryValueSchema> = emptyList(), val nullable: Boolean = kind != QueryValueKind.UNION || alternatives.any { it.nullable }, val required: Boolean = false, val semanticType: QuerySemanticType? = null, val maskRule: MaskRule? = null, val variant: String? = null, aliases: Set<QueryField> = emptySet(), val deprecated: QueryDeprecation? = null)

One immutable logical value shape, shared by backend schema snapshots. Collection inputs are snapshotted; mutable enum JSON is detached on read.

Constructors

QueryValueSchema

constructor(kind: QueryValueKind, title: String? = null, description: String? = null, enumValues: List<JsonNode>? = null, enumDescriptions: Map<JsonNode, String> = emptyMap(), valueTypes: Set<QueryValueType> = if (kind == QueryValueKind.OBJECT) setOf(QueryValueType.OBJECT) else emptySet(), properties: Map<String, QueryValueSchema> = emptyMap(), items: QueryValueSchema? = null, additionalProperties: QueryValueSchema? = null, alternatives: List<QueryValueSchema> = emptyList(), nullable: Boolean = kind != QueryValueKind.UNION || alternatives.any { it.nullable }, required: Boolean = false, semanticType: QuerySemanticType? = null, maskRule: MaskRule? = null, variant: String? = null, aliases: Set<QueryField> = emptySet(), deprecated: QueryDeprecation? = null)

Properties

additionalProperties

val additionalProperties: QueryValueSchema?

aliases

val aliases: Set<QueryField>

Other logical paths that name this value.

alternatives

val alternatives: List<QueryValueSchema>

cardinality

val cardinality: QueryCardinality?

deprecated

val deprecated: QueryDeprecation?

Set when the field is kept only for existing callers.

description

val description: String?

enumDescriptions

val enumDescriptions: Map<JsonNode, String>

What each enum value means, by value; values without a description are absent.

enumValues

val enumValues: List<JsonNode>?

items

val items: QueryValueSchema?

kind

val kind: QueryValueKind

maskRule

val maskRule: MaskRule?

nullable

val nullable: Boolean

properties

val properties: Map<String, QueryValueSchema>

required

val required: Boolean

semanticType

val semanticType: QuerySemanticType?

title

val title: String?

valueTypes

val valueTypes: Set<QueryValueType>

variant

val variant: String?

The discriminator value when this value is one variant of a variant payload, such as an event's bodyType.

Functions

alternativesOrSelf

fun QueryValueSchema.alternativesOrSelf(): List<QueryValueSchema>

Flattens nested unions into their non-union alternatives; any other value is its own single alternative.

hasArrayBranch

fun QueryValueSchema.hasArrayBranch(): Boolean

Whether any alternative of this value is an array, so storage may flatten it into multiple values.

isElementScope

fun QueryValueSchema.isElementScope(): Boolean

Whether this value can be an element scope: every non-null alternative is an array whose non-null items are all objects, so a predicate can match one element as a whole.

operationValues

fun QueryValueSchema.operationValues(): List<QueryValueSchema>

Operations on primitive arrays use one member layer, without flattening the definition.

storageFamilies

fun QueryValueSchema.storageFamilies(capability: QueryCapability, rules: QueryStorageFamilyRules = QueryStorageFamilyRules.STRICT): List<Set<QueryStorageFamily>>

The native type families this scalar value needs for capability: one set per declared alternative, and storage proves the capability when its native types cover every set and fall in some set. An empty list, or a list with an empty set, means no storage can prove the capability for this value.