org.openmrs.reporting

Class CachingPatientFilter

java.lang.Object

org.openmrs.BaseOpenmrsObject

org.openmrs.reporting.AbstractReportObject

org.openmrs.reporting.AbstractPatientFilter

org.openmrs.reporting.CachingPatientFilter

All Implemented Interfaces:

OpenmrsObject, PatientFilter, ReportObject

Direct Known Subclasses:

DrugOrderFilter, DrugOrderStopFilter, EncounterPatientFilter, LocationPatientFilter, ObsPatientFilter, PatientCharacteristicFilter, PersonAttributeFilter, ProgramStatePatientFilter, RelationshipPatientFilter

Deprecated.

see reportingcompatibility module

@Deprecated
public abstract class CachingPatientFilter
extends AbstractPatientFilter
implements PatientFilter

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	log Deprecated.

Constructor Summary

Constructors

Constructor and Description
CachingPatientFilter() Deprecated.

Method Summary

Modifier and Type	Method and Description
Cohort	filter(Cohort input, EvaluationContext context) Deprecated. Determine all patients in _input_ who also match some criteria.
abstract Cohort	filterImpl(EvaluationContext context) Deprecated. Subclasses should implement PatientFilter.filter("all patients", evalContext) in this method
Cohort	filterInverse(Cohort input, EvaluationContext context) Deprecated. Basic implementation of filterInverse that delegates to PatientSetService.getAllPatients() and this class's filter() method.
abstract String	getCacheKey() Deprecated.
abstract boolean	isReadyToRun() Deprecated. Check whether this filter has had enough parameters set to be run properly

Methods inherited from class org.openmrs.reporting.AbstractPatientFilter

getConceptName

Methods inherited from class org.openmrs.reporting.AbstractReportObject

equals, getDescription, getId, getName, getReportObjectId, getSubType, getType, setDescription, setId, setName, setReportObjectId, setSubType, setType, toString

Methods inherited from class org.openmrs.BaseOpenmrsObject

getUuid, setUuid

Methods inherited from class java.lang.Object

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

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

Field Detail

log

protected final org.apache.commons.logging.Log log

Deprecated.

Constructor Detail

CachingPatientFilter

public CachingPatientFilter()

Deprecated.

Method Detail

filterImpl

public abstract Cohort filterImpl(EvaluationContext context)

Deprecated.

Subclasses should implement PatientFilter.filter("all patients", evalContext) in this method

Parameters:

context -

Returns:

TODO

getCacheKey

public abstract String getCacheKey()

Deprecated.

Returns:

The key under which this object, with its current parameter values, will store results in a cache. Changing properties of this object will typically change the cache key returned.

filter

public Cohort filter(Cohort input,
                     EvaluationContext context)

Deprecated.

Description copied from interface: PatientFilter

Determine all patients in _input_ who also match some criteria. If input is null, then this should return all patients who match.

Specified by:

filter in interface PatientFilter

Parameters:

input - Cohort of the patients to search

context - EvaluationContext specifying filtering criteria

Returns:

Cohort of the patients matching the criteria

See Also:

PatientFilter.filter(org.openmrs.Cohort, org.openmrs.report.EvaluationContext)

filterInverse

public Cohort filterInverse(Cohort input,
                            EvaluationContext context)

Deprecated.

Description copied from class: AbstractPatientFilter

Basic implementation of filterInverse that delegates to PatientSetService.getAllPatients() and this class's filter() method. Subclasses may override this method if they have a way of doing so more efficiently (since getAllPatients can be very expensive).

Specified by:

filterInverse in interface PatientFilter

Overrides:

filterInverse in class AbstractPatientFilter

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

See Also:

PatientFilter.filterInverse(org.openmrs.Cohort, org.openmrs.report.EvaluationContext)

isReadyToRun

public abstract boolean isReadyToRun()

Deprecated.

Description copied from interface: PatientFilter

Check whether this filter has had enough parameters set to be run properly

Specified by:

isReadyToRun in interface PatientFilter

Returns:

true if the filter has enough parameters set, false otherwise

See Also:

PatientFilter.isReadyToRun()