Package io.deephaven.query.parameterized

Interface ParameterizedQueryBuilder

All Known Implementing Classes:

ParameterizedQueryBuilderImpl

@ScriptApi
public interface ParameterizedQueryBuilder

A Builder patterned object to construct a ParameterizedQuery. Users should acquire an instance from ParameterizedQuery.create()

Method Summary

Modifier and Type	Method	Description
ParameterizedQuery	build()	Construct a ParameterizedQuery from this builder's configuration
ParameterizedQueryBuilder	requireComputeLock(boolean requiresLock)	Set whether invocations of the query will take the shared lock before executing the computation.
ParameterizedQueryBuilder	visibleTo(String... viewerGroups)	Set the list of groups this widget is visible to.
ParameterizedQueryBuilder	willDo(Consumer<ParameterScope> queryCode)	Set the work to be done when all of the parameters are available.
default ParameterizedQueryBuilder	with(ParameterBuilder param)
ParameterizedQueryBuilder	with(Parameter param)	Add the specified Parameter to the list of parameters for this query.

Method Details

build

@ScriptApi
ParameterizedQuery build()

Construct a ParameterizedQuery from this builder's configuration

Returns:

a completed ParameterizedQuery

requireComputeLock

@ScriptApi
ParameterizedQueryBuilder requireComputeLock(boolean requiresLock)

Set whether invocations of the query will take the shared lock before executing the computation. If this is set to false false, the query writer is guaranteeing that the work in willDo(Consumer) will not perform any operations that require the shared lock. If any operation does require the lock, then the query will produce undefined results.

Parameters:

requiresLock - if the operation requires the LiveTableMonitor.sharedLock()

Returns:

this builder

with

ParameterizedQueryBuilder with(Parameter param)

Add the specified Parameter to the list of parameters for this query.

Parameters:

param - the parmeter

Returns:

this builder

with

default ParameterizedQueryBuilder with(ParameterBuilder param)

willDo

@NotNull
ParameterizedQueryBuilder willDo(@NotNull
 Consumer<ParameterScope> queryCode)

Set the work to be done when all of the parameters are available.

Parameters:

queryCode - the code to execute

Returns:

this builder.

visibleTo

ParameterizedQueryBuilder visibleTo(@NotNull
 String... viewerGroups)

Set the list of groups this widget is visible to.

Parameters:

viewerGroups - the groups allowed to see this widget

Returns:

this builder.