stormify/onl.ycode.stormify.biglist

Package-level declarations

Types

abstract class AbstractPagedList<T : Any> : AbstractList<T> , StormifyAware

Abstract base class for PagedList — a UI-model façade over the shared PagedQueryCore engine. Users do not instantiate this directly; use the platform-specific PagedList subclass instead (it provides language-idiomatic constructors for Kotlin and Java).

AbstractPagedQuery

abstract class AbstractPagedQuery<T : Any> : StormifyAware

Abstract base class for PagedQuery — a stateless, thread-safe query executor designed for server-side use (REST, RPC, gRPC, any stateless request/response context). Users do not instantiate this directly; use the platform-specific PagedQuery subclass instead.

AndNode

data class AndNode(val children: List<TextNode>) : TextNode

Conjunction (AND) of multiple children.

BetweenNode

data class BetweenNode(val low: String, val high: String) : OrderedNode

low...high — inclusive range.

Converter

typealias Converter = (column: String, input: String, parser: InputParser, args: SqlArgsCollector) -> String

Converts a facet filter value into a SQL condition fragment.

EqualNode

data class EqualNode(val value: String) : OrderedNode

value — exact match.

Facet

class Facet

A facet is a named, user-facing filter/sort slot exposed by a PagedList or PagedQuery. It is the only point of interaction between the outside world and the underlying query — the facet's alias is the opaque public identifier, and SQL paths / expressions behind it are kept internal.

FieldPath

data class FieldPath(val segments: List<String>)

Represents a field path through FK relationships, using dot notation.

FilterCountedValue

data class FilterCountedValue(val value: String, val count: Long)

A distinct value for a column together with the row count of that value under the parent list's current filter state. Returned by FilterCountedValues.

FilterCountedValues

class FilterCountedValues : FilterValuesBase<FilterCountedValue>

A lazy-loading paginated list of distinct values for a Facet together with the row count of each value under the parent list's current filter state (excluding the owning column's own filter). Obtained via FilterValues.withCounts.

FilterSyntax

data class FilterSyntax(val or: String = "OR", val not: String = "-", val nullToken: String = "NULL", val phraseDelimiter: Char = '"', val groupOpen: Char = '(', val groupClose: Char = ')', val wildcard: Char = '*')

Configurable token set for TextQuery parsing. Lets you localise the boolean search syntax — e.g. use | for OR instead of OR, -- for NULL, or Greek/German keywords.

FilterValues

class FilterValues : FilterValuesBase<String>

A lazy-loading paginated list of distinct string values for a Facet.

FilterValuesBase

abstract class FilterValuesBase<E> : AbstractList<E>

Shared base for FilterValues and FilterCountedValues. Holds the pagination state and the per-page buffer. Subclasses only implement loadPage to produce either String values or FilterCountedValue objects.

GreaterOrEqualNode

data class GreaterOrEqualNode(val value: String) : OrderedNode

>= value

GreaterThanNode

data class GreaterThanNode(val value: String) : OrderedNode

> value

HumanReadable

interface HumanReadable

Interface for entities or enum values that provide a localized, human-readable display name.

InputParser

typealias InputParser = (String, Facet.Type) -> String

Transforms user filter input before it reaches the database — e.g. locale-aware number/date parsing. Resolution chain: Facet.inputParser → PagedList.inputParser → onl.ycode.stormify.Stormify.inputParser → identity.

LessOrEqualNode

data class LessOrEqualNode(val value: String) : OrderedNode

<= value

LessThanNode

data class LessThanNode(val value: String) : OrderedNode

< value

MultiAggregator

class MultiAggregator

A multi-value aggregator built from a chain of aggregation requests over a PagedList. Each chain method adds another expression to the generated SELECT list. execute returns a Map<String, Any?> keyed by the alias of each added aggregation.

NotNode

data class NotNode(val child: TextNode) : TextNode

Negation of a child node.

NullNode

data object NullNode : TextNode

The null sentinel — matches rows where the column is SQL NULL.

OrderedNode

sealed interface OrderedNode

Parsed operator expression for ordered (numeric/temporal) facet filters. Returned by OrderedQuery.parse.

OrderedQuery

object OrderedQuery

Parses the operator syntax for numeric and temporal facet filters: >, <, >=, <=, low...high, or a bare value for equality.

OrNode

data class OrNode(val children: List<TextNode>) : TextNode

Disjunction (OR) of multiple children.

Page

data class Page<T>(val rows: List<T>, val total: Long, val page: Int, val pageSize: Int)

Result of a PagedQuery.execute call. Contains the rows for the requested page, the total matching row count, and pagination metadata — everything a typical REST response needs without a second round-trip.

PagedAggregator

class PagedAggregator

Entry point for the aggregation DSL on a PagedList.

PagedList

open class PagedList<T : Any> : AbstractPagedList<T>

Facet-based lazy paginated list view of entities of type T.

open class PagedList<T : Any>(classType: KClass<T>) : AbstractPagedList<T>

Facet-based lazy paginated list view of entities of type T.

PagedListSort

object PagedListSort

Sentinel sort-direction values for PagedListState.sorts entries. Declared outside PagedListState so the data class stays strictly plain data with no companion members that could confuse a naive reflection-based serializer.

PagedListState

data class PagedListState(val filters: Map<String, String> = emptyMap(), val sorts: Map<String, String> = emptyMap(), val caseSensitive: Map<String, Boolean> = emptyMap(), val pageSize: Int = 15, val isDistinct: Boolean = false)

Serializable snapshot of a PagedList's user-controllable state — the per-column filters, sorts, case-sensitivity flags, the page size and the distinct flag.

PagedQuery

open class PagedQuery<T : Any> : AbstractPagedQuery<T>

Stateless, thread-safe paginated query executor for entities of type T.

open class PagedQuery<T : Any>(classType: KClass<T>) : AbstractPagedQuery<T>

Stateless, thread-safe paginated query executor for entities of type T.

PageSpec

data class PageSpec @JvmOverloads constructor(val page: Int, val pageSize: Int, val filters: Map<String, String> = emptyMap(), val sorts: Map<String, SortDir> = emptyMap(), val caseSensitive: Map<String, Boolean> = emptyMap())

Per-request specification passed to PagedQuery.execute and friends. Describes the filters, sorts, case-sensitivity flags and pagination the caller wants for this single query. Keys in the map fields are facet aliases (see Facet.alias); any alias not present in the map contributes nothing to the generated SQL.

PhraseNode

data class PhraseNode(val text: String) : TextNode

A quoted phrase — treated as literal substring (operators and wildcards inside are ignored).

ReferencePath

open class ReferencePath(val path: String)

Base class for annotation-processor-generated reference path nodes (e.g. AuditEntry_.modifiedBy). Each reference node carries the accumulated dot-notation path it represents — with a trailing . when further chaining through this node is still possible — and subclasses use that stored value to build the next path step when chaining into nested reference or scalar fields.

ScalarPath

open class ScalarPath(val path: String)

A type-safe field path node representing a scalar (leaf) field. Generated by the annotation processor and used with PagedList.addFacet.

SingleAggregator

expect class SingleAggregator

A single-aggregation view on a PagedAggregator chain. Returned by each PagedAggregator builder method (the "one aggregate" case).

actual class SingleAggregator

JVM / Android actual of SingleAggregator. Adds a Java-friendly execute(Class<R>) overload on top of the common API so Java callers can write agg.sum(path).execute(BigDecimal.class).

actual class SingleAggregator

Native actual of SingleAggregator. Delegates to the shared SingleAggregatorCore with no platform-specific additions.

SortDir

enum SortDir : Enum<SortDir>

Sort direction for entries in PageSpec.sorts. Declared as an enum (not a SortState alias) so the public REST-facing contract stays decoupled from the UI-model's internal sort-state representation.

SortState

enum SortState : Enum<SortState>

The sort direction of a Facet.

SqlArgsCollector

fun interface SqlArgsCollector

Callback used by Converter implementations to stage a bind parameter for the generated SQL placeholder. Each call adds one ? value to the query in order.

TableRef

class TableRef

A handle to a node in the query's JOIN tree — either the root entity table or an FK-traversed table reached through a dotted path. Exposes the engine-assigned SQL alias so raw SQL expressions (in Facets built via addSqlFacet, or in setConstraints) can reference the right table regardless of how the engine numbers its joined aliases.

TermNode