fr.ifremer.coser.result

Class CoserRequestBuilder<R extends CoserRequest>

java.lang.Object

fr.ifremer.coser.result.CoserRequestBuilder<R>

public class CoserRequestBuilder<R extends CoserRequest>
extends Object

To build requests. TO build a new request, instanciate a new build, add some parameters and then use the toRequest() method. Example:

     MapRequest r = CoserRequestBuilder.
                      newBuilder(locale,MapRequest.class).
                      addFacade(facade).
                      addZone(zone).
                      toRequest();
 

Created on 3/7/14.

Since:

1.5

Author:

Tony Chemit - chemit@codelutin.com

Field Summary

Fields

Modifier and Type	Field and Description
protected Locale	locale Locale to inject in request.
protected static String	PARAMETER_COMMUNITY_INDICATOR_LIST
protected static String	PARAMETER_EXTRACT_TYPE_LIST
protected static String	PARAMETER_FACADE
protected static String	PARAMETER_INDICATOR
protected static String	PARAMETER_POPULATION_INDICATOR_LIST
protected static String	PARAMETER_REPOSITORY_TYPE
protected static String	PARAMETER_RESULT_TYPE
protected static String	PARAMETER_SPECIES
protected static String	PARAMETER_SPECIES_LIST
protected static String	PARAMETER_TARGET_DIRECTORY
protected static String	PARAMETER_ZONE
protected static String	PARAMETER_ZONE_LIST
protected Map<String,Object>	parameters Holder of parameters to inject in request.
protected Class<R>	requestType Type of request to build.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CoserRequestBuilder(Locale locale, Class<R> requestType)

Method Summary

Methods

Modifier and Type	Method and Description
CoserRequestBuilder<R>	addCommunityIndicatorList(List<String> communityIndicatorList)
CoserRequestBuilder<R>	addExtractTypeList(List<DataType> extractTypeList)
CoserRequestBuilder<R>	addFacade(String facade)
CoserRequestBuilder<R>	addIndicator(String indicator)
CoserRequestBuilder<R>	addPopulationIndicatorList(List<String> populationIndicatorList)
CoserRequestBuilder<R>	addRepositoryType(String repositoryType)
CoserRequestBuilder<R>	addResultType(ResultType resultType)
CoserRequestBuilder<R>	addSpecies(String species)
CoserRequestBuilder<R>	addSpeciesList(List<String> speciesList)
CoserRequestBuilder<R>	addTargetDirectory(File targetDirectory)
CoserRequestBuilder<R>	addZone(String zone)
CoserRequestBuilder<R>	addZoneList(List<String> zoneList)
protected void	flushCopyRepositoryRequest(R request)
protected void	flushCoserRequestExtractTypeListAware(R request)
protected void	flushCoserRequestFacadeAware(R request)
protected void	flushCoserRequestIndicatorAware(R request)
protected void	flushCoserRequestRepositoryResultTypeAware(R request)
protected void	flushCoserRequestRepositoryTypeAware(R request)
protected void	flushCoserRequestSpeciesAware(R request)
protected void	flushCoserRequestZoneAware(R request)
protected void	flushCoserRequestZoneListAware(R request)
protected void	flushExtractRawDataAndResultsRequest(R request)
protected <O> List<O>	getListParam(String parameterName)
protected <O> O	getParam(String parameterName)
static <R extends CoserRequest> CoserRequestBuilder<R>	newBuilder(Locale locale, Class<R> requestType)
R	toRequest()

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_RESULT_TYPE

protected static final String PARAMETER_RESULT_TYPE

See Also:

Constant Field Values

PARAMETER_REPOSITORY_TYPE

protected static final String PARAMETER_REPOSITORY_TYPE

See Also:

Constant Field Values

PARAMETER_INDICATOR

protected static final String PARAMETER_INDICATOR

See Also:

Constant Field Values

PARAMETER_ZONE_LIST

protected static final String PARAMETER_ZONE_LIST

See Also:

Constant Field Values

PARAMETER_SPECIES

protected static final String PARAMETER_SPECIES

See Also:

Constant Field Values

PARAMETER_ZONE

protected static final String PARAMETER_ZONE

See Also:

Constant Field Values

PARAMETER_FACADE

protected static final String PARAMETER_FACADE

See Also:

Constant Field Values

PARAMETER_SPECIES_LIST

protected static final String PARAMETER_SPECIES_LIST

See Also:

Constant Field Values

PARAMETER_POPULATION_INDICATOR_LIST

protected static final String PARAMETER_POPULATION_INDICATOR_LIST

See Also:

Constant Field Values

PARAMETER_COMMUNITY_INDICATOR_LIST

protected static final String PARAMETER_COMMUNITY_INDICATOR_LIST

See Also:

Constant Field Values

PARAMETER_EXTRACT_TYPE_LIST

protected static final String PARAMETER_EXTRACT_TYPE_LIST

See Also:

Constant Field Values

PARAMETER_TARGET_DIRECTORY

protected static final String PARAMETER_TARGET_DIRECTORY

See Also:

Constant Field Values

locale

protected final Locale locale

Locale to inject in request.

requestType

protected final Class<R extends CoserRequest> requestType

Type of request to build.

parameters

protected final Map<String,Object> parameters

Holder of parameters to inject in request.

Constructor Detail

CoserRequestBuilder

protected CoserRequestBuilder(Locale locale,
                   Class<R> requestType)

Method Detail

newBuilder

public static <R extends CoserRequest> CoserRequestBuilder<R> newBuilder(Locale locale,
                                                         Class<R> requestType)

addFacade

public CoserRequestBuilder<R> addFacade(String facade)

addZone

public CoserRequestBuilder<R> addZone(String zone)

addSpecies

public CoserRequestBuilder<R> addSpecies(String species)

addIndicator

public CoserRequestBuilder<R> addIndicator(String indicator)

addExtractTypeList

public CoserRequestBuilder<R> addExtractTypeList(List<DataType> extractTypeList)

addZoneList

public CoserRequestBuilder<R> addZoneList(List<String> zoneList)

addSpeciesList

public CoserRequestBuilder<R> addSpeciesList(List<String> speciesList)

addPopulationIndicatorList

public CoserRequestBuilder<R> addPopulationIndicatorList(List<String> populationIndicatorList)

addCommunityIndicatorList

public CoserRequestBuilder<R> addCommunityIndicatorList(List<String> communityIndicatorList)

addRepositoryType

public CoserRequestBuilder<R> addRepositoryType(String repositoryType)

addResultType

public CoserRequestBuilder<R> addResultType(ResultType resultType)

addTargetDirectory

public CoserRequestBuilder<R> addTargetDirectory(File targetDirectory)

toRequest

public R toRequest()

flushCopyRepositoryRequest

protected void flushCopyRepositoryRequest(R request)

flushExtractRawDataAndResultsRequest

protected void flushExtractRawDataAndResultsRequest(R request)

flushCoserRequestFacadeAware

protected void flushCoserRequestFacadeAware(R request)

flushCoserRequestZoneAware

protected void flushCoserRequestZoneAware(R request)

flushCoserRequestSpeciesAware

protected void flushCoserRequestSpeciesAware(R request)

flushCoserRequestZoneListAware

protected void flushCoserRequestZoneListAware(R request)

flushCoserRequestExtractTypeListAware

protected void flushCoserRequestExtractTypeListAware(R request)

flushCoserRequestIndicatorAware

protected void flushCoserRequestIndicatorAware(R request)

flushCoserRequestRepositoryTypeAware

protected void flushCoserRequestRepositoryTypeAware(R request)

flushCoserRequestRepositoryResultTypeAware

protected void flushCoserRequestRepositoryResultTypeAware(R request)

getParam

protected <O> O getParam(String parameterName)

getListParam

protected <O> List<O> getListParam(String parameterName)