gr.forth.ics.isl.grsfsapi.common

Class Utils

java.lang.Object

gr.forth.ics.isl.grsfsapi.common.Utils

public class Utils
extends Object

Utility methods

Author:

Yannis Marketakis (marketak 'at' ics 'dot' forth 'dot' gr), Nikos Minadakis (minadakn 'at' ics 'dot' forth 'dot' gr)

Constructor Summary

Constructors

Constructor and Description
Utils()

Method Summary

Modifier and Type	Method and Description
static HelpBean	createHelpContentsForStockDataEndpoint()
static HelpBean	createHelpContentsForStocksEndpoint()
static String	generateCsvContents(Collection<gr.forth.ics.isl.grsfservicescore.model.beans.StockBean> stockBeans) Generates the CSV resources for the given collection of StockBean instances
static String	generateCsvTimeseries(Collection<gr.forth.ics.isl.grsfservicescore.model.beans.StockData> stockDataCollection) Generates the CSV resources for the given collection of StockData instances
static String	generateHtmlContents(Collection<gr.forth.ics.isl.grsfservicescore.model.beans.StockBean> stockBeans, Collection<org.apache.commons.lang3.tuple.Pair<String,String>> parameters) Generates an HTML page with the given StockBeans.
static String	generateHtmlContents(Collection<gr.forth.ics.isl.grsfservicescore.model.beans.StockData> stockData, String stockUUID, Collection<org.apache.commons.lang3.tuple.Pair<String,String>> parameters) Generates an HTML page with the given StockData that are associated to the stock with the given UUID.
static String	generateN3Contens(Collection<gr.forth.ics.isl.grsfservicescore.model.beans.StockBean> stockBeans) Generates the N3 serialization of the given StockBean collection
static String	generateN3Timeseries(Collection<gr.forth.ics.isl.grsfservicescore.model.beans.StockData> stockDataCollection) Generates the N3 serialization of the given StockData collection
static String	generateRandomUrn() Generates a random URN, using a UUID (e.g.
static ResponseFormatType	getResponseFormatType(String responseParameter, String acceptHeader) Identifies which is the response format type.
static String	normalizeParameter(String originalParameter) Normalizes the give parameter by removing special characters.
static Collection<String>	normalizeTimeSeries(String originalParameter) Normalizes timeseries parameter values, so that their labels can be found in the Knowledge Base.
static ErrorBean	validateDatabaseSource(String databaseSourceParam) Validates the given database source.
static ErrorBean	validateQueryParameters(Collection<String> expectedParameters, Collection<String> receivedParameters) Validates that the set containing the parameters belongs to the set of the expected ones
static ErrorBean	validateTimeseriesTypes(String timeseriesTypesConact) Validates the given timeseries types (given as a comma-separated string).

Methods inherited from class java.lang.Object

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

Constructor Detail

Utils

public Utils()

Method Detail

validateQueryParameters

public static ErrorBean validateQueryParameters(Collection<String> expectedParameters,
                                                Collection<String> receivedParameters)

Validates that the set containing the parameters belongs to the set of the expected ones

Parameters:

expectedParameters - The set with the expected parameters

receivedParameters - the set with the given parameters

Returns:

an error message if any of the given parameters does not belong to the expected parameters set, otherwise null

validateTimeseriesTypes

public static ErrorBean validateTimeseriesTypes(String timeseriesTypesConact)

Validates the given timeseries types (given as a comma-separated string). If any of the given types is incorrect then an error message is displayed.

Parameters:

timeseriesTypesConact - the comma-separated string with the timeseries types

Returns:

an error message (in the form of an ErrorBean instance, if at least one timeseries type is incorrect, otherwise null

validateDatabaseSource

public static ErrorBean validateDatabaseSource(String databaseSourceParam)

Validates the given database source. The database source can be one of the following: [FIRMS, FishSource, RAM]. If the given database source is not one of the aforementioned sources, then an error message is displayed.

Parameters:

databaseSourceParam - the value of the database source that was given as input

Returns:

an error message (in the form of an ErrorBean instance, the value of the database source that was given is invalid, otherwise null

normalizeParameter

public static String normalizeParameter(String originalParameter)

Normalizes the give parameter by removing special characters. If the given parameter is a null value then null will be returned as well.

Parameters:

originalParameter - the original parameter that will be normalized

Returns:

the normalized parameter value

normalizeTimeSeries

public static Collection<String> normalizeTimeSeries(String originalParameter)

Normalizes timeseries parameter values, so that their labels can be found in the Knowledge Base. In addition timeseries parameters can be a list of comma-separated parameter values which are splitted and normalized using this method.

Parameters:

originalParameter - the original timeseries parameter values string

Returns:

the collection of normalized timeseries parameter values

createHelpContentsForStocksEndpoint

public static HelpBean createHelpContentsForStocksEndpoint()

createHelpContentsForStockDataEndpoint

public static HelpBean createHelpContentsForStockDataEndpoint()

generateHtmlContents

public static String generateHtmlContents(Collection<gr.forth.ics.isl.grsfservicescore.model.beans.StockBean> stockBeans,
                                          Collection<org.apache.commons.lang3.tuple.Pair<String,String>> parameters)

Generates an HTML page with the given StockBeans. The results (the StockBeans) are added in an HTML table.

Parameters:

stockBeans - the collection of StockBeans

parameters - the given parameters in the form of label - parameter value

Returns:

an HTML page containing the given collection of StockBeans

generateHtmlContents

public static String generateHtmlContents(Collection<gr.forth.ics.isl.grsfservicescore.model.beans.StockData> stockData,
                                          String stockUUID,
                                          Collection<org.apache.commons.lang3.tuple.Pair<String,String>> parameters)

Generates an HTML page with the given StockData that are associated to the stock with the given UUID. The results (the StockBeans) are added in an HTML table.

Parameters:

stockUUID - the UUID of the stock that contain the given stockData

stockData - the collection of StockData

parameters - the given parameters in the form of label - parameter value

Returns:

an HTML page containing the given collection of StockData

generateCsvContents

public static String generateCsvContents(Collection<gr.forth.ics.isl.grsfservicescore.model.beans.StockBean> stockBeans)

Generates the CSV resources for the given collection of StockBean instances

Parameters:

stockBeans - the collection of StockBean instances

Returns:

the CSV serialization of the given collection

generateCsvTimeseries

public static String generateCsvTimeseries(Collection<gr.forth.ics.isl.grsfservicescore.model.beans.StockData> stockDataCollection)

Generates the CSV resources for the given collection of StockData instances

Parameters:

stockDataCollection - the collection of StockData instances

Returns:

the CSV serialization of the given collection

generateN3Contens

public static String generateN3Contens(Collection<gr.forth.ics.isl.grsfservicescore.model.beans.StockBean> stockBeans)

Generates the N3 serialization of the given StockBean collection

Parameters:

stockBeans - a collection of StockBean instances

Returns:

the N3 serialization of the given collection

generateN3Timeseries

public static String generateN3Timeseries(Collection<gr.forth.ics.isl.grsfservicescore.model.beans.StockData> stockDataCollection)

Generates the N3 serialization of the given StockData collection

Parameters:

stockDataCollection - a collection of StockData instances

Returns:

the N3 serialization of the given collection

getResponseFormatType

public static ResponseFormatType getResponseFormatType(String responseParameter,
                                                       String acceptHeader)

Identifies which is the response format type. It first checks if the user defined the response type using a parameter. If it is not null and it contains a valid value then this is the one that is returned. Otherwise it checks the acceptHeader. If there are conflicting values in the responseParameter and the acceptHeader the value of the responseParameter is returned if it is valid, otherwise the acceptHeader. If neither the responseParameter, nor the acceptHeader contain valid values the default responseFormatType is returned (JSON).

Parameters:

responseParameter - the responseFormatType as expressed from the user in the parameter list (i.e. json, xml, html)

acceptHeader - the mime type of response as defined in the accept header of the request

Returns:

the identified response format type

generateRandomUrn

public static String generateRandomUrn()

Generates a random URN, using a UUID (e.g. urn:uuid:7dc53df5-703e-49b3-8670-b1c468f47f1f)

Returns:

a random URN