Package io.deephaven.query.parameterized

Interface Parameter

All Superinterfaces:

Serializable

All Known Implementing Classes:

ParameterImpl, TableParameter

public interface Parameter
extends Serializable

A single parameter to be used with a ParameterizedQuery

Field Summary

Fields

Modifier and Type	Field	Description
static final Parameter[]	ZERO_LENGTH_PARAMETER_ARRAY

Method Summary

Modifier and Type	Method	Description
Constraint	getConstraint()	Get the Constraint for this parameter.
String[]	getDefaultValues()	Get the default values for this parameter.
DisplayType	getDisplayType()	Get the display hint for the control.
default int	getIntProperty(String name, int defaultValue)	Get the property value as an integer, or the default value if it does not exist.
String	getName()	Get the name of the parameter
String	getProperty(String name)	Get the value of the specified constant property
Set<String>	getPropertyKeys()	Get the available property keys
ValueType	getValueType()	The type of this parameter
boolean	hasProperty(String name)	Check if the parameter has the specified property.
boolean	isCollection()	Return if this parameter is a collection of the specified type, as opposed to a single value.
boolean	isRequired()	Check if this parameter is required for computation (may not be null)
static ParameterBuilder	ofBoolean(String name)	Create an Boolean parameter
static ParameterBuilder	ofDateTime(String name)	Create an DateTime parameter (represented as a long nanos since epoch)
static ParameterBuilder	ofDouble(String name)	Create a double parameter.
static ParameterBuilder	ofLong(String name)	Create a long parameter.
static ParameterBuilder	ofString(String name)	Create an String parameter
static ParameterBuilder	ofTable(String name, Table source, String column)	Create a parameter based on the specified Deephaven Table and column.
static ParameterBuilder	setOfBoolean(String name)	Create a parameter that is a set of Boolean values.
static ParameterBuilder	setOfDateTime(String name)	Create a parameter that is a set of Date time values (represented as long nanos since epoch)
static ParameterBuilder	setOfDouble(String name)	Create a parameter that is a set of double values.
static ParameterBuilder	setOfLong(String name)	Create a parameter that is a set of longs.
static ParameterBuilder	setOfString(String name)	Create a parameter that is a set of String values

Field Details

ZERO_LENGTH_PARAMETER_ARRAY

static final Parameter[] ZERO_LENGTH_PARAMETER_ARRAY

Method Details

getName

@NotNull
String getName()

Get the name of the parameter

Returns:

the name

isCollection

boolean isCollection()

Return if this parameter is a collection of the specified type, as opposed to a single value.

Returns:

true if this parameter is a set of values

isRequired

boolean isRequired()

Check if this parameter is required for computation (may not be null)

Returns:

true if the parameter is required

getValueType

@NotNull
ValueType getValueType()

The type of this parameter

Returns:

the type

getDisplayType

@NotNull
DisplayType getDisplayType()

Get the display hint for the control.

Returns:

the display type

getDefaultValues

@NotNull
String[] getDefaultValues()

Get the default values for this parameter. A zero length array is returned when there are no defaults.

Returns:

the default value

getConstraint

@NotNull
Constraint getConstraint()

Get the Constraint for this parameter.

Returns:

the constraint or Constraint.UNCONSTRAINED if there are none.

getPropertyKeys

@NotNull
Set<String> getPropertyKeys()

Get the available property keys

Returns:

Array of property keys available to get with `getProperty`

hasProperty

boolean hasProperty(@NotNull
 String name)

Check if the parameter has the specified property.

Parameters:

name - the name of the property

Returns:

true if the property exists.

getProperty

@Nullable
String getProperty(@NotNull
 String name)

Get the value of the specified constant property

Parameters:

name - the name of the property to retrieve

Returns:

the property value.

getIntProperty

default int getIntProperty(@NotNull
 String name,
 int defaultValue)

Get the property value as an integer, or the default value if it does not exist.

Parameters:

name - the name of the property

defaultValue - the value to return if it does not exist

Returns:

the value of the property as an integer

Throws:

NumberFormatException - if the property existed but was not an integer

ofLong

@ScriptApi
@NotNull
static ParameterBuilder ofLong(@NotNull
 String name)

Create a long parameter.

Parameters:

name - the name of the parameter

Returns:

a ParameterBuilder to continue the definition. This may be passed directly to ParameterizedQueryBuilder.with(ParameterBuilder)

setOfLong

@ScriptApi
@NotNull
static ParameterBuilder setOfLong(@NotNull
 String name)

Create a parameter that is a set of longs.

Parameters:

name - the name of the parameter

Returns:

a ParameterBuilder to continue the definition. This may be passed directly to ParameterizedQueryBuilder.with(ParameterBuilder)

ofDouble

@ScriptApi
@NotNull
static ParameterBuilder ofDouble(@NotNull
 String name)

Create a double parameter.

Parameters:

name - the name of the parameter

Returns:

a ParameterBuilder to continue the definition. This may be passed directly to ParameterizedQueryBuilder.with(ParameterBuilder)

setOfDouble

@ScriptApi
@NotNull
static ParameterBuilder setOfDouble(@NotNull
 String name)

Create a parameter that is a set of double values.

Parameters:

name - the name of the parameter

Returns:

a ParameterBuilder to continue the definition. This may be passed directly to ParameterizedQueryBuilder.with(ParameterBuilder)

ofString

@ScriptApi
@NotNull
static ParameterBuilder ofString(@NotNull
 String name)

Create an String parameter

Parameters:

name - the name of the parameter

Returns:

a ParameterBuilder to continue the definition. This may be passed directly to ParameterizedQueryBuilder.with(ParameterBuilder)

setOfString

@ScriptApi
@NotNull
static ParameterBuilder setOfString(@NotNull
 String name)

Create a parameter that is a set of String values

Parameters:

name - the name of the parameter

Returns:

a ParameterBuilder to continue the definition. This may be passed directly to ParameterizedQueryBuilder.with(ParameterBuilder)

ofDateTime

@ScriptApi
@NotNull
static ParameterBuilder ofDateTime(@NotNull
 String name)

Create an DateTime parameter (represented as a long nanos since epoch)

Parameters:

name - the name of the parameter

Returns:

a ParameterBuilder to continue the definition. This may be passed directly to ParameterizedQueryBuilder.with(ParameterBuilder)

setOfDateTime

@ScriptApi
@NotNull
static ParameterBuilder setOfDateTime(@NotNull
 String name)

Create a parameter that is a set of Date time values (represented as long nanos since epoch)

Parameters:

name - the name of the parameter

Returns:

a ParameterBuilder to continue the definition. This may be passed directly to ParameterizedQueryBuilder.with(ParameterBuilder)

ofBoolean

@ScriptApi
@NotNull
static ParameterBuilder ofBoolean(@NotNull
 String name)

Create an Boolean parameter

Parameters:

name - the name of the parameter

Returns:

a ParameterBuilder to continue the definition. This may be passed directly to ParameterizedQueryBuilder.with(ParameterBuilder)

setOfBoolean

@ScriptApi
@NotNull
static ParameterBuilder setOfBoolean(@NotNull
 String name)

Create a parameter that is a set of Boolean values.

Parameters:

name - the name of the parameter

Returns:

a ParameterBuilder to continue the definition. This may be passed directly to ParameterizedQueryBuilder.with(ParameterBuilder)

ofTable

@ScriptApi
@NotNull
static ParameterBuilder ofTable(@NotNull
 String name,
 @NotNull
 Table source,
 @NotNull
 String column)

Create a parameter based on the specified Deephaven Table and column. The parameter type will be inferred by the implementation. This parameter accepts any set of unique values from the specified column.

Parameters:

name - the name of the parameter

source - the source table.

column - the column in the source table

Returns:

a ParameterBuilder to continue the definition. This may be passed directly to ParameterizedQueryBuilder.with(ParameterBuilder)