Package org.n52.web.ctrl.data

Class DataController

java.lang.Object

org.n52.web.ctrl.BaseController

org.n52.web.ctrl.data.DataController

Direct Known Subclasses:

DatasetsDataController, IndividualObservationsDataController, ProfilesDataController, TimeseriesDataController, TrajectoriesDataController

public abstract class DataController
extends BaseController

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	CONTENT_DISPOSITION_HEADER
protected static String	CONTENT_DISPOSITION_VALUE_TEMPLATE
protected static String	OBSERVATIONS
protected static String	PROFILE
protected static String	SHOWTIMEINTERVALS_QUERY_OPTION
protected static String	TRAJECTORY

Constructor Summary

Constructors

Constructor	Description
DataController(DefaultIoFactory<DatasetOutput<AbstractValue<?>>,AbstractValue<?>> ioFactory, ParameterService<DatasetOutput<AbstractValue<?>>> datasetService, DataService<Data<AbstractValue<?>>> dataService)

Method Summary

Modifier and Type	Method	Description
protected void	addCacheHeader(IoParameters parameter, javax.servlet.http.HttpServletResponse response)
protected void	checkAgainstTimespanRestriction(IntervalWithTimeZone timespan)
protected void	checkForUnknownDatasetId(IoParameters parameters, String seriesId)
protected void	checkForUnknownDatasetIds(IoParameters parameters, Set<String> seriesIds)
protected IoHandlerFactory<DatasetOutput<AbstractValue<?>>,AbstractValue<?>>	createIoFactory(String valueType)
protected List<DatasetTypesMetadata>	geDatasetTypes(IoParameters map)
org.springframework.web.servlet.ModelAndView	getCollectionData(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String httpLocale, RequestSimpleParameterSet simpleParameters)
protected ParameterService<DatasetOutput<AbstractValue<?>>>	getDatasetService()
protected DatasetOutput<AbstractValue<?>>	getFirstDatasetOutput(IoParameters map)
void	getRawSeriesCollectionData(javax.servlet.http.HttpServletResponse response, String httpLocale, RequestSimpleParameterSet simpleParameters)
void	getRawSeriesData(javax.servlet.http.HttpServletResponse response, String datasetId, String httpLocale, org.springframework.util.MultiValueMap<String,String> query)
String	getRequestIntervalRestriction()
void	getSeriesAsCsv(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String datasetId, String httpLocale, org.springframework.util.MultiValueMap<String,String> query)
void	getSeriesAsZippedCsv(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String datasetId, String httpLocale, org.springframework.util.MultiValueMap<String,String> query)
void	getSeriesCollectionReport(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String httpLocale, RequestStyledParameterSet simpleParameters)
org.springframework.web.servlet.ModelAndView	getSeriesData(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String datasetId, String httpLocale, org.springframework.util.MultiValueMap<String,String> query)
void	getSeriesReport(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String datasetId, String httpLocale, org.springframework.util.MultiValueMap<String,String> query)
protected abstract String	getValueType(IoParameters parameters, String requestURI)
protected boolean	isProfileType(DatasetOutput<AbstractValue<?>> item)
protected boolean	isProfileType(DatasetTypesMetadata types)
protected boolean	isTrajectoryType(DatasetTypesMetadata types)
void	setRequestIntervalRestriction(String requestIntervalRestriction)

Methods inherited from class org.n52.web.ctrl.BaseController

addAdditionalParameter, addCacheHeader, addHrefBase, createCollectionUrl, createObjectMapper, createParameters, createParameters, createParameters, createParameters, createParameters, createParameters, getConfig, getExceptionHandle, getExternalUrl, getResourcePathFrom, handle400, handle404, handle500, handleException, isRequestingJsonData, isRequestingPdfData, isRequestingPngData, setExternalUrl, validateResponseSplitting

Methods inherited from class java.lang.Object

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

Field Detail

CONTENT_DISPOSITION_HEADER

protected static final String CONTENT_DISPOSITION_HEADER

See Also:

Constant Field Values

CONTENT_DISPOSITION_VALUE_TEMPLATE

protected static final String CONTENT_DISPOSITION_VALUE_TEMPLATE

See Also:

Constant Field Values

SHOWTIMEINTERVALS_QUERY_OPTION

protected static final String SHOWTIMEINTERVALS_QUERY_OPTION

See Also:

Constant Field Values

PROFILE

protected static final String PROFILE

See Also:

Constant Field Values

TRAJECTORY

protected static final String TRAJECTORY

See Also:

Constant Field Values

OBSERVATIONS

protected static final String OBSERVATIONS

See Also:

Constant Field Values

Constructor Detail

DataController

@Autowired
public DataController(DefaultIoFactory<DatasetOutput<AbstractValue<?>>,AbstractValue<?>> ioFactory,
                      ParameterService<DatasetOutput<AbstractValue<?>>> datasetService,
                      DataService<Data<AbstractValue<?>>> dataService)

Method Detail

getDatasetService

protected ParameterService<DatasetOutput<AbstractValue<?>>> getDatasetService()

getSeriesData

@RequestMapping(value="/{datasetId}/observations",
                produces="application/json",
                method=GET)
public org.springframework.web.servlet.ModelAndView getSeriesData(javax.servlet.http.HttpServletRequest request,
                                                                  javax.servlet.http.HttpServletResponse response,
                                                                  @PathVariable
                                                                  String datasetId,
                                                                  @RequestHeader(value="accept-language",required=false)
                                                                  String httpLocale,
                                                                  @RequestParam(required=false)
                                                                  org.springframework.util.MultiValueMap<String,String> query)
                                                           throws Exception

Throws:

Exception

getCollectionData

@RequestMapping(value="/observations",
                produces="application/json",
                method=POST)
public org.springframework.web.servlet.ModelAndView getCollectionData(javax.servlet.http.HttpServletRequest request,
                                                                      javax.servlet.http.HttpServletResponse response,
                                                                      @RequestHeader(value="accept-language",required=false)
                                                                      String httpLocale,
                                                                      @RequestBody
                                                                      RequestSimpleParameterSet simpleParameters)
                                                               throws Exception

Throws:

Exception

getRawSeriesCollectionData

@RequestMapping(value="/observations",
                params="rawFormat",
                method=POST)
public void getRawSeriesCollectionData(javax.servlet.http.HttpServletResponse response,
                                       @RequestHeader(value="accept-language",required=false)
                                       String httpLocale,
                                       @RequestBody
                                       RequestSimpleParameterSet simpleParameters)
                                throws Exception

Throws:

Exception

getRawSeriesData

@RequestMapping(value="/{datasetId}/observations",
                method=GET,
                params="rawFormat")
public void getRawSeriesData(javax.servlet.http.HttpServletResponse response,
                             @PathVariable
                             String datasetId,
                             @RequestHeader(value="accept-language",required=false)
                             String httpLocale,
                             @RequestParam
                             org.springframework.util.MultiValueMap<String,String> query)

getSeriesCollectionReport

@RequestMapping(value="/observations",
                produces="application/pdf",
                method=POST)
public void getSeriesCollectionReport(javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response,
                                      @RequestHeader(value="accept-language",required=false)
                                      String httpLocale,
                                      @RequestBody
                                      RequestStyledParameterSet simpleParameters)
                               throws Exception

Throws:

Exception

getSeriesReport

@RequestMapping(value={"/{datasetId}/observations","/{datasetId}/observations.pdf","/{datasetId}/data.pdf"},
                produces="application/pdf",
                method=GET)
public void getSeriesReport(javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response,
                            @PathVariable
                            String datasetId,
                            @RequestHeader(value="accept-language",required=false)
                            String httpLocale,
                            @RequestParam(required=false)
                            org.springframework.util.MultiValueMap<String,String> query)
                     throws Exception

Throws:

Exception

getSeriesAsZippedCsv

@RequestMapping(value={"/{datasetId}/observations","/{datasetId}/observations.zip","/{datasetId}/data.zip"},
                produces="application/zip",
                method=GET)
public void getSeriesAsZippedCsv(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response,
                                 @PathVariable
                                 String datasetId,
                                 @RequestHeader(value="accept-language",required=false)
                                 String httpLocale,
                                 @RequestParam(required=false)
                                 org.springframework.util.MultiValueMap<String,String> query)
                          throws Exception

Throws:

Exception

getSeriesAsCsv

@RequestMapping(value={"/{datasetId}/observations","/{datasetId}/observations.csv","/{datasetId}/data.csv"},
                produces="text/csv",
                method=GET)
public void getSeriesAsCsv(javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response,
                           @PathVariable
                           String datasetId,
                           @RequestHeader(value="accept-language",required=false)
                           String httpLocale,
                           @RequestParam(required=false)
                           org.springframework.util.MultiValueMap<String,String> query)
                    throws Exception

Throws:

Exception

checkAgainstTimespanRestriction

protected void checkAgainstTimespanRestriction(IntervalWithTimeZone timespan)

checkForUnknownDatasetId

protected void checkForUnknownDatasetId(IoParameters parameters,
                                        String seriesId)

checkForUnknownDatasetIds

protected void checkForUnknownDatasetIds(IoParameters parameters,
                                         Set<String> seriesIds)

createIoFactory

protected IoHandlerFactory<DatasetOutput<AbstractValue<?>>,AbstractValue<?>> createIoFactory(String valueType)
                                                                                            throws DatasetFactoryException

Throws:

DatasetFactoryException

addCacheHeader

protected void addCacheHeader(IoParameters parameter,
                              javax.servlet.http.HttpServletResponse response)

Specified by:

addCacheHeader in class BaseController

isProfileType

protected boolean isProfileType(DatasetOutput<AbstractValue<?>> item)

isProfileType

protected boolean isProfileType(DatasetTypesMetadata types)

isTrajectoryType

protected boolean isTrajectoryType(DatasetTypesMetadata types)

geDatasetTypes

protected List<DatasetTypesMetadata> geDatasetTypes(IoParameters map)

getValueType

protected abstract String getValueType(IoParameters parameters,
                                       String requestURI)

getFirstDatasetOutput

protected DatasetOutput<AbstractValue<?>> getFirstDatasetOutput(IoParameters map)

getRequestIntervalRestriction

public String getRequestIntervalRestriction()

setRequestIntervalRestriction

public void setRequestIntervalRestriction(String requestIntervalRestriction)