org.n52.io.request

Class RequestParameterSet

java.lang.Object

org.n52.io.request.RequestParameterSet

Direct Known Subclasses:

RequestSimpleParameterSet, RequestStyledParameterSet

abstract class RequestParameterSet
extends java.lang.Object

Serialization POJO for POST requests. All parameters will be passed to an IoParameters instance.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RequestParameterSet()

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	availableParameterNames()
boolean	containsParameter(java.lang.String parameter)
<T> T	getAs(java.lang.Class<T> clazz, java.lang.String parameterName)
<T> T	getAs(java.lang.Class<T> clazz, java.lang.String parameterName, T defaultValue)
java.lang.Boolean	getAsBoolean(java.lang.String parameterName)
java.lang.Boolean	getAsBoolean(java.lang.String parameterName, java.lang.Boolean defaultValue)
java.lang.Integer	getAsInt(java.lang.String parameterName)
java.lang.Integer	getAsInt(java.lang.String parameterName, java.lang.Integer defaultValue)
java.lang.String	getAsString(java.lang.String parameterName)
java.lang.String	getAsString(java.lang.String parameterName, java.lang.String defaultValue)
java.lang.String[]	getAsStringArray(java.lang.String parameterName)
java.lang.String[]	getAsStringArray(java.lang.String parameterName, java.lang.String[] defaultValue)
abstract java.lang.String[]	getDatasets()
java.lang.String	getLanguage() Deprecated. use getLocale()
java.lang.String	getLocale()
java.lang.String	getOutputTimezone()
com.fasterxml.jackson.databind.JsonNode	getParameterValue(java.lang.String parameterName)
java.lang.String	getResultTime()
java.lang.String[]	getTimeseriesIds() Deprecated.
java.lang.String	getTimespan() Sets the timespan of interest (as ISO8601 interval excluding the Period only version).
boolean	isBase64() If image data shall be encoded in Base64 to be easily embedded in HTML by JS clients.
boolean	isExpanded()
boolean	isGeneralize()
void	removeParameter(java.lang.String parameterName)
void	setBase64(boolean base64)
void	setExpanded(boolean expanded)
void	setGeneralize(boolean generalize)
void	setLanguage(java.lang.String language) Deprecated. use setLocale(String)
void	setLocale(java.lang.String locale)
void	setOutputTimezone(java.lang.String timezone)
void	setParameter(java.lang.String parameterName, com.fasterxml.jackson.databind.JsonNode value) Sets the value for the given parameter name.
void	setParameter(java.lang.String parameter, java.lang.Object value)
void	setParameters(java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode> parameters)
void	setResultTime(java.lang.String resultTime)
void	setTimespan(java.lang.String timespan)
IoParameters	toParameters()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestParameterSet

protected RequestParameterSet()

Method Detail

getOutputTimezone

public java.lang.String getOutputTimezone()

setOutputTimezone

public void setOutputTimezone(java.lang.String timezone)

isGeneralize

public boolean isGeneralize()

Returns:

If timeseries data shall be generalized or not.

setGeneralize

public void setGeneralize(boolean generalize)

Parameters:

generalize - if output shall be generalized

getTimespan

public java.lang.String getTimespan()

Sets the timespan of interest (as ISO8601 interval excluding the Period only version).

Returns:

the timespan in ISO-8601

setTimespan

public void setTimespan(java.lang.String timespan)

Parameters:

timespan - the timespan to set.

isBase64

public boolean isBase64()

If image data shall be encoded in Base64 to be easily embedded in HTML by JS clients.

Returns:

if image shall be base64 encoded.

setBase64

public void setBase64(boolean base64)

Parameters:

base64 - If the image shall be base64 encoded.

isExpanded

public boolean isExpanded()

Returns:

If reference values shall be appended to the timeseries data.

getLanguage

@Deprecated
public java.lang.String getLanguage()

Deprecated. use getLocale()

Returns:

A language code to determine the requested locale. "en" is the default.

setLanguage

@Deprecated
public void setLanguage(java.lang.String language)

Deprecated. use setLocale(String)

Parameters:

language - A language code to determine the requested locale.

setExpanded

public void setExpanded(boolean expanded)

Parameters:

expanded - verbose results.

getLocale

public java.lang.String getLocale()

Returns:

A language code to determine the requested locale. "en" is the default.

setLocale

public void setLocale(java.lang.String locale)

Parameters:

locale - A language code to determine the requested locale.

getResultTime

public java.lang.String getResultTime()

Returns:

the result time.

setResultTime

public void setResultTime(java.lang.String resultTime)

Parameters:

resultTime - Optional parameter, to define a result time in the request.

availableParameterNames

public java.util.Set<java.lang.String> availableParameterNames()

containsParameter

public final boolean containsParameter(java.lang.String parameter)

removeParameter

public void removeParameter(java.lang.String parameterName)

setParameters

public final void setParameters(java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode> parameters)

setParameter

public final void setParameter(java.lang.String parameter,
                               java.lang.Object value)

setParameter

public final void setParameter(java.lang.String parameterName,
                               com.fasterxml.jackson.databind.JsonNode value)

Sets the value for the given parameter name. Overrides if already exists.

Parameters:

parameterName - parameter name.

value - the parameter's value.

getAs

public final <T> T getAs(java.lang.Class<T> clazz,
                         java.lang.String parameterName,
                         T defaultValue)

getAs

public final <T> T getAs(java.lang.Class<T> clazz,
                         java.lang.String parameterName)

getParameterValue

public final com.fasterxml.jackson.databind.JsonNode getParameterValue(java.lang.String parameterName)

getAsStringArray

public final java.lang.String[] getAsStringArray(java.lang.String parameterName)

getAsStringArray

public final java.lang.String[] getAsStringArray(java.lang.String parameterName,
                                                 java.lang.String[] defaultValue)

getAsString

public final java.lang.String getAsString(java.lang.String parameterName)

getAsString

public final java.lang.String getAsString(java.lang.String parameterName,
                                          java.lang.String defaultValue)

getAsInt

public final java.lang.Integer getAsInt(java.lang.String parameterName)

getAsInt

public final java.lang.Integer getAsInt(java.lang.String parameterName,
                                        java.lang.Integer defaultValue)

getAsBoolean

public final java.lang.Boolean getAsBoolean(java.lang.String parameterName)

getAsBoolean

public final java.lang.Boolean getAsBoolean(java.lang.String parameterName,
                                            java.lang.Boolean defaultValue)

getDatasets

public abstract java.lang.String[] getDatasets()

getTimeseriesIds

@Deprecated
public java.lang.String[] getTimeseriesIds()

Deprecated.

toParameters

public IoParameters toParameters()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object