VaultNamedQueryBuilder

All Implemented Interfaces:

net.corda.v5.ledger.utxo.query.registration.VaultNamedQueryBuilderBase
```
public interface VaultNamedQueryBuilder
 implements VaultNamedQueryBuilderBase
                    
```
A builder that is used to create and build a vault named query.
The register method is called when the build is finished so that the query is stored and can be fetched and executed later on.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`abstract VaultNamedQueryBuilder`	`whereJson(@NotNull() String query)`	Sets the where clause of the named query.
`abstract VaultNamedQueryBuilder`	`filter(@NotNull() VaultNamedQueryFilter<out Object> filter)`	Sets the filter function of the named query.
`abstract VaultNamedQueryBuilder`	`map(@NotNull() VaultNamedQueryTransformer<out Object, out Object> transformer)`	Sets the mapper function of the named query.
`abstract VaultNamedQueryBuilderCollected`	`collect(@NotNull() VaultNamedQueryCollector<out Object, out Object> collector)`	Sets the collector function of the named query.

Methods inherited from class net.corda.v5.ledger.utxo.query.registration.VaultNamedQueryBuilderBase
register
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - whereJson
```
@NotNull() abstract VaultNamedQueryBuilder whereJson(@NotNull() String query)
```
    Sets the where clause of the named query.
    Vault named queries defined with whereJson return StateAndRefs when executed.
    
    Parameters:
    
    query - The JSON query representation.
  - filter
```
@NotNull() abstract VaultNamedQueryBuilder filter(@NotNull() VaultNamedQueryFilter<out Object> filter)
```
    Sets the filter function of the named query.
    Note that filtering will always be applied before mapping.
    
    Parameters:
    
    filter - A filter object.
  - map
```
@NotNull() abstract VaultNamedQueryBuilder map(@NotNull() VaultNamedQueryTransformer<out Object, out Object> transformer)
```
    Sets the mapper function of the named query.
    Note that the transformation will always be applied after filtering.
    
    Parameters:
    
    transformer - A transformer object.
  - collect
```
@NotNull() abstract VaultNamedQueryBuilderCollected collect(@NotNull() VaultNamedQueryCollector<out Object, out Object> collector)
```
    Sets the collector function of the named query.
    
    Parameters:
    
    collector - A collector object.