org.openmrs.reporting

Class RelationshipPatientFilter

java.lang.Object

org.openmrs.BaseOpenmrsObject

org.openmrs.reporting.AbstractReportObject

org.openmrs.reporting.AbstractPatientFilter

org.openmrs.reporting.CachingPatientFilter

org.openmrs.reporting.RelationshipPatientFilter

All Implemented Interfaces:

OpenmrsObject, PatientFilter, ReportObject

public class RelationshipPatientFilter
extends CachingPatientFilter

Field Summary

Fields inherited from class org.openmrs.reporting.CachingPatientFilter

log

Constructor Summary

Constructors

Constructor and Description
RelationshipPatientFilter()

Method Summary

Modifier and Type	Method and Description
Cohort	filterImpl(EvaluationContext context) Subclasses should implement PatientFilter.filter("all patients", evalContext) in this method
String	getCacheKey()
String	getDescription()
Person	getPerson()
RelationshipType	getRelationshipType()
boolean	isIncludeAtoB()
boolean	isIncludeBtoA()
boolean	isReadyToRun() Check whether this filter has had enough parameters set to be run properly
void	setIncludeAtoB(boolean includeAtoB)
void	setIncludeBtoA(boolean includeBtoA)
void	setPerson(Person person)
void	setRelationshipType(RelationshipType relationshipType)

Methods inherited from class org.openmrs.reporting.CachingPatientFilter

filter, filterInverse

Methods inherited from class org.openmrs.reporting.AbstractPatientFilter

getConceptName

Methods inherited from class org.openmrs.reporting.AbstractReportObject

equals, 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

getName, getReportObjectId, setDescription, setName, setReportObjectId

Methods inherited from interface org.openmrs.OpenmrsObject

getId, getUuid, setId, setUuid

Constructor Detail

RelationshipPatientFilter

public RelationshipPatientFilter()

Method Detail

filterImpl

public Cohort filterImpl(EvaluationContext context)

Description copied from class: CachingPatientFilter

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

Specified by:

filterImpl in class CachingPatientFilter

Returns:

TODO

See Also:

CachingPatientFilter.filterImpl(org.openmrs.report.EvaluationContext)

getDescription

public String getDescription()

Specified by:

getDescription in interface ReportObject

Overrides:

getDescription in class AbstractReportObject

Returns:

Returns the description

See Also:

AbstractReportObject.getDescription()

getCacheKey

public String getCacheKey()

Specified by:

getCacheKey in class CachingPatientFilter

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.

See Also:

CachingPatientFilter.getCacheKey()

isReadyToRun

public boolean isReadyToRun()

Description copied from interface: PatientFilter

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

Specified by:

isReadyToRun in interface PatientFilter

Specified by:

isReadyToRun in class CachingPatientFilter

Returns:

true if the filter has enough parameters set, false otherwise

See Also:

CachingPatientFilter.isReadyToRun()

getPerson

public Person getPerson()

setPerson

public void setPerson(Person person)

getRelationshipType

public RelationshipType getRelationshipType()

setRelationshipType

public void setRelationshipType(RelationshipType relationshipType)

isIncludeAtoB

public boolean isIncludeAtoB()

setIncludeAtoB

public void setIncludeAtoB(boolean includeAtoB)

isIncludeBtoA

public boolean isIncludeBtoA()

setIncludeBtoA

public void setIncludeBtoA(boolean includeBtoA)