Package io.deephaven.query.parameterized.impl.parameter

Class ParameterImpl

java.lang.Object

io.deephaven.query.parameterized.impl.parameter.ParameterImpl

All Implemented Interfaces:

Parameter, Serializable

Direct Known Subclasses:

TableParameter

public class ParameterImpl
extends Object
implements Parameter, Serializable

The basic parameter implementation. An immutable set of the basic parameters and a constraint.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROP_COLUMN
static final String	PROP_HEIGHT_HINT
static final String	PROP_TOOLTIP
static final String	PROP_WIDTH_HINT

Fields inherited from interface io.deephaven.query.parameterized.Parameter

ZERO_LENGTH_PARAMETER_ARRAY

Constructor Summary

Constructors

Constructor	Description
ParameterImpl(String name, ValueType valueType, DisplayType displayType, boolean isCollection, boolean required, String[] defaultValues, Constraint constraint, Map<String,String> props)

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.
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)
String	toString()

Methods inherited from class java.lang.Object

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

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

getIntProperty

Field Details

PROP_TOOLTIP

public static final String PROP_TOOLTIP

See Also:

• Constant Field Values

PROP_WIDTH_HINT

public static final String PROP_WIDTH_HINT

See Also:

• Constant Field Values

PROP_HEIGHT_HINT

public static final String PROP_HEIGHT_HINT

See Also:

• Constant Field Values

PROP_COLUMN

public static final String PROP_COLUMN

See Also:

• Constant Field Values

Constructor Details

ParameterImpl

public ParameterImpl(String name,
 ValueType valueType,
 DisplayType displayType,
 boolean isCollection,
 boolean required,
 String[] defaultValues,
 Constraint constraint,
 Map<String,String> props)

Method Details

getName

@NotNull
public String getName()

Description copied from interface: Parameter

Get the name of the parameter

Specified by:

getName in interface Parameter

Returns:

the name

isCollection

public boolean isCollection()

Description copied from interface: Parameter

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

Specified by:

isCollection in interface Parameter

Returns:

true if this parameter is a set of values

isRequired

public boolean isRequired()

Description copied from interface: Parameter

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

Specified by:

isRequired in interface Parameter

Returns:

true if the parameter is required

getValueType

@NotNull
public ValueType getValueType()

Description copied from interface: Parameter

The type of this parameter

Specified by:

getValueType in interface Parameter

Returns:

the type

getDefaultValues

@NotNull
public String[] getDefaultValues()

Description copied from interface: Parameter

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

Specified by:

getDefaultValues in interface Parameter

Returns:

the default value

getConstraint

@NotNull
public Constraint getConstraint()

Description copied from interface: Parameter

Get the Constraint for this parameter.

Specified by:

getConstraint in interface Parameter

Returns:

the constraint or Constraint.UNCONSTRAINED if there are none.

getDisplayType

@NotNull
public DisplayType getDisplayType()

Description copied from interface: Parameter

Get the display hint for the control.

Specified by:

getDisplayType in interface Parameter

Returns:

the display type

getPropertyKeys

@NotNull
public Set<String> getPropertyKeys()

Description copied from interface: Parameter

Get the available property keys

Specified by:

getPropertyKeys in interface Parameter

Returns:

Array of property keys available to get with `getProperty`

getProperty

@Nullable
public String getProperty(@NotNull
 String name)

Description copied from interface: Parameter

Get the value of the specified constant property

Specified by:

getProperty in interface Parameter

Parameters:

name - the name of the property to retrieve

Returns:

the property value.

hasProperty

public boolean hasProperty(@NotNull
 String name)

Description copied from interface: Parameter

Check if the parameter has the specified property.

Specified by:

hasProperty in interface Parameter

Parameters:

name - the name of the property

Returns:

true if the property exists.

toString

public String toString()

Overrides:

toString in class Object