org.n52.io.request

Class IoParameters

java.lang.Object

org.n52.io.request.IoParameters

All Implemented Interfaces:

Parameters

public final class IoParameters
extends java.lang.Object
implements Parameters

Nested Class Summary

Nested classes/interfaces inherited from interface org.n52.io.request.Parameters

Parameters.HttpHeader

Field Summary

Fields inherited from interface org.n52.io.request.Parameters

BASE_64, BBOX, BOM, CACHE, CATEGORIES, CATEGORY, COMPLEX_PARENT, CRS, DATASETS, DEFAULT_BASE_64, DEFAULT_EXPANDED, DEFAULT_FORCE_LATEST_VALUE, DEFAULT_FORCE_XY, DEFAULT_FORMAT, DEFAULT_GENERALIZE, DEFAULT_GRID, DEFAULT_HEIGHT, DEFAULT_LEGEND, DEFAULT_LIMIT, DEFAULT_LOCALE, DEFAULT_MATCH_DOMAIN_IDS, DEFAULT_OFFSET, DEFAULT_OUTPUT_TIMEZONE, DEFAULT_RENDERING_HINTS, DEFAULT_RENDERING_TRIGGER, DEFAULT_SHOW_TIME_INTERVALS, DEFAULT_SHOW_VERTICAL_INTERVALS, DEFAULT_STATUS_INTERVALS, DEFAULT_TIME_FORMAT, DEFAULT_WIDTH, EXPAND_WITH_NEXT_VALUES_BEYOND_INTERVAL, EXPANDED, FEATURE, FEATURES, FILTER_DATASET_TYPES, FILTER_FIELDS, FILTER_INSITU, FILTER_MOBILE, FILTER_OBSERVATION_TYPES, FILTER_OBSERVED_GEOMETRIES, FILTER_PLATFORM_GEOMETRIES, FILTER_VALUE_TYPES, FORCE_LATEST_VALUE, FORCE_XY, FORMAT, GENERALIZE, GEOMETRY_TYPES, GRID, HANDLE_AS_VALUE_TYPE, HEIGHT, HREF_BASE, LANGUAGE, LEGEND, LIMIT, LOCALE, MATCH_DOMAIN_IDS, NEAR, ODATA_FILTER, OFFERING, OFFERINGS, OFFSET, OUTPUT_TIMEZONE, PHENOMENA, PHENOMENON, PLATFORMS, PROCEDURE, PROCEDURES, RAW_FORMAT, RENDERING_HINTS, RENDERING_TRIGGER, RESULT_TIMES_VALUE_ALL, RESULTTIME, RESULTTIMES, SEARCH_TERM, SERIES, SERVICE, SERVICES, SHOW_TIME_INTERVALS, SHOW_VERTICAL_INTERVALS, STATION, STATIONS, STATUS_INTERVALS, STYLE, STYLES, TIME_FORMAT, TIMESERIES, TIMESPAN, TOKEN_SEPARATOR, WIDTH, ZIP

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IoParameters()
protected	IoParameters(IoParameters other)
protected	IoParameters(java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode> queryParameters)
protected	IoParameters(java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode> queryParameters, java.io.File defaults)
protected	IoParameters(org.springframework.util.MultiValueMap<java.lang.String,com.fasterxml.jackson.databind.JsonNode> queryParameters)
protected	IoParameters(org.springframework.util.MultiValueMap<java.lang.String,com.fasterxml.jackson.databind.JsonNode> queryParameters, java.io.File defaults)

Method Summary

Modifier and Type	Method and Description
boolean	containsParameter(java.lang.String parameter)
protected static org.springframework.util.MultiValueMap<java.lang.String,com.fasterxml.jackson.databind.JsonNode>	convertToJsonNodes(org.springframework.util.MultiValueMap<java.lang.String,java.lang.String> queryParameters)
protected static java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode>	convertValuesToJsonNodes(java.util.Map<java.lang.String,java.lang.String> queryParameters)
static IoParameters	createDefaults()
static IoParameters	createDefaults(java.io.File defaultConfig)
static IntervalWithTimeZone	createDefaultTimespan()
static IoParameters	createFromMultiValueMap(org.springframework.util.MultiValueMap<java.lang.String,java.lang.String> query)
(package private) static IoParameters	createFromSingleJsonValueMap(java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode> query)
static IoParameters	createFromSingleValueMap(java.util.Map<java.lang.String,java.lang.String> query)
IoParameters	extendWith(java.lang.String key, java.util.List<java.lang.String> values)
IoParameters	extendWith(java.lang.String key, java.lang.String... values) Creates a new instance based on the current one and adds parameter with the given values.
boolean	getAsBoolean(java.lang.String parameter)
boolean	getAsBoolean(java.lang.String parameter, boolean defaultValue)
int	getAsInteger(java.lang.String parameter)
int	getAsInteger(java.lang.String parameter, int defaultValue)
java.lang.String	getAsString(java.lang.String parameter)
java.lang.String	getAsString(java.lang.String parameter, java.lang.String defaultValue)
java.util.Optional<com.fasterxml.jackson.databind.JsonNode>	getCache()
java.util.Set<java.lang.String>	getCategories()
java.lang.String	getCategory() Deprecated. use getCategories()
java.lang.String	getCrs()
java.util.Set<java.lang.String>	getDatasets()
java.util.Set<java.lang.String>	getDatasetTypes()
java.lang.String	getFeature() Deprecated. use getFeatures()
java.util.Set<java.lang.String>	getFeatures()
java.util.Set<java.lang.String>	getFields()
FilterResolver	getFilterResolver()
java.lang.String	getFormat()
java.util.Set<java.lang.String>	getGeometryTypes()
int	getHeight() Returns the requested chart height in pixels.
java.lang.String	getHrefBase()
java.lang.String	getInsitu()
static com.fasterxml.jackson.databind.JsonNode	getJsonNodeFrom(java.lang.Object object)
int	getLimit()
java.lang.String	getLocale()
java.lang.String	getMobile()
protected java.lang.String	getNormalizedTimespan(org.joda.time.format.DateTimeFormatter dateFormat)
java.util.Set<java.lang.String>	getObservationTypes()
java.util.Set<java.lang.String>	getObservedGeometryTypes()
java.util.Optional<org.n52.shetland.ogc.filter.Filter<?>>	getODataFilter()
java.lang.String	getOffering() Deprecated. use getOfferings()
java.util.Set<java.lang.String>	getOfferings()
int	getOffset()
java.lang.String	getOther(java.lang.String parameter)
java.lang.String	getOutputTimezone()
java.util.Set<java.lang.String>	getPhenomena()
java.lang.String	getPhenomenon() Deprecated. use getPhenomena()
java.util.Set<java.lang.String>	getPlatformGeometryTypes()
java.util.Set<java.lang.String>	getPlatforms()
java.lang.String	getProcedure() Deprecated. use getProcedures()
java.util.Set<java.lang.String>	getProcedures()
java.lang.String	getRawFormat()
java.util.Map<java.lang.String,StyleProperties>	getReferencedStyles()
org.joda.time.Instant	getResultTime()
java.util.Set<java.lang.String>	getResultTimes() parses csv parameter Parameters.RESULTTIMES to a set of values.
java.util.Set<java.lang.String>	getSearchTerms()
java.util.Set<java.lang.String>	getSeries()
java.lang.String	getService() Deprecated. use getServices()
java.util.Set<java.lang.String>	getServices()
StyleProperties	getSingleStyle()
BoundingBox	getSpatialFilter() Creates a BoundingBox instance from given spatial request parameters.
java.lang.String	getStation() Deprecated.
java.util.Set<java.lang.String>	getStations()
java.lang.String	getTimeFormat()
java.util.Set<java.lang.String>	getTimeseries()
IntervalWithTimeZone	getTimespan()
(package private) java.util.Set<java.lang.String>	getValuesOf(java.lang.String parameterName)
java.util.Set<java.lang.String>	getValueTypes()
int	getWidth()
boolean	hasCache()
boolean	hasStyles()
boolean	isAllResultTimes()
boolean	isBase64() Indicates if rendered chart shall be returned as Base64 encoded string.
boolean	isExpanded()
boolean	isExpandWithNextValuesBeyondInterval()
boolean	isForceLatestValueRequests()
boolean	isForceXY()
boolean	isGeneralize()
boolean	isGrid()
boolean	isLegend()
boolean	isMatchDomainIds()
boolean	isPureStationaryInsituQuery()
boolean	isRenderingHintsRequests() Deprecated. since v2.0 covered by extras endpoint
boolean	isSetRawFormat()
boolean	isShowTimeIntervals()
boolean	isShowVerticalIntervals()
boolean	isStatusIntervalsRequests() Deprecated. since v2.0 covered by extras endpoint
protected java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode>	mergeToLowerCasedKeys(java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode> parameters)
protected org.springframework.util.MultiValueMap<java.lang.String,com.fasterxml.jackson.databind.JsonNode>	mergeToLowerCasedKeys(org.springframework.util.MultiValueMap<java.lang.String,com.fasterxml.jackson.databind.JsonNode> parameters)
IoParameters	removeAllOf(java.lang.String key) Creates a new instance based on the current one and removes given parameter with the all its values.
IoParameters	replaceWith(java.lang.String key, java.util.List<java.lang.String> values)
IoParameters	replaceWith(java.lang.String key, java.lang.String... values)
IoParameters	respectBackwardsCompatibility()
IoParameters	setParseExceptionHandle(java.util.function.BiConsumer<java.lang.String,IoParseException> handle)
boolean	shallBehaveBackwardsCompatible()
boolean	shallClassifyByResultTimes()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

IoParameters

protected IoParameters()

IoParameters

protected IoParameters(IoParameters other)

IoParameters

protected IoParameters(java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode> queryParameters)

IoParameters

protected IoParameters(java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode> queryParameters,
                       java.io.File defaults)

IoParameters

protected IoParameters(org.springframework.util.MultiValueMap<java.lang.String,com.fasterxml.jackson.databind.JsonNode> queryParameters)

IoParameters

protected IoParameters(org.springframework.util.MultiValueMap<java.lang.String,com.fasterxml.jackson.databind.JsonNode> queryParameters,
                       java.io.File defaults)

Method Detail

shallBehaveBackwardsCompatible

public boolean shallBehaveBackwardsCompatible()

setParseExceptionHandle

public IoParameters setParseExceptionHandle(java.util.function.BiConsumer<java.lang.String,IoParseException> handle)

getOffset

public int getOffset()

Returns:

the value of parameter. If not present, the default is returned.

Throws:

IoParseException - if parameter could not be parsed.

getLimit

public int getLimit()

Returns:

the value of parameter. If not present, the default is returned.

Throws:

IoParseException - if parameter could not be parsed.

getWidth

public int getWidth()

Returns:

the requested chart width in pixels or the default .

Throws:

IoParseException - if parsing parameter fails.

getHeight

public int getHeight()

Returns the requested chart height in pixels.

Returns:

the requested chart height in pixels or the default .

Throws:

IoParseException - if parsing parameter fails.

isBase64

public boolean isBase64()

Indicates if rendered chart shall be returned as Base64 encoded string.

Returns:

the value of parameter or the default .

Throws:

IoParseException - if parsing parameter fails.

isGrid

public boolean isGrid()

Returns:

true if timeseries chart shall include a background grid.

Throws:

IoParseException - if parsing parameter fails.

isGeneralize

public boolean isGeneralize()

Returns:

true if timeseries data shall be generalized.

Throws:

IoParseException - if parsing parameter fails.

isLegend

public boolean isLegend()

Returns:

true if a legend shall be included when rendering a chart, false otherwise.

Throws:

IoParseException - if parsing parameter fails.

getLocale

public java.lang.String getLocale()

Returns:

the value of parameter. If not present, the default is returned.

Throws:

IoParseException - if parsing parameter fails.

getSingleStyle

public StyleProperties getSingleStyle()

Returns:

the value of parameter. If not present, the default styles are returned.

Throws:

IoParseException - if parsing parameter fails.

getReferencedStyles

public java.util.Map<java.lang.String,StyleProperties> getReferencedStyles()

Returns:

the value of parameter.

Throws:

IoParseException - if parsing parameter fails.

hasStyles

public boolean hasStyles()

Returns:

in case of either style for single or styles for multiple datasets are available.

getFormat

public java.lang.String getFormat()

isSetRawFormat

public boolean isSetRawFormat()

getRawFormat

public java.lang.String getRawFormat()

getTimeFormat

public java.lang.String getTimeFormat()

getTimespan

public IntervalWithTimeZone getTimespan()

Returns:

the value of parameter. If not present, the default timespan is returned.

Throws:

IoParseException - if timespan could not be parsed.

getNormalizedTimespan

protected java.lang.String getNormalizedTimespan(org.joda.time.format.DateTimeFormatter dateFormat)

createDefaultTimespan

public static IntervalWithTimeZone createDefaultTimespan()

getOutputTimezone

public java.lang.String getOutputTimezone()

getResultTime

public org.joda.time.Instant getResultTime()

shallClassifyByResultTimes

public boolean shallClassifyByResultTimes()

isAllResultTimes

public boolean isAllResultTimes()

getResultTimes

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

parses csv parameter Parameters.RESULTTIMES to a set of values. Validates each result time value after removing special value all. Use isAllResultTimes() to check if client requests all result times available.

Returns:

a (probably empty) set of result times.

getODataFilter

public java.util.Optional<org.n52.shetland.ogc.filter.Filter<?>> getODataFilter()

getCategory

@Deprecated
public java.lang.String getCategory()

Deprecated. use getCategories()

Returns:

the category filter

getService

@Deprecated
public java.lang.String getService()

Deprecated. use getServices()

Returns:

the service filter

getOffering

@Deprecated
public java.lang.String getOffering()

Deprecated. use getOfferings()

Returns:

the offering filter

getFeature

@Deprecated
public java.lang.String getFeature()

Deprecated. use getFeatures()

Returns:

the feature filter

getProcedure

@Deprecated
public java.lang.String getProcedure()

Deprecated. use getProcedures()

Returns:

the procedure filter

getPhenomenon

@Deprecated
public java.lang.String getPhenomenon()

Deprecated. use getPhenomena()

Returns:

the phenomenon filter

getStation

@Deprecated
public java.lang.String getStation()

Deprecated.

getCategories

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

getServices

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

getOfferings

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

getFeatures

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

getProcedures

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

getPhenomena

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

getStations

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

getPlatforms

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

getTimeseries

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

getSeries

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

getDatasets

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

getFields

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

getPlatformGeometryTypes

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

getObservedGeometryTypes

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

getMobile

public java.lang.String getMobile()

getInsitu

public java.lang.String getInsitu()

getDatasetTypes

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

getObservationTypes

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

getValueTypes

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

getSearchTerms

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

getGeometryTypes

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

getValuesOf

java.util.Set<java.lang.String> getValuesOf(java.lang.String parameterName)

getFilterResolver

public FilterResolver getFilterResolver()

getSpatialFilter

public BoundingBox getSpatialFilter()

Creates a BoundingBox instance from given spatial request parameters. The resulting bounding box is the merged extent of all spatial filters given. For example if and exist, the returned bounding box includes both extents.

Returns:

a spatial filter created from given spatial parameters.

Throws:

IoParseException - if parsing parameters fails, or if a requested object could not be created.

getCrs

public java.lang.String getCrs()

Returns:

the requested reference context, or the default () which will be interpreted as lon/lat ordered axes).

isForceXY

public boolean isForceXY()

isMatchDomainIds

public boolean isMatchDomainIds()

isExpanded

public boolean isExpanded()

Returns:

the value of parameter.

Throws:

IoParseException - if parameter could not be parsed.

isForceLatestValueRequests

public boolean isForceLatestValueRequests()

isStatusIntervalsRequests

@Deprecated
public boolean isStatusIntervalsRequests()

Deprecated. since v2.0 covered by extras endpoint

Returns:

if status intervals shall be serialized with (timeseries) output

Throws:

IoParseException - if parameter could not be parsed.

isRenderingHintsRequests

@Deprecated
public boolean isRenderingHintsRequests()

Deprecated. since v2.0 covered by extras endpoint

Returns:

if rendering hints shall be serialized with (timeseries) output

Throws:

IoParseException - if parameter could not be parsed.

getHrefBase

public java.lang.String getHrefBase()

isShowTimeIntervals

public boolean isShowTimeIntervals()

isShowVerticalIntervals

public boolean isShowVerticalIntervals()

containsParameter

public boolean containsParameter(java.lang.String parameter)

getOther

public java.lang.String getOther(java.lang.String parameter)

getAsString

public java.lang.String getAsString(java.lang.String parameter,
                                    java.lang.String defaultValue)

getAsString

public java.lang.String getAsString(java.lang.String parameter)

getAsInteger

public int getAsInteger(java.lang.String parameter,
                        int defaultValue)

getAsInteger

public int getAsInteger(java.lang.String parameter)

Parameters:

parameter - the parameter to parse to an int value.

Returns:

an integer value.

Throws:

IoParseException - if parsing to int fails.

getAsBoolean

public boolean getAsBoolean(java.lang.String parameter,
                            boolean defaultValue)

getAsBoolean

public boolean getAsBoolean(java.lang.String parameter)

Parameters:

parameter - the parameter to parse to boolean.

Returns:

true or false as boolean.

Throws:

IoParseException - if parsing to boolean fails.

getJsonNodeFrom

public static com.fasterxml.jackson.databind.JsonNode getJsonNodeFrom(java.lang.Object object)

removeAllOf

public IoParameters removeAllOf(java.lang.String key)

Creates a new instance based on the current one and removes given parameter with the all its values. As a new instance is created the current one stays unchanged (unmutable instance) and can be reused as is.

Parameters:

key - the name of the parameter to remove all its values

Returns:

a new instance with extended key/values

extendWith

public IoParameters extendWith(java.lang.String key,
                               java.lang.String... values)

Creates a new instance based on the current one and adds parameter with the given values. As a new instance is created the current one stays unchanged (unmutable instance) and can be reused as is.

Parameters:

key - the parameter name

values - the parameter values

Returns:

a new instance with extended key/values

extendWith

public IoParameters extendWith(java.lang.String key,
                               java.util.List<java.lang.String> values)

replaceWith

public IoParameters replaceWith(java.lang.String key,
                                java.lang.String... values)

replaceWith

public IoParameters replaceWith(java.lang.String key,
                                java.util.List<java.lang.String> values)

convertValuesToJsonNodes

protected static java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode> convertValuesToJsonNodes(java.util.Map<java.lang.String,java.lang.String> queryParameters)

convertToJsonNodes

protected static org.springframework.util.MultiValueMap<java.lang.String,com.fasterxml.jackson.databind.JsonNode> convertToJsonNodes(org.springframework.util.MultiValueMap<java.lang.String,java.lang.String> queryParameters)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

mergeToLowerCasedKeys

protected java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode> mergeToLowerCasedKeys(java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode> parameters)

mergeToLowerCasedKeys

protected org.springframework.util.MultiValueMap<java.lang.String,com.fasterxml.jackson.databind.JsonNode> mergeToLowerCasedKeys(org.springframework.util.MultiValueMap<java.lang.String,com.fasterxml.jackson.databind.JsonNode> parameters)

createDefaults

public static IoParameters createDefaults()

createDefaults

public static IoParameters createDefaults(java.io.File defaultConfig)

createFromMultiValueMap

public static IoParameters createFromMultiValueMap(org.springframework.util.MultiValueMap<java.lang.String,java.lang.String> query)

createFromSingleValueMap

public static IoParameters createFromSingleValueMap(java.util.Map<java.lang.String,java.lang.String> query)

createFromSingleJsonValueMap

static IoParameters createFromSingleJsonValueMap(java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode> query)

respectBackwardsCompatibility

public IoParameters respectBackwardsCompatibility()

isPureStationaryInsituQuery

public boolean isPureStationaryInsituQuery()

isExpandWithNextValuesBeyondInterval

public boolean isExpandWithNextValuesBeyondInterval()

hasCache

public boolean hasCache()

getCache

public java.util.Optional<com.fasterxml.jackson.databind.JsonNode> getCache()