org.openmrs.api
Interface DataSetService

All Known Implementing Classes:

DataSetServiceImpl

@Transactional(readOnly=true)
public interface DataSetService

Method Summary

DataSet	evaluate(DataSetDefinition definition, Cohort inputCohort, EvaluationContext evalContext) Evaluate a data set definition and return a
DataSetProvider	getProvider(DataSetDefinition definition)
java.util.List<DataSetProvider>	getProviders() Gets the list of providers that have been previously set on this service
void	registerProvider(DataSetProvider newProvider) Registered a DataSetProvider and make it available to users of the data set service
void	removeProvider(DataSetProvider provider) Remove a registered DataSetProvider
void	setProviders(java.util.List<DataSetProvider> providers) Add the given list of DataSetProviders to the providers on this service.

Method Detail

setProviders

void setProviders(java.util.List<DataSetProvider> providers)
                  throws APIException

Add the given list of DataSetProviders to the providers on this service. This is used by Spring and its config files. See /metadata/spring/applicationContext-service.xml file for how to add objects to this. This should delegate to registerProvider(DataSetProvider) for each provider

Parameters:

providers - list of DataSetProvider objects to add on service

Throws:

APIException

getProviders

java.util.List<DataSetProvider> getProviders()
                                             throws APIException

Gets the list of providers that have been previously set on this service

Returns:

the list of registered providers

Throws:

APIException

See Also:

setProviders(List)

registerProvider

void registerProvider(DataSetProvider newProvider)

Registered a DataSetProvider and make it available to users of the data set service

Parameters:

provider - to add

removeProvider

void removeProvider(DataSetProvider provider)
                    throws APIException

Remove a registered DataSetProvider

Parameters:

provider -

Throws:

APIException

getProvider

DataSetProvider getProvider(DataSetDefinition definition)
                            throws APIException

Parameters:

definition -

Returns:

A registered DataSetProvider capable of evaluating the given definition

Throws:

APIException

evaluate

DataSet evaluate(DataSetDefinition definition,
                 Cohort inputCohort,
                 EvaluationContext evalContext)
                 throws APIException

Evaluate a data set definition and return a

Parameters:

definition -

inputCohort - Input cohort optionally specified by the user. May be ignored by some data sets.

evalContext - EvaluationContext containing parameter values, etc

Returns:

Throws:

APIException - when no DataSetProvider is found in the registered providers for the given definition

See Also:

setProviders(List)