fr.ifremer.coser.result

Class CoserRequestExecutor

java.lang.Object

fr.ifremer.coser.result.CoserRequestExecutor

public class CoserRequestExecutor
extends Object

To execute request all over coser result repositories. This new API will let us to define any result format to be queried. Created on 3/4/14.

Since:

1.5

Author:

Tony Chemit - chemit@codelutin.com

Field Summary

Fields

Modifier and Type	Field and Description
protected CoserCommandFactory	commandFactory To create commands.
protected FileResult	fileResult
protected MapResult	mapResult
protected List<ResultRepository>	matchingRepositories
protected List<CoserResult>	multipleResults
protected CoserMainRepositoryProvider	repositoryProvider To get repositories.
protected VoidResult	voidResult

Constructor Summary

Constructors

Constructor and Description
CoserRequestExecutor(CoserApplicationContext applicationContext, CoserMainRepositoryProvider repositoryProvider)

Method Summary

Methods

Modifier and Type	Method and Description
protected <Request extends CoserRequest,Repository extends ResultRepository> boolean	accept(CoserRequestContext context, Repository repository, Request request)
void	deleteResults(CoserRequestContext context, DeleteResultsRequest request)
protected <Request extends CoserRequest,Repository extends ResultRepository> CoserResult	execute(CoserRequestContext context, Repository repository, Request request)
CoserRequestExecutor	executeAll(CoserRequestContext context, CoserRequest request) Execute the given request on any matching result repository.
CoserRequestExecutor	executeFirst(CoserRequestContext context, CoserRequest request) Execute the given request on the first matching result repository.
CoserRequestExecutor	executeUnique(CoserRequestContext context, CoserRequest request) Execute the given request to obtain a single result.
FileResult	executeUnique(CoserRequestContext context, ExtractRawDataAndResultsRequest request) Extract some raw data and results from repositories and assembly them as an archive.
ResultRepository	getFirstMatchingRepository()
List<ResultRepository>	getMatchingRepositories()
protected List<ResultRepository>	getMatchingRepositories(CoserRequestContext context, CoserRequest request)
protected <Request extends CoserRequest,Repository extends ResultRepository> CoserCommand<Repository,Request>	newCommand(CoserRequestContext context, Repository repository, Request request)
FileResult	toFileResult()
Map<String,String>	toMap()
MapResult	toMapResult()
<Result extends CoserResult> List<Result>	toMultipleResult(Class<Result> resultType)

Methods inherited from class java.lang.Object

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

Field Detail

repositoryProvider

protected final CoserMainRepositoryProvider repositoryProvider

To get repositories.

commandFactory

protected final CoserCommandFactory commandFactory

To create commands.

fileResult

protected FileResult fileResult

multipleResults

protected List<CoserResult> multipleResults

mapResult

protected MapResult mapResult

voidResult

protected VoidResult voidResult

matchingRepositories

protected List<ResultRepository> matchingRepositories

Constructor Detail

CoserRequestExecutor

public CoserRequestExecutor(CoserApplicationContext applicationContext,
                    CoserMainRepositoryProvider repositoryProvider)

Method Detail

executeUnique

public FileResult executeUnique(CoserRequestContext context,
                       ExtractRawDataAndResultsRequest request)

Extract some raw data and results from repositories and assembly them as an archive.

Parameters:

context - request context

request - extract request

Returns:

the file result containing the archive

executeUnique

public CoserRequestExecutor executeUnique(CoserRequestContext context,
                                 CoserRequest request)

Execute the given request to obtain a single result. A unique result repository must match this request, otherwise a DuplicatedResultException will be thrown. If no result repository matches the request a NoResultRepositoryFoundException will be thrown

Parameters:

context - request context

request - request to execute

Returns:

the executor

executeFirst

public CoserRequestExecutor executeFirst(CoserRequestContext context,
                                CoserRequest request)

Execute the given request on the first matching result repository. If no result repository matches the request a NoResultRepositoryFoundException will be thrown.

Parameters:

context - request context

request - request to execute

Returns:

the result of the first matching repository.

Since:

1.5

deleteResults

public void deleteResults(CoserRequestContext context,
                 DeleteResultsRequest request)

executeAll

public CoserRequestExecutor executeAll(CoserRequestContext context,
                              CoserRequest request)

Execute the given request on any matching result repository. If no result repository matches the request a NoResultRepositoryFoundException will be thrown.

Parameters:

context - request context

request - request to execute

Returns:

the list of result (one by each result repository).

toMapResult

public MapResult toMapResult()

toFileResult

public FileResult toFileResult()

toMultipleResult

public <Result extends CoserResult> List<Result> toMultipleResult(Class<Result> resultType)

toMap

public Map<String,String> toMap()

getMatchingRepositories

public List<ResultRepository> getMatchingRepositories()

getFirstMatchingRepository

public ResultRepository getFirstMatchingRepository()

getMatchingRepositories

protected List<ResultRepository> getMatchingRepositories(CoserRequestContext context,
                                             CoserRequest request)

accept

protected <Request extends CoserRequest,Repository extends ResultRepository> boolean accept(CoserRequestContext context,
                                                                                Repository repository,
                                                                                Request request)

execute

protected <Request extends CoserRequest,Repository extends ResultRepository> CoserResult execute(CoserRequestContext context,
                                                                                     Repository repository,
                                                                                     Request request)

newCommand

protected <Request extends CoserRequest,Repository extends ResultRepository> CoserCommand<Repository,Request> newCommand(CoserRequestContext context,
                                                                                                             Repository repository,
                                                                                                             Request request)