API reference
API reference
Select your platform
No SDKs available
No versions available

FilteredCachedQueryNode Class

Result of applying a filter to a CachedQueryNode.
This sealed class represents a query node with an optional filter attached. It allows the DSL syntax where { has(...) }.filter { ... }.

Signature

sealed class FilteredCachedQueryNode

Properties

[Get]
Signature
abstract val filterData: CachedQueryFilterData?
queryNode : CachedQueryNode
[Get]
Signature
abstract val queryNode: CachedQueryNode

Inner Classes

Unfiltered Class

Modifiers: final
A query node without a filter, returned by where { ... }.
This class has the filter method, ensuring filters can only be applied after using where.

Signature

data class Unfiltered(val queryNode: CachedQueryNode) : FilteredCachedQueryNode

Constructors

Unfiltered ( queryNode )
Signature
constructor(queryNode: CachedQueryNode)
Parameters
queryNode: CachedQueryNode
Returns
FilteredCachedQueryNode.Unfiltered

Properties

[Get]
Signature
open override val filterData: CachedQueryFilterData? = null
queryNode : CachedQueryNode
[Get]
Signature
open override val queryNode: CachedQueryNode

Functions

filter ( initializer )
Applies a filter to this query node.
Filters are evaluated at the native level for both initial queries and incremental updates. Only entities that match both the query criteria AND the filter condition will be included.
Example:
CachedQuery.create {
    where { has(Enemy.id) }.filter { by(Enemy.statusData).isEqualTo(Status.ACTIVE) }
}

Signature
fun filter(initializer: FilterBuilder.() -> FilterNode): FilteredCachedQueryNode.Filtered
Parameters
initializer: Function1
  Filter DSL block using FilterBuilder syntax.
Returns
FilteredCachedQueryNode.Filtered
  A FilteredCachedQueryNode.Filtered containing this query node and the filter data.

Filtered Class

Modifiers: final
A query node with a filter attached.

Signature

data class Filtered(val queryNode: CachedQueryNode, val filterData: CachedQueryFilterData) : FilteredCachedQueryNode

Constructors

Filtered ( queryNode , filterData )
Signature
constructor(queryNode: CachedQueryNode, filterData: CachedQueryFilterData)
Parameters
queryNode: CachedQueryNode
Returns
FilteredCachedQueryNode.Filtered

Properties

[Get]
Signature
open override val filterData: CachedQueryFilterData
queryNode : CachedQueryNode
[Get]
Signature
open override val queryNode: CachedQueryNode