Package nz.org.riskscape.engine.bind

Class ParameterTemplate

java.lang.Object

nz.org.riskscape.engine.bind.ParameterTemplate

public class ParameterTemplate
extends Object

Contains the aspects of a parameter that the user can customize themselves. In general, these aspects relate to how the parameter is presented to other users, especially via a UI. A ParameterTemplate can be associated with one or more ModelParameters.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ParameterTemplate.Choice	A parameter can have a set of pre-defined choices, i.e.

Field Summary

Fields

Modifier and Type	Field	Description
static final ParameterTemplate	EMPTY

Constructor Summary

Constructors

Constructor	Description
ParameterTemplate(Optional<String> label, Optional<String> description, Set<ParameterProperty> properties, List<ParameterTemplate.Choice> choices)
ParameterTemplate(Optional<String> label, Optional<String> description, Set<ParameterProperty> properties, List<ParameterTemplate.Choice> choices, Optional<String> defaultValue)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<ParameterTemplate.Choice>	getChoices()
Optional<String>	getDefaultValue()
Optional<String>	getDescription()
Optional<String>	getLabel()
Set<ParameterProperty>	getProperties()	Returns all properties for the parameter.
<T extends ParameterProperty> Optional<T>	getProperty(T property)	Returns the specified property, if present in the template.
int	hashCode()
boolean	hasProperty(ParameterProperty property)
String	toString()
List<Problem>	validate(BindingContext context, Object bound)
ParameterTemplate	withDefaultValue(String newDefault)
ParameterTemplate	withLabel(String newLabel)
ParameterTemplate	withProperties(Set<ParameterProperty> newProperties)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

EMPTY

public static final ParameterTemplate EMPTY

Constructor Details

ParameterTemplate

public ParameterTemplate(Optional<String> label,
 Optional<String> description,
 Set<ParameterProperty> properties,
 List<ParameterTemplate.Choice> choices)

ParameterTemplate

public ParameterTemplate(Optional<String> label,
 Optional<String> description,
 Set<ParameterProperty> properties,
 List<ParameterTemplate.Choice> choices,
 Optional<String> defaultValue)

Method Details

hasProperty

public boolean hasProperty(ParameterProperty property)

getProperty

public <T extends ParameterProperty> Optional<T> getProperty(T property)

Returns the specified property, if present in the template. This is mainly useful for KeyValueProperty, where the actual ParameterProperty instance has more info associated with it.

withLabel

public ParameterTemplate withLabel(String newLabel)

withProperties

public ParameterTemplate withProperties(Set<ParameterProperty> newProperties)

Returns:

a cloned copy of this template with the newProperties specified

withDefaultValue

public ParameterTemplate withDefaultValue(String newDefault)

validate

public List<Problem> validate(BindingContext context,
 Object bound)

getProperties

public Set<ParameterProperty> getProperties()

Returns all properties for the parameter. These properties may be explicitly set by the user, implied (e.g. MIN_VALUE implies NUMERIC), or inferred (e.g. if no properties are explicitly set, then we can tell from the default value [1,2,3] that the parameter is both NUMERIC and a LIST).

getLabel

public Optional<String> getLabel()

getDescription

public Optional<String> getDescription()

getChoices

public List<ParameterTemplate.Choice> getChoices()

getDefaultValue

public Optional<String> getDefaultValue()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object