Package su.onno.ui

Class DocumentQueryService

java.lang.Object

su.onno.ui.DocumentQueryService

public class DocumentQueryService
extends Object

Read-side queries for documents (list with optional date range; detail with tabular sections), shared by the REST API and the DivKit emitters. Pure data access — access control stays with the callers.

Constructor Summary

Constructors

Constructor	Description
DocumentQueryService(MetadataRegistry registry, org.jdbi.v3.core.Jdbi jdbi)

Method Summary

Modifier and Type	Method	Description
BigDecimal	aggregate(DocumentDescriptor desc, String metric, String field, String filter)	A single aggregate value for a count/metric card — count of rows, or sum|avg|min|max of one numeric column — restricted to live records and narrowed by an optional safe filter predicate (see WidgetFilter).
Map<String,Object>	aggregateBuckets(DocumentDescriptor desc, WidgetBuckets.Request request)	Grouped aggregate buckets for a chart/stat widget — a server-side GROUP BY returning O(buckets) rows instead of the whole table (#199).
long	count(DocumentDescriptor desc)
long	count(DocumentDescriptor desc, String search, String from, String to, List<String> eq, List<String> in, List<String> like, List<String> prefix, List<String> ge, List<String> le, String widgetFilter)	Total live rows matching the search (+ optional date range, declarative filters, widget filter).
Long	estimateCount(DocumentDescriptor desc, boolean filtered)	A cheap live-row estimate for the scroll-height hint, or null when none is available (H2, or any active search/date-range/filter).
DocumentDescriptor	forClass(Class<?> clazz)	The document descriptor for a domain class, or null if it isn't a registered document.
Map<String,Object>	get(DocumentDescriptor desc, UUID id)
ListGroups.GroupResult	groups(DocumentDescriptor desc, String groupColumn, String granularity, String search, String from, String to, List<String> eq, List<String> in, List<String> like, List<String> prefix, List<String> ge, List<String> le, String widgetFilter, List<ListGroups.Agg> aggregates)	Group a document list by groupColumn (a validated sortable column): one header per distinct value, or — for a date/time column (e.g.
KeysetPage	keysetPage(DocumentDescriptor desc, String cursorToken, int limit, String sortColumn, boolean descending, String search, String from, String to, List<String> eq, List<String> in, List<String> like, List<String> prefix, List<String> ge, List<String> le, String widgetFilter)	One keyset-paginated window of a document list — the constant-time default for the list grid.
Map<String,Object>	newDraft(DocumentDescriptor desc)	The seed row for a new document form: a fresh instance's field-initializer defaults in the same column-keyed, ref-resolved shape get(su.onno.metadata.DocumentDescriptor, java.util.UUID) returns for an existing record, so the New form pre-fills declared defaults instead of opening blank (issue #181).
Map<String,Object>	newDraft(DocumentDescriptor desc, Map<String,String> prefill)	As newDraft(DocumentDescriptor), but overlays caller-supplied initial values (from the New-form navigation query, keyed by attribute field name) onto the seed row before ref/enum resolution — so a deep link like …/new?startsAt=…&room=<id> pre-fills those fields.
DocumentDescriptor	require(String name)
List<Map<String,Object>>	rowsByIds(DocumentDescriptor desc, List<UUID> ids)	Fetch specific live documents by id, decorated like keyset rows (refs resolved, secrets redacted) so the list island can refresh just the rows that changed instead of re-paging the whole window.
List<Map<String,Object>>	search(DocumentDescriptor desc, String query, int limit)	Capped, case-insensitive typeahead for the document ref picker.
List<Map<String,Object>>	search(DocumentDescriptor desc, String query, int limit, String filter)	As search(DocumentDescriptor, String, int), additionally narrowed by a WidgetFilter predicate — the cascading ref picker sends its resolved refFilter here, so only compatible documents are offered.
Set<String>	sortableColumns(DocumentDescriptor desc)	Columns that may be sorted on: the system columns + every attribute column.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DocumentQueryService

public DocumentQueryService(MetadataRegistry registry,
 org.jdbi.v3.core.Jdbi jdbi)

Method Details

require

public DocumentDescriptor require(String name)

forClass

public DocumentDescriptor forClass(Class<?> clazz)

The document descriptor for a domain class, or null if it isn't a registered document.

search

public List<Map<String,Object>> search(DocumentDescriptor desc,
 String query,
 int limit)

Capped, case-insensitive typeahead for the document ref picker. Matches across the same text columns the paged list search covers — number plus every (non-secret) String attribute — so a document is findable by a secondary attribute, not just its number (issue #184). Live records only, newest first.

search

public List<Map<String,Object>> search(DocumentDescriptor desc,
 String query,
 int limit,
 String filter)

As search(DocumentDescriptor, String, int), additionally narrowed by a WidgetFilter predicate — the cascading ref picker sends its resolved refFilter here, so only compatible documents are offered. Ref/enum columns bind as typed uuids (PG-strict); a null/blank/invalid predicate is simply no filter.

newDraft

public Map<String,Object> newDraft(DocumentDescriptor desc)

The seed row for a new document form: a fresh instance's field-initializer defaults in the same column-keyed, ref-resolved shape get(su.onno.metadata.DocumentDescriptor, java.util.UUID) returns for an existing record, so the New form pre-fills declared defaults instead of opening blank (issue #181).

newDraft

public Map<String,Object> newDraft(DocumentDescriptor desc,
 Map<String,String> prefill)

As newDraft(DocumentDescriptor), but overlays caller-supplied initial values (from the New-form navigation query, keyed by attribute field name) onto the seed row before ref/enum resolution — so a deep link like …/new?startsAt=…&room=<id> pre-fills those fields.

count

public long count(DocumentDescriptor desc)

keysetPage

public KeysetPage keysetPage(DocumentDescriptor desc,
 String cursorToken,
 int limit,
 String sortColumn,
 boolean descending,
 String search,
 String from,
 String to,
 List<String> eq,
 List<String> in,
 List<String> like,
 List<String> prefix,
 List<String> ge,
 List<String> le,
 String widgetFilter)

One keyset-paginated window of a document list — the constant-time default for the list grid. Seeks past cursorToken (null/blank for the first window) instead of counting past an offset, so deep paging stays O(window). Honors sort/search/date-range/filters, fetches one extra row for hasMore (no COUNT), and mints the next cursor from the last row. The default newest-first order seeks on (_date, _id).

estimateCount

public Long estimateCount(DocumentDescriptor desc,
 boolean filtered)

A cheap live-row estimate for the scroll-height hint, or null when none is available (H2, or any active search/date-range/filter). Uses PostgreSQL planner statistics (pg_class.reltuples) so it never scans the table; callers wanting an exact figure use count(su.onno.metadata.DocumentDescriptor) instead.

rowsByIds

public List<Map<String,Object>> rowsByIds(DocumentDescriptor desc,
 List<UUID> ids)

Fetch specific live documents by id, decorated like keyset rows (refs resolved, secrets redacted) so the list island can refresh just the rows that changed instead of re-paging the whole window. Returns only the rows that still exist and aren't deletion-marked.

count

public long count(DocumentDescriptor desc,
 String search,
 String from,
 String to,
 List<String> eq,
 List<String> in,
 List<String> like,
 List<String> prefix,
 List<String> ge,
 List<String> le,
 String widgetFilter)

Total live rows matching the search (+ optional date range, declarative filters, widget filter).

groups

public ListGroups.GroupResult groups(DocumentDescriptor desc,
 String groupColumn,
 String granularity,
 String search,
 String from,
 String to,
 List<String> eq,
 List<String> in,
 List<String> like,
 List<String> prefix,
 List<String> ge,
 List<String> le,
 String widgetFilter,
 List<ListGroups.Agg> aggregates)

Group a document list by groupColumn (a validated sortable column): one header per distinct value, or — for a date/time column (e.g. _date) — per granularity bucket, over the same WHERE (search + date range + declarative + widget filters) as the flat list. Each header carries its row count, the requested aggregates, and the expand filter the client replays on the normal feed. Headers capped at ListGroups.MAX_GROUPS.

sortableColumns

public Set<String> sortableColumns(DocumentDescriptor desc)

Columns that may be sorted on: the system columns + every attribute column.

aggregate

public BigDecimal aggregate(DocumentDescriptor desc,
 String metric,
 String field,
 String filter)

A single aggregate value for a count/metric card — count of rows, or sum|avg|min|max of one numeric column — restricted to live records and narrowed by an optional safe filter predicate (see WidgetFilter).

aggregateBuckets

public Map<String,Object> aggregateBuckets(DocumentDescriptor desc,
 WidgetBuckets.Request request)

Grouped aggregate buckets for a chart/stat widget — a server-side GROUP BY returning O(buckets) rows instead of the whole table (#199). See WidgetBuckets.

get

public Map<String,Object> get(DocumentDescriptor desc,
 UUID id)