Package io.deephaven.query.parameterized.impl

Class ParameterizedQueryBuilderImpl

java.lang.Object

io.deephaven.query.parameterized.impl.ParameterizedQueryBuilderImpl

All Implemented Interfaces:

ParameterizedQueryBuilder

public class ParameterizedQueryBuilderImpl
extends Object
implements ParameterizedQueryBuilder

The default implementation of a ParameterizedQueryBuilder.

Constructor Summary

Constructors

Constructor	Description
ParameterizedQueryBuilderImpl()

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.
ParameterizedQueryBuilder	with(Parameter param)	Add the specified Parameter to the list of parameters for this query.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.deephaven.query.parameterized.ParameterizedQueryBuilder

with

Constructor Details

ParameterizedQueryBuilderImpl

public ParameterizedQueryBuilderImpl()

Method Details

build

public ParameterizedQuery build()

Description copied from interface: ParameterizedQueryBuilder

Construct a ParameterizedQuery from this builder's configuration

Specified by:

build in interface ParameterizedQueryBuilder

Returns:

a completed ParameterizedQuery

with

@NotNull
public ParameterizedQueryBuilder with(@NotNull
 Parameter param)

Description copied from interface: ParameterizedQueryBuilder

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

Specified by:

with in interface ParameterizedQueryBuilder

Parameters:

param - the parmeter

Returns:

this builder

willDo

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

Description copied from interface: ParameterizedQueryBuilder

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

Specified by:

willDo in interface ParameterizedQueryBuilder

Parameters:

queryCode - the code to execute

Returns:

this builder.

requireComputeLock

public ParameterizedQueryBuilder requireComputeLock(boolean requiresLock)

Description copied from interface: ParameterizedQueryBuilder

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 ParameterizedQueryBuilder.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.

Specified by:

requireComputeLock in interface ParameterizedQueryBuilder

Parameters:

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

Returns:

this builder

visibleTo

public ParameterizedQueryBuilder visibleTo(@NotNull
 String... viewerGroups)

Description copied from interface: ParameterizedQueryBuilder

Set the list of groups this widget is visible to.

Specified by:

visibleTo in interface ParameterizedQueryBuilder

Parameters:

viewerGroups - the groups allowed to see this widget

Returns:

this builder.