Updated the QueryDsl implementation to build more expressive vault query expressions.

Author: MrMatthewLayton

onixlabs-corda-core-workflow/src/main/kotlin/io/onixlabs/corda/core/services/Extensions.QueryDsl.kt

@@ -17,77 +17,42 @@
 package io.onixlabs.corda.core.services
 
 import net.corda.core.contracts.ContractState
-import net.corda.core.node.services.Vault
-import net.corda.core.node.services.vault.PageSpecification
 import net.corda.core.node.services.vault.QueryCriteria
-import net.corda.core.node.services.vault.Sort
+import net.corda.core.node.services.vault.QueryCriteria.VaultQueryCriteria
 
 /**
  * Creates a [QueryCriteria] using the Query DSL.
  *
  * @param T The underlying [ContractState] which will be included in the query.
  * @param contractStateType The [ContractState] class which will be included in the query.
- * @param stateStatus The state status which will be applied to the query.
- * @param relevancyStatus The relevancy status which will be applied to the query.
- * @param page The page specification which will be applied to the query.
- * @param sort The sorting which will be applied to the query.
  * @return Returns the [QueryCriteria] that was created using the Query DSL.
  */
 @QueryDslContext
-fun <T : ContractState> vaultQuery(
-    contractStateType: Class<T>,
-    stateStatus: Vault.StateStatus = Vault.StateStatus.UNCONSUMED,
-    relevancyStatus: Vault.RelevancyStatus = Vault.RelevancyStatus.RELEVANT,
-    page: PageSpecification = MAXIMUM_PAGE_SPECIFICATION,
-    sort: Sort = DEFAULT_SORTING,
-    action: QueryDsl<T>.() -> Unit
-): QueryCriteria {
-    val criteria = QueryCriteria.VaultQueryCriteria(
-        contractStateTypes = setOf(contractStateType),
-        status = stateStatus,
-        relevancyStatus = relevancyStatus
-    )
-
-    return vaultQuery(criteria, page, sort, action)
+fun <T : ContractState> vaultQuery(contractStateType: Class<T>, action: QueryDsl<T>.() -> Unit): QueryCriteria {
+    val criteria = VaultQueryCriteria(contractStateTypes = setOf(contractStateType))
+    return vaultQuery(criteria, action)
 }
 
 /**
  * Creates a [QueryCriteria] using the Query DSL.
  *
  * @param T The underlying [ContractState] which will be included in the query.
- * @param stateStatus The state status which will be applied to the query.
- * @param relevancyStatus The relevancy status which will be applied to the query.
- * @param page The page specification which will be applied to the query.
- * @param sort The sorting which will be applied to the query.
  * @return Returns the [QueryCriteria] that was created using the Query DSL.
  */
 @QueryDslContext
-inline fun <reified T : ContractState> vaultQuery(
-    stateStatus: Vault.StateStatus = Vault.StateStatus.UNCONSUMED,
-    relevancyStatus: Vault.RelevancyStatus = Vault.RelevancyStatus.RELEVANT,
-    page: PageSpecification = MAXIMUM_PAGE_SPECIFICATION,
-    sort: Sort = DEFAULT_SORTING,
-    noinline action: QueryDsl<T>.() -> Unit
-): QueryCriteria {
-    return vaultQuery(T::class.java, stateStatus, relevancyStatus, page, sort, action)
+inline fun <reified T : ContractState> vaultQuery(noinline action: QueryDsl<T>.() -> Unit): QueryCriteria {
+    return vaultQuery(T::class.java, action)
 }
 
 /**
  * Creates a [QueryCriteria] using the Query DSL.
  *
  * @param T The underlying [ContractState] which will be included in the query.
  * @param criteria The base criteria upon which the Query DSL will build.
- * @param page The page specification which will be applied to the query.
- * @param sort The sorting which will be applied to the query.
  * @return Returns the [QueryCriteria] that was created using the Query DSL.
  */
-private fun <T : ContractState> vaultQuery(
-    criteria: QueryCriteria,
-    page: PageSpecification = MAXIMUM_PAGE_SPECIFICATION,
-    sort: Sort = DEFAULT_SORTING,
-    action: QueryDsl<T>.() -> Unit
-): QueryCriteria {
-    val queryDsl = QueryDsl<T>(criteria, page, sort)
+private fun <T : ContractState> vaultQuery(criteria: QueryCriteria, action: QueryDsl<T>.() -> Unit): QueryCriteria {
+    val queryDsl = QueryDsl<T>(criteria)
     action(queryDsl)
-    return queryDsl.criteria
+    return queryDsl.getQueryCriteria()
 }

onixlabs-corda-core-workflow/src/main/kotlin/io/onixlabs/corda/core/services/Extensions.VaultService.kt

@@ -31,9 +31,11 @@ import java.util.*
  * @param criteria The query criteria that will be used to obtain the sequence.
  * @return Returns true if the sequence contains any elements; otherwise, false.
  */
-fun <T : ContractState> VaultService<T>.any(criteria: QueryCriteria = defaultQueryCriteria): Boolean {
-    return VaultSequence(this, criteria).any()
-}
+fun <T : ContractState> VaultService<T>.any(
+    criteria: QueryCriteria = defaultQueryCriteria,
+    paging: PageSpecification = MAXIMUM_PAGE_SPECIFICATION,
+    sorting: Sort = DEFAULT_SORTING
+): Boolean = VaultSequence(this, criteria, paging, sorting).any()
 
 /**
  * Determines whether the sequence contains any elements.
@@ -43,7 +45,7 @@ fun <T : ContractState> VaultService<T>.any(criteria: QueryCriteria = defaultQue
  * @return Returns true if the sequence contains any elements; otherwise, false.
  */
 fun <T : ContractState> VaultService<T>.any(action: QueryDsl<T>.() -> Unit): Boolean {
-    val queryDsl = QueryDsl<T>()
+    val queryDsl = QueryDsl<T>(defaultQueryCriteria)
     action(queryDsl)
     return VaultSequence(this, queryDsl).any()
 }
@@ -55,9 +57,11 @@ fun <T : ContractState> VaultService<T>.any(action: QueryDsl<T>.() -> Unit): Boo
  * @param criteria The query criteria that will be used to obtain the sequence.
  * @return Returns a count of the number of elements in a sequence.
  */
-fun <T : ContractState> VaultService<T>.count(criteria: QueryCriteria = defaultQueryCriteria): Int {
-    return VaultSequence(this, criteria).count()
-}
+fun <T : ContractState> VaultService<T>.count(
+    criteria: QueryCriteria = defaultQueryCriteria,
+    paging: PageSpecification = MAXIMUM_PAGE_SPECIFICATION,
+    sorting: Sort = DEFAULT_SORTING
+): Int = VaultSequence(this, criteria, paging, sorting).count()
 
 /**
  * Counts the number of elements in a sequence.
@@ -67,7 +71,7 @@ fun <T : ContractState> VaultService<T>.count(criteria: QueryCriteria = defaultQ
  * @return Returns a count of the number of elements in a sequence.
  */
 fun <T : ContractState> VaultService<T>.count(action: QueryDsl<T>.() -> Unit): Int {
-    val queryDsl = QueryDsl<T>()
+    val queryDsl = QueryDsl<T>(defaultQueryCriteria)
     action(queryDsl)
     return VaultSequence(this, queryDsl).count()
 }
@@ -95,7 +99,7 @@ fun <T : ContractState> VaultService<T>.filter(
  * @return Returns a filtered sequence of elements.
  */
 fun <T : ContractState> VaultService<T>.filter(action: QueryDsl<T>.() -> Unit): VaultSequence<T> {
-    val queryDsl = QueryDsl<T>()
+    val queryDsl = QueryDsl<T>(defaultQueryCriteria)
     action(queryDsl)
     return VaultSequence(this, queryDsl)
 }
@@ -123,7 +127,7 @@ fun <T : ContractState> VaultService<T>.first(
  * @return Returns the first element in the sequence.
  */
 fun <T : ContractState> VaultService<T>.first(action: QueryDsl<T>.() -> Unit): StateAndRef<T> {
-    val queryDsl = QueryDsl<T>()
+    val queryDsl = QueryDsl<T>(defaultQueryCriteria)
     action(queryDsl)
     return VaultSequence(this, queryDsl).first()
 }
@@ -151,7 +155,7 @@ fun <T : ContractState> VaultService<T>.firstOrNull(
  * @return Returns the first element in the sequence, or null if no element is found.
  */
 fun <T : ContractState> VaultService<T>.firstOrNull(action: QueryDsl<T>.() -> Unit): StateAndRef<T>? {
-    val queryDsl = QueryDsl<T>()
+    val queryDsl = QueryDsl<T>(defaultQueryCriteria)
     action(queryDsl)
     return VaultSequence(this, queryDsl).firstOrNull()
 }
@@ -179,7 +183,7 @@ fun <T : ContractState> VaultService<T>.last(
  * @return Returns the last element in the sequence.
  */
 fun <T : ContractState> VaultService<T>.last(action: QueryDsl<T>.() -> Unit): StateAndRef<T> {
-    val queryDsl = QueryDsl<T>()
+    val queryDsl = QueryDsl<T>(defaultQueryCriteria)
     action(queryDsl)
     return VaultSequence(this, queryDsl).last()
 }
@@ -207,7 +211,7 @@ fun <T : ContractState> VaultService<T>.lastOrNull(
  * @return Returns the last element in the sequence, or null if no element is found.
  */
 fun <T : ContractState> VaultService<T>.lastOrNull(action: QueryDsl<T>.() -> Unit): StateAndRef<T>? {
-    val queryDsl = QueryDsl<T>()
+    val queryDsl = QueryDsl<T>(defaultQueryCriteria)
     action(queryDsl)
     return VaultSequence(this, queryDsl).lastOrNull()
 }
@@ -235,7 +239,7 @@ fun <T : ContractState> VaultService<T>.single(
  * @return Returns the last element in the sequence.
  */
 fun <T : ContractState> VaultService<T>.single(action: QueryDsl<T>.() -> Unit): StateAndRef<T> {
-    val queryDsl = QueryDsl<T>()
+    val queryDsl = QueryDsl<T>(defaultQueryCriteria)
     action(queryDsl)
     return VaultSequence(this, queryDsl).single()
 }
@@ -263,7 +267,7 @@ fun <T : ContractState> VaultService<T>.singleOrNull(
  * @return Returns the last element in the sequence, or null if no element is found.
  */
 fun <T : ContractState> VaultService<T>.singleOrNull(action: QueryDsl<T>.() -> Unit): StateAndRef<T>? {
-    val queryDsl = QueryDsl<T>()
+    val queryDsl = QueryDsl<T>(defaultQueryCriteria)
     action(queryDsl)
     return VaultSequence(this, queryDsl).singleOrNull()
 }