org.openmrs.report
Interface DataSet<T>
All Superinterfaces: java.lang.Iterable<java.util.Map<java.lang.String,T>>
All Known Subinterfaces: MapDataSet <T>
All Known Implementing Classes: CohortDataSet , RowPerObsDataSet , RowPerProgramEnrollmentDataSet
Deprecated. see reportingcompatibility module
@Deprecated
public interface DataSet<T> extends java.lang.Iterable<java.util.Map<java.lang.String,T>>
Implementations of this interface represent the equivalent of a spreadsheet of data, i.e. columns
and rows. Typically subclasses will implement DataSet, but if all the cells in a table
have the same datatype, the subclass could implement DataSet, like for example
CohortDataSet
. This is one of three interfaces that work together to define and evaluate
an OpenMRS DataSet. You need to implement all three of DataSetProvider, DataSetDefinition
, and DataSet
in order to get useful behavior. For example:
RowPerObsDataSetProvider
, RowPerObsDataSetDefinition
, and
RowPerObsDataSet
The metadata that describes what data will be produced is defined in
DataSetDefinition
The logic that evaluates that metadata goes in an implementation of
DataSetProvider
. After evaluation, the data is represented by an implementation of this
interface.
See Also: DataSetProvider
,
DataSetDefinition
getDefinition
DataSetDefinition getDefinition ()
Deprecated.
Returns: The definition that was evaluated to produce this data set.
getEvaluationContext
EvaluationContext getEvaluationContext ()
Deprecated.
Returns: The evaluationContext where this DataSet was evaluated.
iterator
java.util.Iterator<java.util.Map<java.lang.String,T >> iterator ()
Deprecated. The keys of the maps that this iterator returns are given by
this.getDefinition().getColumnKeys()
Specified by: iterator
in interface java.lang.Iterable<java.util.Map<java.lang.String,T >>
Returns: an iterator over the rows in this dataset.
Generated Apr 27 2012 10:06 PM. NOTE - these libraries are in active development and subject to change