Package org.gcube.informationsystem.queries.templates.impl.entities

Class QueryTemplateImpl

java.lang.Object

org.gcube.informationsystem.base.impl.ElementImpl

org.gcube.informationsystem.base.impl.entities.EntityElementImpl

org.gcube.informationsystem.queries.templates.impl.entities.QueryTemplateImpl

All Implemented Interfaces:

Serializable, Element, EntityElement, IdentifiableElement, QueryTemplate

public class QueryTemplateImpl
extends EntityElementImpl
implements QueryTemplate

The default implementation of the QueryTemplate interface.

Author:

Luca Frosini (ISTI - CNR)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<Version,String>	changelog	The changelog of the query template.
protected String	description	The description of the query template.
protected String	name	The name of the query template.
protected org.gcube.com.fasterxml.jackson.databind.ObjectMapper	objectMapper	The object mapper.
protected org.gcube.com.fasterxml.jackson.databind.JsonNode	params	The parameters.
protected org.gcube.com.fasterxml.jackson.databind.JsonNode	template	The template.
protected Map<String,TemplateVariable>	templateVariables	The template variables.
protected Version	version	The version of the query template.

Fields inherited from class org.gcube.informationsystem.base.impl.entities.EntityElementImpl

metadata, uuid

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

DATETIME_PATTERN, NAME, REDACTED, TYPE_PROPERTY, UNKNOWN_USER

Fields inherited from interface org.gcube.informationsystem.base.reference.entities.EntityElement

NAME

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

ID_PROPERTY, METADATA_PROPERTY

Fields inherited from interface org.gcube.informationsystem.queries.templates.reference.entities.QueryTemplate

CHANGELOG_PROPERTY, DESCRIPTION_PROPERTY, NAME, NAME_PROPERTY, TEMPLATE_PROPERTY, TEMPLATE_VARIABLES_PROPERTY, VERSION_PROPERTY

Constructor Summary

Constructors

Constructor	Description
QueryTemplateImpl()	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	addTemplateVariable(TemplateVariable templateVariable)	Adds a variable to the template.
Map<Version,String>	getChangelog()	Returns the changelog of the query template.
Map<String,String>	getChangelogWithVersionAsString()	Returns the changelog with versions represented as strings.
String	getDescription()	Returns the description of the query template.
org.gcube.com.fasterxml.jackson.databind.JsonNode	getJsonQuery()	Generates a runnable query by substituting variables with their default values.
org.gcube.com.fasterxml.jackson.databind.JsonNode	getJsonQuery(org.gcube.com.fasterxml.jackson.databind.JsonNode values)	Generates a runnable query by substituting variables with the provided values.
String	getName()	Returns the name of the query template.
org.gcube.com.fasterxml.jackson.databind.node.ObjectNode	getParamsFromDefaultValues()	Creates an ObjectNode containing the default values of all template variables.
org.gcube.com.fasterxml.jackson.databind.JsonNode	getTemplate()	Returns the template body as a JsonNode.
String	getTemplateAsString()	Returns the template body as a string.
Map<String,TemplateVariable>	getTemplateVariables()	Returns the variables defined in this template.
Version	getVersion()	Returns the version of the query template.
String	getVersionAsString()	Returns the version of the query template as a string.
protected org.gcube.com.fasterxml.jackson.databind.JsonNode	replaceVariables(org.gcube.com.fasterxml.jackson.databind.JsonNode jsonNode)	Replaces the variables in the given JSON node.
void	setChangelog(Map<String,String> changelog)	Sets the changelog of the query template.
void	setDescription(String description)	Sets the description of the query template.
void	setName(String name)	Sets the name of the query template.
void	setTemplate(String template)	Sets the template body from a string.
void	setTemplate(org.gcube.com.fasterxml.jackson.databind.JsonNode template)	Sets the template body from a JsonNode.
void	setVersion(String version)	Sets the version of the query template.

Methods inherited from class org.gcube.informationsystem.base.impl.entities.EntityElementImpl

getID, getMetadata, setID, setMetadata

Methods inherited from class org.gcube.informationsystem.base.impl.ElementImpl

getTypeName, toString

Methods inherited from class java.lang.Object

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

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

getTypeName

Methods inherited from interface org.gcube.informationsystem.base.reference.entities.EntityElement

getID, getMetadata, setID, setMetadata

Field Detail

name

protected String name

The name of the query template.

description

protected String description

The description of the query template.

version

protected Version version

The version of the query template.

changelog

protected Map<Version,String> changelog

The changelog of the query template.

objectMapper

protected org.gcube.com.fasterxml.jackson.databind.ObjectMapper objectMapper

The object mapper.

template

protected org.gcube.com.fasterxml.jackson.databind.JsonNode template

The template.

templateVariables

protected Map<String,TemplateVariable> templateVariables

The template variables.

params

protected org.gcube.com.fasterxml.jackson.databind.JsonNode params

The parameters.

Constructor Detail

QueryTemplateImpl

public QueryTemplateImpl()

Default constructor.

Method Detail

getName

public String getName()

Returns the name of the query template.

Specified by:

getName in interface QueryTemplate

Returns:

The template name.

setName

public void setName(String name)

Sets the name of the query template.

Specified by:

setName in interface QueryTemplate

Parameters:

name - The name to set.

getDescription

public String getDescription()

Returns the description of the query template.

Specified by:

getDescription in interface QueryTemplate

Returns:

The template description.

setDescription

public void setDescription(String description)

Sets the description of the query template.

Specified by:

setDescription in interface QueryTemplate

Parameters:

description - The description to set.

getVersion

public Version getVersion()

Returns the version of the query template.

Specified by:

getVersion in interface QueryTemplate

Returns:

The template version, or null when not set.

getVersionAsString

public String getVersionAsString()

Returns the version of the query template as a string.

Specified by:

getVersionAsString in interface QueryTemplate

Returns:

The version string, or null when not set.

setVersion

public void setVersion(String version)

Sets the version of the query template.

Specified by:

setVersion in interface QueryTemplate

Parameters:

version - The version string, in the form major.minor.patch.

getChangelog

public Map<Version,String> getChangelog()

Returns the changelog of the query template.

Specified by:

getChangelog in interface QueryTemplate

Returns:

A map of versions to change descriptions, or null when not set.

getChangelogWithVersionAsString

public Map<String,String> getChangelogWithVersionAsString()

Returns the changelog with versions represented as strings.

Specified by:

getChangelogWithVersionAsString in interface QueryTemplate

Returns:

A map of version strings to change descriptions, or null when not set.

setChangelog

public void setChangelog(Map<String,String> changelog)

Sets the changelog of the query template.

Specified by:

setChangelog in interface QueryTemplate

Parameters:

changelog - A map of version strings to change descriptions.

getTemplateAsString

public String getTemplateAsString()
                           throws org.gcube.com.fasterxml.jackson.core.JsonProcessingException

Returns the template body as a string.

Specified by:

getTemplateAsString in interface QueryTemplate

Returns:

The template as a string.

Throws:

org.gcube.com.fasterxml.jackson.core.JsonProcessingException - if an error occurs during serialization.

setTemplate

public void setTemplate(String template)
                 throws org.gcube.com.fasterxml.jackson.core.JsonProcessingException,
                        IOException

Sets the template body from a string.

Specified by:

setTemplate in interface QueryTemplate

Parameters:

template - The template string.

Throws:

org.gcube.com.fasterxml.jackson.core.JsonProcessingException - if an error occurs during JSON processing.

IOException - if an error occurs during parsing.

getTemplate

public org.gcube.com.fasterxml.jackson.databind.JsonNode getTemplate()

Returns the template body as a JsonNode.

Specified by:

getTemplate in interface QueryTemplate

Returns:

The template as a JsonNode.

setTemplate

public void setTemplate(org.gcube.com.fasterxml.jackson.databind.JsonNode template)

Sets the template body from a JsonNode.

Specified by:

setTemplate in interface QueryTemplate

Parameters:

template - The template as a JsonNode.

getTemplateVariables

public Map<String,TemplateVariable> getTemplateVariables()

Returns the variables defined in this template.

Specified by:

getTemplateVariables in interface QueryTemplate

Returns:

A map of template variables, with variable names as keys.

addTemplateVariable

public void addTemplateVariable(TemplateVariable templateVariable)

Adds a variable to the template. If a variable with the same name already exists, it will be overridden.

Specified by:

addTemplateVariable in interface QueryTemplate

Parameters:

templateVariable - The variable to add.

getParamsFromDefaultValues

public org.gcube.com.fasterxml.jackson.databind.node.ObjectNode getParamsFromDefaultValues()

Creates an ObjectNode containing the default values of all template variables.

Specified by:

getParamsFromDefaultValues in interface QueryTemplate

Returns:

An ObjectNode with default parameter values.

getJsonQuery

public org.gcube.com.fasterxml.jackson.databind.JsonNode getJsonQuery()
                                                               throws Exception

Generates a runnable query by substituting variables with their default values.

Specified by:

getJsonQuery in interface QueryTemplate

Returns:

The generated query as a JsonNode.

Throws:

Exception - if an error occurs during query generation.

replaceVariables

protected org.gcube.com.fasterxml.jackson.databind.JsonNode replaceVariables(org.gcube.com.fasterxml.jackson.databind.JsonNode jsonNode)
                                                                      throws Exception

Replaces the variables in the given JSON node. Every string node whose entire value equals a declared variable name, as an object value or as an array element at any depth, is replaced by the variable's value node. Object keys are not substitution targets, strings are never partially interpolated, and inserted values are not scanned again.

Parameters:

jsonNode - the JSON node

Returns:

the JSON node with the variables replaced

Throws:

Exception - if a variable has neither a provided value nor a default value

getJsonQuery

public org.gcube.com.fasterxml.jackson.databind.JsonNode getJsonQuery(org.gcube.com.fasterxml.jackson.databind.JsonNode values)
                                                               throws Exception

Generates a runnable query by substituting variables with the provided values.

Specified by:

getJsonQuery in interface QueryTemplate

Parameters:

values - A JsonNode containing the values to substitute.

Returns:

The generated query as a JsonNode.

Throws:

Exception - if an error occurs during query generation.