org.openmrs.report
Class ReportSchema

java.lang.Object
  org.openmrs.BaseOpenmrsObject
      org.openmrs.BaseOpenmrsMetadata
          org.openmrs.report.ReportSchema

All Implemented Interfaces:

java.io.Serializable, Auditable, OpenmrsMetadata, OpenmrsObject, Parameterizable, Retireable

Deprecated. see reportingcompatibility module

@Deprecated
public class ReportSchema
extends BaseOpenmrsMetadata
implements Parameterizable

This class holds the different parts of a report before generation. A ReportSchema will typically be evaluated upon a Cohort, in the context of an EvaluationContext. See ReportService.evaluate(ReportSchema, org.openmrs.Cohort, EvaluationContext)

Evaluating a report really means evaluating all the DataSetDefinitions it contains, resulting in a ReportData

The "filter" represents an (optional) extra filter that is applied to the input cohort before the DataSetDefinitions ever see it.

See Also:

Serialized Form

Constructor Summary

ReportSchema()
Deprecated.

Method Summary

void	addDataSetDefinition(DataSetDefinition definition) Deprecated.
java.util.List<DataSetDefinition>	getDataSetDefinitions() Deprecated. Returns List dataSetDefinitions
java.lang.String	getDescription() Deprecated. Returns the description of this ReportSchema
CohortDefinition	getFilter() Deprecated. Returns the filter
java.lang.Integer	getId() Deprecated.
java.lang.String	getName() Deprecated. Returns the name of the ReportSchema
java.util.List<Parameter>	getParameters() Deprecated. Looks through the datasetdefinitions and cohorts to get the rquired parameters TODO
java.util.List<Parameter>	getReportParameters() Deprecated. Get all ReportParameters defined for this schema.
java.lang.Integer	getReportSchemaId() Deprecated. Returns the ReportSchema Id
void	setDataSetDefinitions(java.util.List<DataSetDefinition> definitions) Deprecated. Set List dataSetDefinitions
void	setDescription(java.lang.String description) Deprecated. Set a description for this ReportSchema
void	setFilter(CohortDefinition filter) Deprecated. Set the filter
void	setId(java.lang.Integer id) Deprecated.
void	setName(java.lang.String name) Deprecated. Set a name for the ReportSchema
void	setReportParameters(java.util.List<Parameter> reportParameters) Deprecated. Sets List reportParameters
void	setReportSchemaId(java.lang.Integer reportSchemaId) Deprecated. Set the Report Schema Id

Methods inherited from class org.openmrs.BaseOpenmrsMetadata

getChangedBy, getCreator, getDateChanged, getDateCreated, getDateRetired, getRetired, getRetiredBy, getRetireReason, isRetired, setChangedBy, setCreator, setDateChanged, setDateCreated, setDateRetired, setRetired, setRetiredBy, setRetireReason

Methods inherited from class org.openmrs.BaseOpenmrsObject

getUuid, setUuid

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openmrs.OpenmrsObject

getUuid, setUuid

Constructor Detail

ReportSchema

public ReportSchema()

Deprecated.

Method Detail

addDataSetDefinition

public void addDataSetDefinition(DataSetDefinition definition)

Deprecated.

getId

public java.lang.Integer getId()

Deprecated.

Specified by:

getId in interface OpenmrsObject

Returns:

id - The unique Identifier for the object

See Also:

OpenmrsObject.getId()

setId

public void setId(java.lang.Integer id)

Deprecated.

Specified by:

setId in interface OpenmrsObject

Parameters:

id - - The unique Identifier for the object

See Also:

OpenmrsObject.setId(java.lang.Integer)

setReportSchemaId

public void setReportSchemaId(java.lang.Integer reportSchemaId)

Deprecated.

Set the Report Schema Id

Parameters:

reportSchemaId -

getReportSchemaId

public java.lang.Integer getReportSchemaId()

Deprecated.

Returns the ReportSchema Id

Returns:

the Integer Report Schema Id

setName

public void setName(java.lang.String name)

Deprecated.

Set a name for the ReportSchema

Specified by:

setName in interface OpenmrsMetadata

Overrides:

setName in class BaseOpenmrsMetadata

Parameters:

name - String name to set

getName

public java.lang.String getName()

Deprecated.

Returns the name of the ReportSchema

Specified by:

getName in interface OpenmrsMetadata

Overrides:

getName in class BaseOpenmrsMetadata

Returns:

the name of the ReportSchema

setDescription

public void setDescription(java.lang.String description)

Deprecated.

Set a description for this ReportSchema

Specified by:

setDescription in interface OpenmrsMetadata

Overrides:

setDescription in class BaseOpenmrsMetadata

Parameters:

description -

getDescription

public java.lang.String getDescription()

Deprecated.

Returns the description of this ReportSchema

Specified by:

getDescription in interface OpenmrsMetadata

Overrides:

getDescription in class BaseOpenmrsMetadata

Returns:

the String description of the ReportSchema

setFilter

public void setFilter(CohortDefinition filter)

Deprecated.

Set the filter

Parameters:

filter -

getFilter

public CohortDefinition getFilter()

Deprecated.

Returns the filter

Returns:

the filter as a CohortDefinition

setReportParameters

public void setReportParameters(java.util.List<Parameter> reportParameters)

Deprecated.

Sets List reportParameters

Parameters:

reportParameters - this schema's defined parameters

getReportParameters

public java.util.List<Parameter> getReportParameters()

Deprecated.

Get all ReportParameters defined for this schema. This method does not recurse through the sub objects to find _all_ parameters. Use getParameters() for that.

Returns:

this schema's defined parameters

setDataSetDefinitions

public void setDataSetDefinitions(java.util.List<DataSetDefinition> definitions)

Deprecated.

Set List dataSetDefinitions

Parameters:

definitions -

getDataSetDefinitions

public java.util.List<DataSetDefinition> getDataSetDefinitions()

Deprecated.

Returns List dataSetDefinitions

Returns:

List a list with the DataSet Definitions

getParameters

public java.util.List<Parameter> getParameters()

Deprecated.

Looks through the datasetdefinitions and cohorts to get the rquired parameters TODO

Specified by:

getParameters in interface Parameterizable

Returns:

list of parameters that will satisfy this object

See Also:

Parameterizable.getParameters()