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

Package-level declarations

Types

class BeanQuerySchemaSource(registrations: List<QuerySchemaRegistration>) : QuerySchemaSource

class ClasspathQuerySchemaSource(classLoader: ClassLoader = Thread.currentThread().contextClassLoader ?: ClasspathQuerySchemaSource::class.java.classLoader) : QuerySchemaSource

DeclarationValue

sealed interface DeclarationValue<out T>

DefaultQueryModelSchemaProvider

class DefaultQueryModelSchemaProvider(context: QuerySchemaContext, sources: List<QuerySchemaSource>, adapter: QuerySchemaBackendAdapter) : QueryModelSchemaProvider

LogicalQuerySchema

class LogicalQuerySchema(val root: QueryValueSchema)

A logical definition is shared unchanged with every native binding snapshot.

MaskRule

class MaskRule(val strategyType: KClass<out MaskStrategy<*>>, val annotation: Annotation, val compiled: CompiledMask)

QueryFieldBinding

class QueryFieldBinding(val physicalField: QueryField, storageTypes: Set<QueryStorageType>?)

QueryFieldBindingTemplate

class QueryFieldBindingTemplate(val physicalPath: QueryPathTemplate, storageTypes: Set<QueryStorageType>?)

QueryFieldDeclaration

data class QueryFieldDeclaration(val title: DeclarationValue<String?> = DeclarationValue.Unset, val description: DeclarationValue<String?> = DeclarationValue.Unset, val enumValues: DeclarationValue<List<JsonNode>?> = DeclarationValue.Unset, val valueTypes: DeclarationValue<Set<QueryValueType>> = DeclarationValue.Unset, val nullable: DeclarationValue<Boolean> = DeclarationValue.Unset, val required: DeclarationValue<Boolean> = DeclarationValue.Unset, val kind: DeclarationValue<QueryValueKind> = DeclarationValue.Unset, val properties: DeclarationValue<Map<String, QueryFieldDeclaration>> = DeclarationValue.Unset, val items: DeclarationValue<QueryFieldDeclaration?> = DeclarationValue.Unset, val additionalProperties: DeclarationValue<QueryFieldDeclaration?> = DeclarationValue.Unset, val alternatives: DeclarationValue<List<QueryFieldDeclaration>> = DeclarationValue.Unset, val semanticType: DeclarationValue<QuerySemanticType?> = DeclarationValue.Unset, val maskRule: DeclarationValue<MaskRule> = DeclarationValue.Unset)

QueryFieldDeclarationBuilder

class QueryFieldDeclarationBuilder

QueryFieldSchema

class QueryFieldSchema(val logicalField: QueryField, val value: QueryValueSchema, elementAncestors: List<QueryField>?, bindings: Map<QueryCapability, QueryFieldBinding>, val projectionField: QueryField?, val responseField: QueryField?)

QueryModelSchema

class QueryModelSchema(val model: QueryModel, capabilities: Set<QueryCapability>, val definition: LogicalQuerySchema, bindings: Map<QueryPathTemplate, QueryValueBindings>, val fullProjectionAvailable: Boolean = true)

Published facts only: model values and operation-specific native locations.

QueryModelSchemaProvider

interface QueryModelSchemaProvider

QueryPathSegment

sealed interface QueryPathSegment

Schema path parts; keys are captured by logical lookup, items describe array traversal.

QueryPathTemplate

class QueryPathTemplate

QuerySchemaBackendAdapter

interface QuerySchemaBackendAdapter

QuerySchemaConflictException

class QuerySchemaConflictException(message: String, cause: Throwable? = null) : QuerySchemaException

QuerySchemaContext

data class QuerySchemaContext(val namedAggregate: NamedAggregate, val model: QueryModel)

QuerySchemaDeclaration

data class QuerySchemaDeclaration(val fields: Map<QueryField, QueryFieldDeclaration>)

QuerySchemaDeclarationBuilder

class QuerySchemaDeclarationBuilder

QuerySchemaDeclarationProperties

object QuerySchemaDeclarationProperties

QuerySchemaException

sealed class QuerySchemaException : WowException

QuerySchemaRegistration

data class QuerySchemaRegistration(val context: QuerySchemaContext, val declaration: QuerySchemaDeclaration)

QuerySchemaSource

interface QuerySchemaSource

QuerySchemaSourcePriority

object QuerySchemaSourcePriority

QuerySchemaUnavailableException

class QuerySchemaUnavailableException(message: String, cause: Throwable? = null) : QuerySchemaException

QuerySchemaValidationException

class QuerySchemaValidationException(message: String, cause: Throwable? = null) : QuerySchemaException

QueryStorageType

data class QueryStorageType(val value: String)

QueryValueBindings

class QueryValueBindings(bindings: Map<QueryCapability, QueryFieldBindingTemplate> = emptyMap(), val projectionPath: QueryPathTemplate? = null, val responsePath: QueryPathTemplate? = null)

QueryValueSchema

class QueryValueSchema(val kind: QueryValueKind, val title: String? = null, val description: String? = null, enumValues: List<JsonNode>? = null, 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)

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

SystemQuerySchemaSource

object SystemQuerySchemaSource : QuerySchemaSource

WorkingDirectoryQuerySchemaSource

class WorkingDirectoryQuerySchemaSource(basePath: Path = Path.of("config"), readText: (Path) -> String = Files::readString) : QuerySchemaSource

Functions

absoluteLogicalField

fun absoluteLogicalField(field: QueryField, parent: QueryField?): QueryField

operationValues

fun QueryValueSchema.operationValues(): List<QueryValueSchema>

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

physicalField

fun QueryModelSchema.physicalField(field: QueryField, capability: QueryCapability, logicalParent: QueryField? = null): QueryField

A native compiler consumes a binding; it never guesses physical names from caller input.

projectionField

fun QueryModelSchema.projectionField(field: QueryField): QueryField

querySchemaRegistration

fun querySchemaRegistration(aggregateType: KClass<*>, model: QueryModel, block: QuerySchemaDeclarationBuilder.() -> Unit): QuerySchemaRegistration

toMetadata

fun QueryModelSchema.toMetadata(): QueryModelSchemaMetadata

validateQuery

fun validateQuery(query: AggregationQuery, schema: QueryModelSchema): AggregationQuery

fun validateQuery(query: FilterExpression, schema: QueryModelSchema): FilterExpression

fun validateQuery(query: ICursorQuery, schema: QueryModelSchema): ICursorQuery

fun validateQuery(query: IListQuery, schema: QueryModelSchema): IListQuery

fun validateQuery(query: IPagedQuery, schema: QueryModelSchema): IPagedQuery

fun validateQuery(query: ISingleQuery, schema: QueryModelSchema): ISingleQuery

fun validateQuery(projection: Projection, schema: QueryModelSchema): Projection