Package org.n52.io.request
Interface Parameters
-
- All Known Implementing Classes:
IoParameters
public interface ParametersTODO: JavaDoc
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interfaceParameters.HttpHeader
-
Field Summary
Fields Modifier and Type Field Description static StringAGGREGATIONDeprecated.static StringBASE_64If a rendered chart shall be written as base64 encoded string.static StringBBOXDetermines the bbox filterstatic StringBOMFlag to indicate if CSV encoding shall start with a Byte-Order-Markstatic StringCACHEstatic StringCATEGORIESDetermines the categories filterstatic StringCOMPLEX_PARENTInternally set to refer to parents in complex observations.static StringCRSDetermines the reference system to be used for input/output coordinates.static StringDATASETSstatic booleanDEFAULT_BASE_64Defaults to binary output.static booleanDEFAULT_EXPANDEDThe default expansion of collection items.static booleanDEFAULT_FORCE_LATEST_VALUEThe default behaviour if latest value requests shall be invoked during a timeseries collection request.static booleanDEFAULT_FORCE_XYDefault axes order respects EPSG axes ordering.static StringDEFAULT_FORMATThe default format for raw data output.static booleanDEFAULT_GENERALIZEThe default (no generalization) behaviour.static booleanDEFAULT_GRIDDefaults to a background grid in a rendered chart.static intDEFAULT_HEIGHTThe default height of the chart image to render.static booleanDEFAULT_LEGENDDefaults to a not drawn legend.static intDEFAULT_LIMITThe default page size limit.static booleanDEFAULT_MATCH_DOMAIN_IDSDefault filter match property.static intDEFAULT_OFFSETThe default page offset.static StringDEFAULT_OUTPUT_TIMEZONEThe default output timezonestatic StringDEFAULT_RENDERING_TRIGGERDefault event causing a rendering task.static booleanDEFAULT_SHOW_TIME_INTERVALSDefault forSHOW_TIME_INTERVALSstatic booleanDEFAULT_SHOW_VERTICAL_INTERVALSDefault forSHOW_VERTICAL_INTERVALSstatic StringDEFAULT_TIME_FORMATThe default timeformat.static intDEFAULT_WIDTHThe default width of the chart image to render.static StringEXPAND_WITH_NEXT_VALUES_BEYOND_INTERVALstatic StringEXPANDEDHow detailed the output shall be.static StringFEATURESDetermines the features filterstatic StringFILTER_DATASET_TYPESstatic StringFILTER_FIELDSDetermines the fields filterstatic StringFILTER_INSITUstatic StringFILTER_MOBILEstatic StringFILTER_OBSERVATION_TYPESstatic StringFILTER_OBSERVED_GEOMETRIESstatic StringFILTER_PLATFORM_GEOMETRIESstatic StringFILTER_VALUE_TYPESstatic StringFORCE_LATEST_VALUEIf latest values shall be requested in a bulk timeseries request.static StringFORCE_XYDetermines if CRS axes order shall always be XY, i.e.static StringFORMATDetermines how raw data shall be formatted.static StringGENERALIZEDetermines the generalize flag.static StringGEOMETRY_TYPESSimpleFeature types e.g.static StringGRIDIf a chart shall be rendered with a background grid.static StringHANDLE_AS_VALUE_TYPEstatic StringHEIGHTThe height in px of the image to be rendered.static StringHREF_BASEInternally set via 2.x interface to create href links.static StringLAST_VALUE_MATCHESstatic StringLEGENDIf a legend shall be drawn on the chart.static StringLEVELstatic StringLIMITDetermines the limit of the page to be returned.static StringLOCALEDetermines the locale the output shall have.static StringMATCH_DOMAIN_IDSDetermines if filter shall match domain ids instead of global idsstatic StringMEASURING_PROGRAMSstatic StringNEARDetermines the within filterstatic StringODATA_FILTERThe OData filter parameter: "$filter".static StringOFFERINGSDetermines the offerings filterstatic StringOFFSETDetermines the index of the first member of the response page (a.k.a.static StringOUTPUT_TIMEZONEDetermines the timezone output parameterstatic StringPHENOMENADetermines the phenomena filterstatic StringPLATFORMSstatic StringPROCEDURESDetermines the procedures filterstatic StringRAW_FORMATDetermines how raw data shall be queried from service.static StringRENDERING_TRIGGERDetermines if what event causes a rendering task.static StringRESULT_TIMES_VALUE_ALLstatic StringRESULTTIMESParameter to specify data for particular result timesstatic StringSAMPLINGSstatic StringSEARCH_TERMstatic StringSEARCH_TYPESstatic StringSELECTWhich fields/elements should be returnedstatic StringSERVICESDetermines the services filterstatic StringSHOW_TIME_INTERVALSIf observation time shall be shown within intervals.static StringSHOW_VERTICAL_INTERVALSIf verticals shall be shown within intervals.static StringSTATIONSDetermines the stations filterstatic StringSTYLEDetermines the style parameter for a single datasetstatic StringSTYLESDetermines the styles parameter for multiple datasetsstatic StringTAGSstatic StringTIME_FORMATDetermines how dates should be formatted (in charts).static StringTIMESERIESstatic StringTIMESPANDetermines the timespan parameterstatic StringTOKEN_SEPARATORA token separator to separate CSV valuesstatic StringUNIX_TIMEstatic StringWIDTHThe width in px of the image to be rendered.static StringZIPDetermines that output shall be zipped (if possible).
-
-
-
Field Detail
-
SEARCH_TERM
static final String SEARCH_TERM
- See Also:
- Constant Field Values
-
SEARCH_TYPES
static final String SEARCH_TYPES
- 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 toEXPANDED- See Also:
- Constant Field Values
-
SELECT
static final String SELECT
Which fields/elements should be returned- 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 toOFFSET- 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 toLIMIT- See Also:
- Constant Field Values
-
LOCALE
static final String LOCALE
Determines the locale the output shall have.- See Also:
- Constant Field Values
-
TIMESPAN
static final String TIMESPAN
Determines the timespan parameter- See Also:
- Constant Field Values
-
LAST_VALUE_MATCHES
static final String LAST_VALUE_MATCHES
- 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
-
RESULTTIMES
static final String RESULTTIMES
Parameter to specify data for particular result times- See Also:
- Constant Field Values
-
RESULT_TIMES_VALUE_ALL
static final String RESULT_TIMES_VALUE_ALL
- 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
-
ZIP
static final String ZIP
Determines that output shall be zipped (if possible).- See Also:
- Constant Field Values
-
BOM
static final String BOM
Flag to indicate if CSV encoding shall start with a Byte-Order-Mark- See Also:
- Constant Field Values
-
TOKEN_SEPARATOR
static final String TOKEN_SEPARATOR
A token separator to separate CSV values- See Also:
- Constant Field Values
-
STYLE
static final String STYLE
Determines the style parameter for a single dataset- See Also:
- Constant Field Values
-
STYLES
static final String STYLES
Determines the styles parameter for multiple datasets- 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
-
SAMPLINGS
static final String SAMPLINGS
- See Also:
- Constant Field Values
-
MEASURING_PROGRAMS
static final String MEASURING_PROGRAMS
- See Also:
- Constant Field Values
-
TAGS
static final String TAGS
- 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_MOBILE
static final String FILTER_MOBILE
- See Also:
- Constant Field Values
-
FILTER_INSITU
static final String FILTER_INSITU
- See Also:
- Constant Field Values
-
FILTER_DATASET_TYPES
static final String FILTER_DATASET_TYPES
- See Also:
- Constant Field Values
-
FILTER_OBSERVATION_TYPES
static final String FILTER_OBSERVATION_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 forSHOW_TIME_INTERVALS- See Also:
- Constant Field Values
-
SHOW_VERTICAL_INTERVALS
static final String SHOW_VERTICAL_INTERVALS
If verticals shall be shown within intervals.- See Also:
- Constant Field Values
-
DEFAULT_SHOW_VERTICAL_INTERVALS
static final boolean DEFAULT_SHOW_VERTICAL_INTERVALS
Default forSHOW_VERTICAL_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
-
ODATA_FILTER
static final String ODATA_FILTER
The OData filter parameter: "$filter".- See Also:
- Constant Field Values
-
EXPAND_WITH_NEXT_VALUES_BEYOND_INTERVAL
static final String EXPAND_WITH_NEXT_VALUES_BEYOND_INTERVAL
- See Also:
- Constant Field Values
-
CACHE
static final String CACHE
- See Also:
- Constant Field Values
-
UNIX_TIME
static final String UNIX_TIME
- See Also:
- Constant Field Values
-
AGGREGATION
@Deprecated static final String AGGREGATION
Deprecated.- See Also:
- Constant Field Values
-
LEVEL
static final String LEVEL
- See Also:
- Constant Field Values
-
-