IoParameters (Series REST API - SPI module 2.0.0-alpha.7-toolbox API)

java.lang.Object
- org.n52.io.request.IoParameters

All Implemented Interfaces:: Parameters

public final class IoParameters
extends 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, 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, EXPANDED, FEATURE, FEATURES, FILTER_FIELDS, FILTER_OBSERVED_GEOMETRIES, FILTER_PLATFORM_GEOMETRIES, FILTER_PLATFORM_TYPES, 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(Map<String,com.fasterxml.jackson.databind.JsonNode> queryParameters)`
`protected`	`IoParameters(Map<String,com.fasterxml.jackson.databind.JsonNode> queryParameters, File defaults)`
`protected`	`IoParameters(org.springframework.util.MultiValueMap<String,com.fasterxml.jackson.databind.JsonNode> queryParameters)`
`protected`	`IoParameters(org.springframework.util.MultiValueMap<String,com.fasterxml.jackson.databind.JsonNode> queryParameters, File defaults)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsParameter(String parameter)`
`protected static org.springframework.util.MultiValueMap<String,com.fasterxml.jackson.databind.JsonNode>`	`convertToJsonNodes(org.springframework.util.MultiValueMap<String,String> queryParameters)`
`protected static Map<String,com.fasterxml.jackson.databind.JsonNode>`	`convertValuesToJsonNodes(Map<String,String> queryParameters)`
`static IoParameters`	`createDefaults()`
`(package private) static IoParameters`	`createDefaults(File defaultConfig)`
`static IntervalWithTimeZone`	`createDefaultTimespan()`
`static IoParameters`	`createFromMultiValueMap(org.springframework.util.MultiValueMap<String,String> query)`
`(package private) static IoParameters`	`createFromSingleJsonValueMap(Map<String,com.fasterxml.jackson.databind.JsonNode> query)`
`static IoParameters`	`createFromSingleValueMap(Map<String,String> query)`
`IoParameters`	`extendWith(String key, String... values)` Creates a new instance based on the current one and adds parameter with the given values.
`boolean`	`getAsBoolean(String parameter)`
`boolean`	`getAsBoolean(String parameter, boolean defaultValue)`
`int`	`getAsInteger(String parameter)`
`int`	`getAsInteger(String parameter, int defaultValue)`
`String`	`getAsString(String parameter)`
`String`	`getAsString(String parameter, String defaultValue)`
`Set<String>`	`getCategories()`
`String`	`getCategory()` Deprecated. use `getCategories()`
`String`	`getCrs()`
`Set<String>`	`getDatasets()`
`String`	`getFeature()` Deprecated. use `getFeatures()`
`Set<String>`	`getFeatures()`
`Set<String>`	`getFields()`
`FilterResolver`	`getFilterResolver()`
`String`	`getFormat()`
`Set<String>`	`getGeometryTypes()`
`int`	`getHeight()` Returns the requested chart height in pixels.
`String`	`getHrefBase()`
`static com.fasterxml.jackson.databind.JsonNode`	`getJsonNodeFrom(Object object)`
`int`	`getLimit()`
`String`	`getLocale()`
`protected String`	`getNormalizedTimespan(org.joda.time.format.DateTimeFormatter dateFormat)`
`Set<String>`	`getObservedGeometryTypes()`
`Optional<org.n52.shetland.ogc.filter.Filter<?>>`	`getODataFilter()`
`String`	`getOffering()` Deprecated. use `getOfferings()`
`Set<String>`	`getOfferings()`
`int`	`getOffset()`
`String`	`getOther(String parameter)`
`String`	`getOutputTimezone()`
`Set<String>`	`getPhenomena()`
`String`	`getPhenomenon()` Deprecated. use `getPhenomena()`
`Set<String>`	`getPlatformGeometryTypes()`
`Set<String>`	`getPlatforms()`
`Set<String>`	`getPlatformTypes()`
`String`	`getProcedure()` Deprecated. use `getProcedures()`
`Set<String>`	`getProcedures()`
`String`	`getRawFormat()`
`Map<String,StyleProperties>`	`getReferencedStyles()`
`org.joda.time.Instant`	`getResultTime()`
`Set<String>`	`getResultTimes()` parses csv parameter `Parameters.RESULTTIMES` to a set of values.
`Set<String>`	`getSearchTerms()`
`Set<String>`	`getSeries()`
`String`	`getService()` Deprecated. use `getServices()`
`Set<String>`	`getServices()`
`StyleProperties`	`getSingleStyle()`
`BoundingBox`	`getSpatialFilter()` Creates a `BoundingBox` instance from given spatial request parameters.
`String`	`getStation()` Deprecated.
`Set<String>`	`getStations()`
`String`	`getTimeFormat()`
`Set<String>`	`getTimeseries()`
`IntervalWithTimeZone`	`getTimespan()`
`(package private) Set<String>`	`getValuesOf(String parameterName)`
`Set<String>`	`getValueTypes()`
`int`	`getWidth()`
`boolean`	`hasStyles()`
`boolean`	`isAllResultTimes()`
`boolean`	`isBase64()` Indicates if rendered chart shall be returned as Base64 encoded string.
`boolean`	`isExpanded()`
`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 Map<String,com.fasterxml.jackson.databind.JsonNode>`	`mergeToLowerCasedKeys(Map<String,com.fasterxml.jackson.databind.JsonNode> parameters)`
`protected org.springframework.util.MultiValueMap<String,com.fasterxml.jackson.databind.JsonNode>`	`mergeToLowerCasedKeys(org.springframework.util.MultiValueMap<String,com.fasterxml.jackson.databind.JsonNode> parameters)`
`IoParameters`	`removeAllOf(String key)` Creates a new instance based on the current one and removes given parameter with the all its values.
`IoParameters`	`replaceWith(String key, String... values)`
`IoParameters`	`respectBackwardsCompatibility()`
`IoParameters`	`setParseExceptionHandle(BiConsumer<String,IoParseException> handle)`
`boolean`	`shallBehaveBackwardsCompatible()`
`boolean`	`shallClassifyByResultTimes()`
`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(Map<String,com.fasterxml.jackson.databind.JsonNode> queryParameters)

IoParameters

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

IoParameters

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

IoParameters

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

Method Detail
- shallBehaveBackwardsCompatible
```
public boolean shallBehaveBackwardsCompatible()
```
- setParseExceptionHandle
```
public IoParameters setParseExceptionHandle(BiConsumer<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 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 Map<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 String getFormat()
```
- isSetRawFormat
```
public boolean isSetRawFormat()
```
- getRawFormat
```
public String getRawFormat()
```
- getTimeFormat
```
public 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 String getNormalizedTimespan(org.joda.time.format.DateTimeFormatter dateFormat)
```
- createDefaultTimespan
```
public static IntervalWithTimeZone createDefaultTimespan()
```
- getOutputTimezone
```
public String getOutputTimezone()
```
- getResultTime
```
public org.joda.time.Instant getResultTime()
```
- shallClassifyByResultTimes
```
public boolean shallClassifyByResultTimes()
```
- isAllResultTimes
```
public boolean isAllResultTimes()
```
- getResultTimes
```
public Set<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 Optional<org.n52.shetland.ogc.filter.Filter<?>> getODataFilter()
```
- getCategory
```
@Deprecated
public String getCategory()
```
  Deprecated. use getCategories()
  
  Returns:
  
  the category filter
- getService
```
@Deprecated
public String getService()
```
  Deprecated. use getServices()
  
  Returns:
  
  the service filter
- getOffering
```
@Deprecated
public String getOffering()
```
  Deprecated. use getOfferings()
  
  Returns:
  
  the offering filter
- getFeature
```
@Deprecated
public String getFeature()
```
  Deprecated. use getFeatures()
  
  Returns:
  
  the feature filter
- getProcedure
```
@Deprecated
public String getProcedure()
```
  Deprecated. use getProcedures()
  
  Returns:
  
  the procedure filter
- getPhenomenon
```
@Deprecated
public String getPhenomenon()
```
  Deprecated. use getPhenomena()
  
  Returns:
  
  the phenomenon filter
- getStation
```
@Deprecated
public String getStation()
```
  Deprecated.
- getCategories
```
public Set<String> getCategories()
```
- getServices
```
public Set<String> getServices()
```
- getOfferings
```
public Set<String> getOfferings()
```
- getFeatures
```
public Set<String> getFeatures()
```
- getProcedures
```
public Set<String> getProcedures()
```
- getPhenomena
```
public Set<String> getPhenomena()
```
- getStations
```
public Set<String> getStations()
```
- getPlatforms
```
public Set<String> getPlatforms()
```
- getTimeseries
```
public Set<String> getTimeseries()
```
- getSeries
```
public Set<String> getSeries()
```
- getDatasets
```
public Set<String> getDatasets()
```
- getFields
```
public Set<String> getFields()
```
- getPlatformTypes
```
public Set<String> getPlatformTypes()
```
- getPlatformGeometryTypes
```
public Set<String> getPlatformGeometryTypes()
```
- getObservedGeometryTypes
```
public Set<String> getObservedGeometryTypes()
```
- getValueTypes
```
public Set<String> getValueTypes()
```
- getSearchTerms
```
public Set<String> getSearchTerms()
```
- getGeometryTypes
```
public Set<String> getGeometryTypes()
```
- getValuesOf
```
Set<String> getValuesOf(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 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 String getHrefBase()
```
- isShowTimeIntervals
```
public boolean isShowTimeIntervals()
```
- isShowVerticalIntervals
```
public boolean isShowVerticalIntervals()
```
- containsParameter
```
public boolean containsParameter(String parameter)
```
- getOther
```
public String getOther(String parameter)
```
- getAsString
```
public String getAsString(String parameter,
                          String defaultValue)
```
- getAsString
```
public String getAsString(String parameter)
```
- getAsInteger
```
public int getAsInteger(String parameter,
                        int defaultValue)
```
- getAsInteger
```
public int getAsInteger(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(String parameter,
                            boolean defaultValue)
```
- getAsBoolean
```
public boolean getAsBoolean(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(Object object)
```
- removeAllOf
```
public IoParameters removeAllOf(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(String key,
                               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
- replaceWith
```
public IoParameters replaceWith(String key,
                                String... values)
```
- convertValuesToJsonNodes
```
protected static Map<String,com.fasterxml.jackson.databind.JsonNode> convertValuesToJsonNodes(Map<String,String> queryParameters)
```
- convertToJsonNodes
```
protected static org.springframework.util.MultiValueMap<String,com.fasterxml.jackson.databind.JsonNode> convertToJsonNodes(org.springframework.util.MultiValueMap<String,String> queryParameters)
```
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object
- mergeToLowerCasedKeys
```
protected Map<String,com.fasterxml.jackson.databind.JsonNode> mergeToLowerCasedKeys(Map<String,com.fasterxml.jackson.databind.JsonNode> parameters)
```
- mergeToLowerCasedKeys
```
protected org.springframework.util.MultiValueMap<String,com.fasterxml.jackson.databind.JsonNode> mergeToLowerCasedKeys(org.springframework.util.MultiValueMap<String,com.fasterxml.jackson.databind.JsonNode> parameters)
```
- createDefaults
```
public static IoParameters createDefaults()
```
- createDefaults
```
static IoParameters createDefaults(File defaultConfig)
```
- createFromMultiValueMap
```
public static IoParameters createFromMultiValueMap(org.springframework.util.MultiValueMap<String,String> query)
```
- createFromSingleValueMap
```
public static IoParameters createFromSingleValueMap(Map<String,String> query)
```
- createFromSingleJsonValueMap
```
static IoParameters createFromSingleJsonValueMap(Map<String,com.fasterxml.jackson.databind.JsonNode> query)
```
- respectBackwardsCompatibility
```
public IoParameters respectBackwardsCompatibility()
```
- isPureStationaryInsituQuery
```
public boolean isPureStationaryInsituQuery()
```

Class IoParameters

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IoParameters

IoParameters

IoParameters

IoParameters

IoParameters

IoParameters

Method Detail

shallBehaveBackwardsCompatible

setParseExceptionHandle

getOffset

getLimit

getWidth

getHeight

isBase64

isGrid

isGeneralize

isLegend

getLocale

getSingleStyle

getReferencedStyles

hasStyles

getFormat

isSetRawFormat

getRawFormat

getTimeFormat

getTimespan

getNormalizedTimespan

createDefaultTimespan

getOutputTimezone

getResultTime

shallClassifyByResultTimes

isAllResultTimes

getResultTimes

getODataFilter

getCategory

getService

getOffering

getFeature

getProcedure

getPhenomenon

getStation

getCategories

getServices

getOfferings

getFeatures

getProcedures

getPhenomena

getStations

getPlatforms

getTimeseries

getSeries

getDatasets

getFields

getPlatformTypes

getPlatformGeometryTypes

getObservedGeometryTypes

getValueTypes

getSearchTerms

getGeometryTypes

getValuesOf

getFilterResolver

getSpatialFilter

getCrs

isForceXY

isMatchDomainIds

isExpanded

isForceLatestValueRequests

isStatusIntervalsRequests

isRenderingHintsRequests

getHrefBase

isShowTimeIntervals