org.openmrs.api

Interface DataSetService

All Known Implementing Classes:

DataSetServiceImpl

Deprecated.

see reportingcompatibility module

@Deprecated
public interface DataSetService

Method Summary

Methods

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

Method Detail

setProviders

void setProviders(List<DataSetProvider> providers)
                  throws APIException

Deprecated.

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

List<DataSetProvider> getProviders()
                                   throws APIException

Deprecated.

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)

Deprecated.

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

Parameters:

newProvider - DataSetProvider to add

removeProvider

void removeProvider(DataSetProvider provider)
                    throws APIException

Deprecated.

Remove a registered DataSetProvider

Parameters:

provider - DataSetProvider to remove

Throws:

APIException

getProvider

DataSetProvider getProvider(DataSetDefinition definition)
                            throws APIException

Deprecated.

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

Deprecated.

Evaluate a data set definition to get turn it into a DataSet

Parameters:

definition -

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

evalContext - EvaluationContext containing parameter values, etc

Returns:

a DataSet matching the parameters

Throws:

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

See Also:

setProviders(List)