Parameters (Series REST API - SPI module 2.0.0-alpha.5 API)

All Known Implementing Classes:

IoParameters
```
public interface Parameters
```
TODO: JavaDoc

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BASE_64` If a rendered chart shall be written as base64 encoded string.
`static String`	`BBOX` Determines the bbox filter
`static String`	`CATEGORIES` Determines the categories filter
`static String`	`CATEGORY` Deprecated. use `CATEGORIES`
`static String`	`COMPLEX_PARENT` Internally set to refer to parents in complex observations.
`static String`	`CRS` Determines the reference system to be used for input/output coordinates.
`static String`	`DATASETS`
`static boolean`	`DEFAULT_BASE_64` Defaults to binary output.
`static boolean`	`DEFAULT_EXPANDED` The default expansion of collection items.
`static boolean`	`DEFAULT_FORCE_LATEST_VALUE` The default behaviour if latest value requests shall be invoked during a timeseries collection request.
`static boolean`	`DEFAULT_FORCE_XY` Default axes order respects EPSG axes ordering.
`static String`	`DEFAULT_FORMAT` The default format for raw data output.
`static boolean`	`DEFAULT_GENERALIZE` The default (no generalization) behaviour.
`static boolean`	`DEFAULT_GRID` Defaults to a background grid in a rendered chart.
`static int`	`DEFAULT_HEIGHT` The default height of the chart image to render.
`static boolean`	`DEFAULT_LEGEND` Defaults to a not drawn legend.
`static int`	`DEFAULT_LIMIT` The default page size limit.
`static String`	`DEFAULT_LOCALE` The default locale.
`static boolean`	`DEFAULT_MATCH_DOMAIN_IDS` Default filter match property.
`static int`	`DEFAULT_OFFSET` The default page offset.
`static String`	`DEFAULT_OUTPUT_TIMEZONE` The default output timezone
`static boolean`	`DEFAULT_RENDERING_HINTS` Deprecated. since v2.0 covered by extras endpoint
`static String`	`DEFAULT_RENDERING_TRIGGER` Default event causing a rendering task.
`static boolean`	`DEFAULT_SHOW_TIME_INTERVALS` Default for `SHOW_TIME_INTERVALS`
`static boolean`	`DEFAULT_STATUS_INTERVALS` Deprecated. since v2.0 covered by extras endpoint
`static String`	`DEFAULT_TIME_FORMAT` The default timeformat.
`static int`	`DEFAULT_WIDTH` The default width of the chart image to render.
`static String`	`EXPANDED` How detailed the output shall be.
`static String`	`FEATURE` Deprecated. use `FEATURES`
`static String`	`FEATURES` Determines the features filter
`static String`	`FILTER_FIELDS` Determines the fields filter
`static String`	`FILTER_OBSERVED_GEOMETRIES`
`static String`	`FILTER_PLATFORM_GEOMETRIES`
`static String`	`FILTER_PLATFORM_TYPES`
`static String`	`FILTER_VALUE_TYPES`
`static String`	`FORCE_LATEST_VALUE` If latest values shall be requested in a bulk timeseries request.
`static String`	`FORCE_XY` Determines if CRS axes order shall always be XY, i.e.
`static String`	`FORMAT` Determines how raw data shall be formatted.
`static String`	`GENERALIZE` Determines the generalize flag.
`static String`	`GEOMETRY_TYPES` SimpleFeature types e.g.
`static String`	`GRID` If a chart shall be rendered with a background grid.
`static String`	`HANDLE_AS_VALUE_TYPE`
`static String`	`HEIGHT` The height in px of the image to be rendered.
`static String`	`HREF_BASE` Internally set via 2.x interface to create href links.
`static String`	`LANGUAGE` Deprecated. since v2.0 covered by `LOCALE`}
`static String`	`LEGEND` If a legend shall be drawn on the chart.
`static String`	`LIMIT` Determines the limit of the page to be returned.
`static String`	`LOCALE` Determines the locale the output shall have.
`static String`	`MATCH_DOMAIN_IDS` Determines if filter shall match domain ids instead of global ids
`static String`	`NEAR` Determines the within filter
`static String`	`OFFERING` Deprecated. use `OFFERINGS`
`static String`	`OFFERINGS` Determines the offerings filter
`static String`	`OFFSET` Determines the index of the first member of the response page (a.k.a.
`static String`	`OUTPUT_TIMEZONE` Determines the timezone output parameter
`static String`	`PHENOMENA` Determines the phenomena filter
`static String`	`PHENOMENON` Deprecated. use `PHENOMENA`
`static String`	`PLATFORMS`
`static String`	`PROCEDURE` Deprecated. use `PROCEDURES`
`static String`	`PROCEDURES` Determines the procedures filter
`static String`	`RAW_FORMAT` Determines how raw data shall be queried from service.
`static String`	`RENDERING_HINTS` Deprecated. since v2.0 covered by extras endpoint
`static String`	`RENDERING_TRIGGER` Determines if what event causes a rendering task.
`static String`	`RESULTTIME` Parameter to specify the timeseries data with a result time
`static String`	`SEARCH_TERM`
`static String`	`SERIES` Deprecated. since 2.0.0
`static String`	`SERVICE` Deprecated. use `SERVICES`
`static String`	`SERVICES` Determines the services filter
`static String`	`SHOW_TIME_INTERVALS` If observation time shall be shown within intervals.
`static String`	`STATION` Deprecated. since 2.0.0
`static String`	`STATIONS` Determines the stations filter
`static String`	`STATUS_INTERVALS` Deprecated. since v2.0 covered by extras endpoint
`static String`	`STYLE` Determines the style parameter
`static String`	`TIME_FORMAT` Determines how dates should be formatted (in charts).
`static String`	`TIMESERIES`
`static String`	`TIMESPAN` Determines the timespan parameter
`static String`	`WIDTH` The width in px of the image to be rendered.

- Field Detail
  - SEARCH_TERM
```
static final String SEARCH_TERM
```
    See Also:
    
    Constant Field Values
  - EXPANDED
```
static final String EXPANDED
```
    How detailed the output shall be.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_EXPANDED
```
static final boolean DEFAULT_EXPANDED
```
    The default expansion of collection items. Refer to EXPANDED
    
    See Also:
    
    Constant Field Values
  - FORCE_LATEST_VALUE
```
static final String FORCE_LATEST_VALUE
```
    If latest values shall be requested in a bulk timeseries request.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_FORCE_LATEST_VALUE
```
static final boolean DEFAULT_FORCE_LATEST_VALUE
```
    The default behaviour if latest value requests shall be invoked during a timeseries collection request.
    
    See Also:
    
    Constant Field Values
  - OFFSET
```
static final String OFFSET
```
    Determines the index of the first member of the response page (a.k.a. page offset).
    
    See Also:
    
    Constant Field Values
  - DEFAULT_OFFSET
```
static final int DEFAULT_OFFSET
```
    The default page offset. Refer to OFFSET
    
    See Also:
    
    Constant Field Values
  - LIMIT
```
static final String LIMIT
```
    Determines the limit of the page to be returned.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LIMIT
```
static final int DEFAULT_LIMIT
```
    The default page size limit. Refer to LIMIT
    
    See Also:
    
    Constant Field Values
  - LOCALE
```
static final String LOCALE
```
    Determines the locale the output shall have.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LOCALE
```
static final String DEFAULT_LOCALE
```
    The default locale. Refer to LOCALE
    
    See Also:
    
    Constant Field Values
  - TIMESPAN
```
static final String TIMESPAN
```
    Determines the timespan parameter
    
    See Also:
    
    Constant Field Values
  - OUTPUT_TIMEZONE
```
static final String OUTPUT_TIMEZONE
```
    Determines the timezone output parameter
    
    See Also:
    
    Constant Field Values
  - DEFAULT_OUTPUT_TIMEZONE
```
static final String DEFAULT_OUTPUT_TIMEZONE
```
    The default output timezone
    
    See Also:
    
    Constant Field Values
  - RESULTTIME
```
static final String RESULTTIME
```
    Parameter to specify the timeseries data with a result time
    
    See Also:
    
    Constant Field Values
  - WIDTH
```
static final String WIDTH
```
    The width in px of the image to be rendered.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_WIDTH
```
static final int DEFAULT_WIDTH
```
    The default width of the chart image to render.
    
    See Also:
    
    Constant Field Values
  - HEIGHT
```
static final String HEIGHT
```
    The height in px of the image to be rendered.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_HEIGHT
```
static final int DEFAULT_HEIGHT
```
    The default height of the chart image to render.
    
    See Also:
    
    Constant Field Values
  - GRID
```
static final String GRID
```
    If a chart shall be rendered with a background grid.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_GRID
```
static final boolean DEFAULT_GRID
```
    Defaults to a background grid in a rendered chart.
    
    See Also:
    
    Constant Field Values
  - LEGEND
```
static final String LEGEND
```
    If a legend shall be drawn on the chart.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LEGEND
```
static final boolean DEFAULT_LEGEND
```
    Defaults to a not drawn legend.
    
    See Also:
    
    Constant Field Values
  - BASE_64
```
static final String BASE_64
```
    If a rendered chart shall be written as base64 encoded string.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BASE_64
```
static final boolean DEFAULT_BASE_64
```
    Defaults to binary output.
    
    See Also:
    
    Constant Field Values
  - GENERALIZE
```
static final String GENERALIZE
```
    Determines the generalize flag.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_GENERALIZE
```
static final boolean DEFAULT_GENERALIZE
```
    The default (no generalization) behaviour.
    
    See Also:
    
    Constant Field Values
  - RAW_FORMAT
```
static final String RAW_FORMAT
```
    Determines how raw data shall be queried from service.
    
    See Also:
    
    Constant Field Values
  - FORMAT
```
static final String FORMAT
```
    Determines how raw data shall be formatted.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_FORMAT
```
static final String DEFAULT_FORMAT
```
    The default format for raw data output.
    
    See Also:
    
    Constant Field Values
  - TIME_FORMAT
```
static final String TIME_FORMAT
```
    Determines how dates should be formatted (in charts).
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TIME_FORMAT
```
static final String DEFAULT_TIME_FORMAT
```
    The default timeformat.
    
    See Also:
    
    Constant Field Values
  - RENDERING_TRIGGER
```
static final String RENDERING_TRIGGER
```
    Determines if what event causes a rendering task.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_RENDERING_TRIGGER
```
static final String DEFAULT_RENDERING_TRIGGER
```
    Default event causing a rendering task.
    
    See Also:
    
    Constant Field Values
  - STYLE
```
static final String STYLE
```
    Determines the style parameter
    
    See Also:
    
    Constant Field Values
  - SERVICES
```
static final String SERVICES
```
    Determines the services filter
    
    See Also:
    
    Constant Field Values
  - FEATURES
```
static final String FEATURES
```
    Determines the features filter
    
    See Also:
    
    Constant Field Values
  - OFFERINGS
```
static final String OFFERINGS
```
    Determines the offerings filter
    
    See Also:
    
    Constant Field Values
  - PROCEDURES
```
static final String PROCEDURES
```
    Determines the procedures filter
    
    See Also:
    
    Constant Field Values
  - PHENOMENA
```
static final String PHENOMENA
```
    Determines the phenomena filter
    
    See Also:
    
    Constant Field Values
  - STATIONS
```
static final String STATIONS
```
    Determines the stations filter
    
    See Also:
    
    Constant Field Values
  - PLATFORMS
```
static final String PLATFORMS
```
    See Also:
    
    Constant Field Values
  - TIMESERIES
```
static final String TIMESERIES
```
    See Also:
    
    Constant Field Values
  - DATASETS
```
static final String DATASETS
```
    See Also:
    
    Constant Field Values
  - HANDLE_AS_VALUE_TYPE
```
static final String HANDLE_AS_VALUE_TYPE
```
    See Also:
    
    Constant Field Values
  - CATEGORIES
```
static final String CATEGORIES
```
    Determines the categories filter
    
    See Also:
    
    Constant Field Values
  - CRS
```
static final String CRS
```
    Determines the reference system to be used for input/output coordinates.
    
    See Also:
    
    Constant Field Values
  - FORCE_XY
```
static final String FORCE_XY
```
    Determines if CRS axes order shall always be XY, i.e. lon/lat.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_FORCE_XY
```
static final boolean DEFAULT_FORCE_XY
```
    Default axes order respects EPSG axes ordering.
    
    See Also:
    
    Constant Field Values
  - MATCH_DOMAIN_IDS
```
static final String MATCH_DOMAIN_IDS
```
    Determines if filter shall match domain ids instead of global ids
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MATCH_DOMAIN_IDS
```
static final boolean DEFAULT_MATCH_DOMAIN_IDS
```
    Default filter match property.
    
    See Also:
    
    Constant Field Values
  - NEAR
```
static final String NEAR
```
    Determines the within filter
    
    See Also:
    
    Constant Field Values
  - BBOX
```
static final String BBOX
```
    Determines the bbox filter
    
    See Also:
    
    Constant Field Values
  - FILTER_FIELDS
```
static final String FILTER_FIELDS
```
    Determines the fields filter
    
    See Also:
    
    Constant Field Values
  - FILTER_PLATFORM_TYPES
```
static final String FILTER_PLATFORM_TYPES
```
    See Also:
    
    Constant Field Values
  - FILTER_VALUE_TYPES
```
static final String FILTER_VALUE_TYPES
```
    See Also:
    
    Constant Field Values
  - FILTER_PLATFORM_GEOMETRIES
```
static final String FILTER_PLATFORM_GEOMETRIES
```
    See Also:
    
    Constant Field Values
  - FILTER_OBSERVED_GEOMETRIES
```
static final String FILTER_OBSERVED_GEOMETRIES
```
    See Also:
    
    Constant Field Values
  - GEOMETRY_TYPES
```
static final String GEOMETRY_TYPES
```
    SimpleFeature types e.g. POINT, LINESTRING, ...
    
    See Also:
    
    Constant Field Values
  - SHOW_TIME_INTERVALS
```
static final String SHOW_TIME_INTERVALS
```
    If observation time shall be shown within intervals.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SHOW_TIME_INTERVALS
```
static final boolean DEFAULT_SHOW_TIME_INTERVALS
```
    Default for SHOW_TIME_INTERVALS
    
    See Also:
    
    Constant Field Values
  - HREF_BASE
```
static final String HREF_BASE
```
    Internally set via 2.x interface to create href links. Will be overridden, if it has been set externally.
    
    See Also:
    
    Constant Field Values
  - COMPLEX_PARENT
```
static final String COMPLEX_PARENT
```
    Internally set to refer to parents in complex observations.
    
    See Also:
    
    Constant Field Values
  - SERVICE
```
@Deprecated
static final String SERVICE
```
    Deprecated. use SERVICES
    
    Determines the service filter
    
    See Also:
    
    Constant Field Values
  - FEATURE
```
@Deprecated
static final String FEATURE
```
    Deprecated. use FEATURES
    
    Determines the feature filter
    
    See Also:
    
    Constant Field Values
  - OFFERING
```
@Deprecated
static final String OFFERING
```
    Deprecated. use OFFERINGS
    
    Determines the service filter
    
    See Also:
    
    Constant Field Values
  - PROCEDURE
```
@Deprecated
static final String PROCEDURE
```
    Deprecated. use PROCEDURES
    
    Determines the procedure filter
    
    See Also:
    
    Constant Field Values
  - PHENOMENON
```
@Deprecated
static final String PHENOMENON
```
    Deprecated. use PHENOMENA
    
    Determines the phenomenon filter
    
    See Also:
    
    Constant Field Values
  - STATION
```
@Deprecated
static final String STATION
```
    Deprecated. since 2.0.0
    
    Determines the station filter
    
    See Also:
    
    Constant Field Values
  - SERIES
```
@Deprecated
static final String SERIES
```
    Deprecated. since 2.0.0
    
    See Also:
    
    Constant Field Values
  - CATEGORY
```
@Deprecated
static final String CATEGORY
```
    Deprecated. use CATEGORIES
    
    Determines the category filter
    
    See Also:
    
    Constant Field Values
  - STATUS_INTERVALS
```
@Deprecated
static final String STATUS_INTERVALS
```
    Deprecated. since v2.0 covered by extras endpoint
    
    If status intervals section is requested.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_STATUS_INTERVALS
```
@Deprecated
static final boolean DEFAULT_STATUS_INTERVALS
```
    Deprecated. since v2.0 covered by extras endpoint
    
    The default behaviour for status intervals.
    
    See Also:
    
    Constant Field Values
  - RENDERING_HINTS
```
@Deprecated
static final String RENDERING_HINTS
```
    Deprecated. since v2.0 covered by extras endpoint
    
    If rendering hints are requested for a timeseries
    
    See Also:
    
    Constant Field Values
  - DEFAULT_RENDERING_HINTS
```
@Deprecated
static final boolean DEFAULT_RENDERING_HINTS
```
    Deprecated. since v2.0 covered by extras endpoint
    
    The default behaviour for rendering hints.
    
    See Also:
    
    Constant Field Values
  - LANGUAGE
```
@Deprecated
static final String LANGUAGE
```
    Deprecated. since v2.0 covered by LOCALE}
    
    Determines the language the output shall have.
    
    See Also:
    
    Constant Field Values

Interface Parameters

Field Summary

Field Detail

SEARCH_TERM

EXPANDED

DEFAULT_EXPANDED

FORCE_LATEST_VALUE

DEFAULT_FORCE_LATEST_VALUE

OFFSET

DEFAULT_OFFSET

LIMIT

DEFAULT_LIMIT

LOCALE

DEFAULT_LOCALE

TIMESPAN

OUTPUT_TIMEZONE

DEFAULT_OUTPUT_TIMEZONE

RESULTTIME

WIDTH

DEFAULT_WIDTH

HEIGHT

DEFAULT_HEIGHT

GRID

DEFAULT_GRID

LEGEND

DEFAULT_LEGEND

BASE_64

DEFAULT_BASE_64

GENERALIZE

DEFAULT_GENERALIZE

RAW_FORMAT

FORMAT

DEFAULT_FORMAT

TIME_FORMAT

DEFAULT_TIME_FORMAT

RENDERING_TRIGGER

DEFAULT_RENDERING_TRIGGER

STYLE

SERVICES

FEATURES

OFFERINGS

PROCEDURES

PHENOMENA

STATIONS

PLATFORMS

TIMESERIES

DATASETS

HANDLE_AS_VALUE_TYPE

CATEGORIES

CRS

FORCE_XY

DEFAULT_FORCE_XY

MATCH_DOMAIN_IDS

DEFAULT_MATCH_DOMAIN_IDS

NEAR

BBOX

FILTER_FIELDS

FILTER_PLATFORM_TYPES

FILTER_VALUE_TYPES

FILTER_PLATFORM_GEOMETRIES

FILTER_OBSERVED_GEOMETRIES

GEOMETRY_TYPES

SHOW_TIME_INTERVALS

DEFAULT_SHOW_TIME_INTERVALS

HREF_BASE

COMPLEX_PARENT

SERVICE

FEATURE

OFFERING

PROCEDURE

PHENOMENON

STATION

SERIES

CATEGORY

STATUS_INTERVALS

DEFAULT_STATUS_INTERVALS

RENDERING_HINTS

DEFAULT_RENDERING_HINTS

LANGUAGE