Class: TagQueryExecutor
@flyze/lib-data-store 3.0.0-alpha.55· latestDefined in: projects/lib-data-store/src/lib/flyze-api/gridify-filter/tag.filter.ts:33
Extends
Section titled “Extends”AbstractQueryExecutor<TagQueryBuilder,Tag>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new TagQueryExecutor(
expression):TagQueryExecutor
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:136
Parameters
Section titled “Parameters”expression
Section titled “expression”ExecutableQuery<string, IAbstractGridifyQuery>
Returns
Section titled “Returns”TagQueryExecutor
Inherited from
Section titled “Inherited from”AbstractQueryExecutor< TagQueryBuilder, Tag >.constructor
Properties
Section titled “Properties”mapper
Section titled “mapper”
readonlymapper:object
Defined in: projects/lib-data-store/src/lib/flyze-api/gridify-filter/tag.filter.ts:37
Per-key resolver. Each entry can be a bare function (legacy) or a
MapperDescriptor declaring multi-value, unsupported, or
cross-section requires semantics.
createdAt()
Section titled “createdAt()”createdAt: (
model) =>Date
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Date
customId()
Section titled “customId()”customId: (
model) =>string|null|undefined
Parameters
Section titled “Parameters”Returns
Section titled “Returns”string | null | undefined
displayName()
Section titled “displayName()”displayName: (
model) =>string|null|undefined
Parameters
Section titled “Parameters”Returns
Section titled “Returns”string | null | undefined
id:
object
id.index
Section titled “id.index”index:
object
id.index.kind
Section titled “id.index.kind”kind:
"localId"
id.map()
Section titled “id.map()”map: (
model) =>string
Parameters
Section titled “Parameters”Returns
Section titled “Returns”string
updatedAt()
Section titled “updatedAt()”updatedAt: (
model) =>Date
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Date
Overrides
Section titled “Overrides”AbstractQueryExecutor.mapper
Methods
Section titled “Methods”apply()
Section titled “apply()”apply(
rows,ctx?):Tag[]
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:208
Single-call pipeline: filter → sort → paginate. Most consumers
should use this; callers that need the unpaginated total should use
applyWithCount instead.
Parameters
Section titled “Parameters”readonly Tag[]
void
Returns
Section titled “Returns”Tag[]
Inherited from
Section titled “Inherited from”AbstractQueryExecutor.apply
applyWithCount()
Section titled “applyWithCount()”applyWithCount(
rows,ctx?):object
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:213
Like apply, but also returns the post-filter / pre-pagination row
count. Useful for paged grids that show a total record badge.
Parameters
Section titled “Parameters”readonly Tag[]
void
Returns
Section titled “Returns”object
items:
Tag[]
totalCount
Section titled “totalCount”totalCount:
number
Inherited from
Section titled “Inherited from”AbstractQueryExecutor.applyWithCount
canExecute()
Section titled “canExecute()”canExecute():
CanExecuteResult<string,never>
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:148
Inspect the expression tree and report any keys/operators the executor cannot evaluate in-memory. Callers can use this to fall back to an API round-trip instead of subscribing to a selector that will silently return no rows.
Returns
Section titled “Returns”CanExecuteResult<string, never>
Inherited from
Section titled “Inherited from”AbstractQueryExecutor.canExecute
eval_contains()
Section titled “eval_contains()”
protectedeval_contains(val,value):boolean
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:235
Parameters
Section titled “Parameters”any
string | number | boolean
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”AbstractQueryExecutor.eval_contains
eval_default()
Section titled “eval_default()”
protectedeval_default(val,value):boolean
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:237
Parameters
Section titled “Parameters”any
string | number | boolean
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”AbstractQueryExecutor.eval_default
eval_endsWith()
Section titled “eval_endsWith()”
protectedeval_endsWith(val,value):boolean
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:233
Parameters
Section titled “Parameters”any
string | number | boolean
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”AbstractQueryExecutor.eval_endsWith
eval_equals()
Section titled “eval_equals()”
protectedeval_equals(val,value):boolean
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:225
Parameters
Section titled “Parameters”any
string | number | boolean
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”AbstractQueryExecutor.eval_equals
eval_greaterThan()
Section titled “eval_greaterThan()”
protectedeval_greaterThan(val,value):boolean
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:227
Parameters
Section titled “Parameters”any
string | number | boolean
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”AbstractQueryExecutor.eval_greaterThan
eval_greaterThanOrEqual()
Section titled “eval_greaterThanOrEqual()”
protectedeval_greaterThanOrEqual(val,value):boolean
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:229
Parameters
Section titled “Parameters”any
string | number | boolean
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”AbstractQueryExecutor.eval_greaterThanOrEqual
eval_lessThan()
Section titled “eval_lessThan()”
protectedeval_lessThan(val,value):boolean
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:228
Parameters
Section titled “Parameters”any
string | number | boolean
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”AbstractQueryExecutor.eval_lessThan
eval_lessThanOrEqual()
Section titled “eval_lessThanOrEqual()”
protectedeval_lessThanOrEqual(val,value):boolean
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:230
Parameters
Section titled “Parameters”any
string | number | boolean
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”AbstractQueryExecutor.eval_lessThanOrEqual
eval_notContains()
Section titled “eval_notContains()”
protectedeval_notContains(val,value):boolean
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:236
Parameters
Section titled “Parameters”any
string | number | boolean
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”AbstractQueryExecutor.eval_notContains
eval_notEndsWith()
Section titled “eval_notEndsWith()”
protectedeval_notEndsWith(val,value):boolean
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:234
Parameters
Section titled “Parameters”any
string | number | boolean
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”AbstractQueryExecutor.eval_notEndsWith
eval_notEquals()
Section titled “eval_notEquals()”
protectedeval_notEquals(val,value):boolean
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:226
Parameters
Section titled “Parameters”any
string | number | boolean
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”AbstractQueryExecutor.eval_notEquals
eval_notStartsWith()
Section titled “eval_notStartsWith()”
protectedeval_notStartsWith(val,value):boolean
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:232
Parameters
Section titled “Parameters”any
string | number | boolean
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”AbstractQueryExecutor.eval_notStartsWith
eval_startsWith()
Section titled “eval_startsWith()”
protectedeval_startsWith(val,value):boolean
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:231
Parameters
Section titled “Parameters”any
string | number | boolean
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”AbstractQueryExecutor.eval_startsWith
filter()
Section titled “filter()”filter(
rows,ctx?):Tag[]
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:188
Filter rows keeping only those that satisfy the executable
expression. Equivalent to rows.filter(r => this.match(r, ctx)) but
collocated with sort / paginate / apply for symmetry.
Parameters
Section titled “Parameters”readonly Tag[]
void
Returns
Section titled “Returns”Tag[]
Inherited from
Section titled “Inherited from”AbstractQueryExecutor.filter
filterResidual()
Section titled “filterResidual()”filterResidual(
rows,residualGroup,ctx?):Tag[]
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:182
Filter rows against the residual AST returned by planBaseSet().
When the group has no leaves left, returns the input unchanged
(copied) — the index intersection is already authoritative.
Parameters
Section titled “Parameters”readonly Tag[]
residualGroup
Section titled “residualGroup”ExecutableGroup<string>
void
Returns
Section titled “Returns”Tag[]
Inherited from
Section titled “Inherited from”AbstractQueryExecutor.filterResidual
mapValue()
Section titled “mapValue()”
protectedmapValue(entry,expression_key,ctx?):unknown
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:224
Extract the value from the entry based on the expression key.
Parameters
Section titled “Parameters”The model entry to extract the value from.
expression_key
Section titled “expression_key”string
the key of the expression to map.
void
optional context forwarded to the mapper.
Returns
Section titled “Returns”unknown
Inherited from
Section titled “Inherited from”AbstractQueryExecutor.mapValue
match()
Section titled “match()”match(
entry,ctx?):boolean
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:141
Evaluate the query against entry. The optional ctx is forwarded to
every mapper invocation, enabling cross-model joins.
Parameters
Section titled “Parameters”void
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”AbstractQueryExecutor.match
matchGroup()
Section titled “matchGroup()”matchGroup(
entry,group,ctx?):boolean
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:176
Same as match, but evaluates the supplied group instead of the
top-level expression. Used by selectors to filter the narrowed base
set against the residual AST returned by planBaseSet(). Returns
true when the residual group has no leaves left to evaluate.
Parameters
Section titled “Parameters”ExecutableGroup<string>
void
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”AbstractQueryExecutor.matchGroup
paginate()
Section titled “paginate()”paginate(
rows):Tag[]
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:202
Apply the { skip, take } window from the executable expression.
take === null means “no limit” → returns the input slice (copy).
Parameters
Section titled “Parameters”readonly Tag[]
Returns
Section titled “Returns”Tag[]
Inherited from
Section titled “Inherited from”AbstractQueryExecutor.paginate
planBaseSet()
Section titled “planBaseSet()”planBaseSet():
BaseSetPlan<string>
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:169
Walk the root expression group and extract every top-level leaf whose
mapper carries an index hint and uses an index-eligible operator
(Equal for single-valued mappers, Equal / Contains for multi).
The remaining (residual) AST is what the executor still needs to
evaluate row-by-row after the section narrowed the base set.
Behaviour & guarantees:
- Only extracts when the root group’s operator is
And.Orroots cannot be safely narrowed without re-introducing rows excluded by other branches. - Nested groups are never inlined — they stay in
residualGroupas full sub-trees and the executor evaluates them as usual. - When every leaf at the root is consumed and there are no nested
groups,
residualGroupis an empty AND-group (tautologicallytrue). Callers may usehasResidualFilteras a hint to skip the per-row filter pass entirely. - When no leaf is consumed, callers should fall back to the existing
apply(selectAll())path unchanged.
Returns
Section titled “Returns”BaseSetPlan<string>
Inherited from
Section titled “Inherited from”AbstractQueryExecutor.planBaseSet
sort()
Section titled “sort()”sort(
rows,ctx?):Tag[]
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:197
Stable, multi-key sort driven by expression.orderBy. Reuses the
mapper to resolve values (multi-valued mappers compare by their first
element). Null-handling: nulls last for ascending, nulls first for
descending. Clauses whose mapper is missing/supported:false are
silently skipped — callers should pre-check with canExecute() when
the order matters for correctness.
Parameters
Section titled “Parameters”readonly Tag[]
void
Returns
Section titled “Returns”Tag[]
Inherited from
Section titled “Inherited from”AbstractQueryExecutor.sort