Delva/app.oreshkov.delva/JsonPathQuery

JsonPathQuery

class JsonPathQuery @ExperimentalDelvaApi constructor(val path: JsonPath, val mode: ResultMode = ResultMode.CONTAINING_ELEMENT, val nested: NestedHits = NestedHits.ALL, val limit: Int = 100, val maxBytes: Long = Long.MAX_VALUE, val after: Cursor? = null, val type: String? = null, val scan: ScanPolicy = ScanPolicy.REJECT, val order: SearchOrder = SearchOrder.ASCENDING, documentFilter: DocumentFilter?)(source)

A JSONPath search (SPEC.md §10.4): the nodes path selects from the documents of the store. Hits are the distinct selected nodes in (docId, nodePre) order, ascending or descending by order — each node once, unlike an RFC 9535 nodelist, which JsonStore.select gives for one value.

mode: ResultMode.CONTAINING_ELEMENT (the default) makes each selected node a hit; ResultMode.WHOLE_DOCUMENT each document where the query selects at least one node, with the root as the hit's node.
nested: with NestedHits.OUTERMOST_ONLY, a selected node inside another selected node of the same document is dropped.
limit, maxBytes, after: pagination, as in KeyValueQuery.
type: only selected objects of this type are hits. A search with an invalid name throws InvalidTypeNameException.
scan: what to do when the index can't narrow the search down (see JsonStore.explain).
order: the order of the hits, as in KeyValueQuery.
documentFilter: only the documents it accepts are searched; set with withDocumentFilter.

Queries are values: two instances with the same settings are equal, and copy derives a variant.

Constructors

JsonPathQuery

@ExperimentalDelvaApi

constructor(path: JsonPath, mode: ResultMode = ResultMode.CONTAINING_ELEMENT, nested: NestedHits = NestedHits.ALL, limit: Int = 100, maxBytes: Long = Long.MAX_VALUE, after: Cursor? = null, type: String? = null, scan: ScanPolicy = ScanPolicy.REJECT, order: SearchOrder = SearchOrder.ASCENDING, documentFilter: DocumentFilter?)

A search of every document.

Properties

after

val after: Cursor?

documentFilter

@ExperimentalDelvaApi

val documentFilter: DocumentFilter?

The condition a document has to meet to be searched (SPEC.md §10.5), or null to search every document. A comparison of one of its root's members with a literal is an index term the search requires, as one in path is: a query whose path alone would need a scan doesn't when the filter names such a term.

val limit: Int

val maxBytes: Long

val mode: ResultMode

val nested: NestedHits

order

val order: SearchOrder

path

val path: JsonPath

scan

val scan: ScanPolicy

type

val type: String?

Functions

copy

fun copy(path: JsonPath = this.path, mode: ResultMode = this.mode, nested: NestedHits = this.nested, limit: Int = this.limit, maxBytes: Long = this.maxBytes, after: Cursor? = this.after, type: String? = this.type, scan: ScanPolicy = this.scan, order: SearchOrder = this.order): JsonPathQuery

This query with the given settings changed, the documentFilter kept; the result is validated like a new instance.

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String

withDocumentFilter

@ExperimentalDelvaApi

fun withDocumentFilter(filter: DocumentFilter?): JsonPathQuery

This query with documentFilter set to filter, or removed with null.