org.openmrs.reporting
Interface PatientFilter

All Superinterfaces:
OpenmrsObject, ReportObject
All Known Implementing Classes:
CachingPatientFilter, CohortFilter, CohortHistoryCompositionFilter, CompoundPatientFilter, DrugOrderFilter, DrugOrderPatientFilter, DrugOrderStopFilter, EncounterPatientFilter, InversePatientFilter, LocationPatientFilter, LogicPatientFilter, ObsPatientFilter, PatientCharacteristicFilter, PersonAttributeFilter, ProgramPatientFilter, ProgramStatePatientFilter, RelationshipPatientFilter

Deprecated. see reportingcompatibility module

@Deprecated
public interface PatientFilter
extends ReportObject

PatientFilters may use an EvaluationContext for caching, but they ignore parameter values


Method Summary
 Cohort filter(Cohort input, EvaluationContext context)
          Deprecated. Determine all patients in _input_ who also match some criteria.
 Cohort filterInverse(Cohort input, EvaluationContext context)
          Deprecated. Determine all patients in _input_ who do *not* match some criteria
 boolean isReadyToRun()
          Deprecated. Check whether this filter has had enough parameters set to be run properly
 
Methods inherited from interface org.openmrs.reporting.ReportObject
getDescription, getName, getReportObjectId, setDescription, setName, setReportObjectId
 
Methods inherited from interface org.openmrs.OpenmrsObject
getId, getUuid, setId, setUuid
 

Method Detail

filter

Cohort filter(Cohort input,
              EvaluationContext context)
Deprecated. 
Determine all patients in _input_ who also match some criteria. If input is null, then this should return all patients who match.

Parameters:
input - Cohort of the patients to search
context - EvaluationContext specifying filtering criteria
Returns:
Cohort of the patients matching the criteria

filterInverse

Cohort filterInverse(Cohort input,
                     EvaluationContext context)
Deprecated. 
Determine all patients in _input_ who do *not* match some criteria

Parameters:
input - Cohort of the patients to search
context - EvaluationContext specifying filtering criteria
Returns:
Cohort of patients in input who do not meet specified criteria

isReadyToRun

boolean isReadyToRun()
Deprecated. 
Check whether this filter has had enough parameters set to be run properly

Returns:
true if the filter has enough parameters set, false otherwise

OpenMRS-1.7.x

Generated Apr 27 2012 10:06 PM. NOTE - these libraries are in active development and subject to change