Package org.gcube.informationsystem.queries.templates.reference.properties

Interface QueryTemplateReference

All Superinterfaces:

Element, ModelElement, Property, PropertyElement, SchemaMixedElement, Serializable

All Known Implementing Classes:

QueryTemplateReferenceImpl

@TypeMetadata(name="QueryTemplateReference",
              description="This property references a query template to invoke with the specified variables to provide.",
              version="1.0.0")
@Change(version="1.0.0",
        description="First Version")
public interface QueryTemplateReference
extends Property

A property that references a QueryTemplate and provides values for its variables.

Author:

Luca Frosini (ISTI - CNR)

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME	The name of the QueryTemplateReference property type.
static String	NAME_PROPERTY	The property name for the referenced template's name.
static String	VARIABLES_PROPERTY	The property name for the variable values.

Fields inherited from interface org.gcube.informationsystem.base.reference.Element

DATETIME_PATTERN, TYPE_PROPERTY

Fields inherited from interface org.gcube.informationsystem.model.reference.ModelElement

EXPECTED_TYPE_PROPERTY, SUPERTYPES_PROPERTY

Method Summary

Modifier and Type	Method	Description
void	addVariable(String name, Object value)	Adds or updates a single variable's value.
String	getName()	Returns the name of the referenced query template.
Map<String,Object>	getVariables()	Returns the values for the template variables.
void	setName(String name)	Sets the name of the referenced query template.
void	setVariables(Map<String,Object> variables)	Sets the values for the template variables.

Methods inherited from interface org.gcube.informationsystem.base.reference.Element

getTypeName

Methods inherited from interface org.gcube.informationsystem.model.reference.ModelElement

getExpectedtype, getSupertypes

Methods inherited from interface org.gcube.informationsystem.model.reference.properties.Property

getAdditionalProperties, getAdditionalProperty, setAdditionalProperties, setAdditionalProperty

Field Detail

NAME

static final String NAME

The name of the QueryTemplateReference property type.

See Also:

Constant Field Values

NAME_PROPERTY

static final String NAME_PROPERTY

The property name for the referenced template's name.

See Also:

Constant Field Values

VARIABLES_PROPERTY

static final String VARIABLES_PROPERTY

The property name for the variable values.

See Also:

Constant Field Values

Method Detail

getName

@ISProperty(name="name",
            description="The name of the query template to refer",
            mandatory=true,
            nullable=false)
String getName()

Returns the name of the referenced query template.

Returns:

The template name.

setName

void setName(String name)

Sets the name of the referenced query template.

Parameters:

name - The template name.

getVariables

@ISProperty(name="variables",
            description="The query template variables values",
            mandatory=false,
            nullable=true)
Map<String,Object> getVariables()

Returns the values for the template variables.

Returns:

A map of variable names to their values.

setVariables

void setVariables(Map<String,Object> variables)

Sets the values for the template variables.

Parameters:

variables - A map of variable names to their values.

addVariable

void addVariable(String name,
                 Object value)

Adds or updates a single variable's value.

Parameters:

name - The name of the variable.

value - The value of the variable.