org.openmrs
Class Cohort

java.lang.Object
  org.openmrs.BaseOpenmrsObject
      org.openmrs.BaseOpenmrsData
          org.openmrs.Cohort

All Implemented Interfaces:

Serializable, Auditable, OpenmrsData, OpenmrsObject, Voidable

public class Cohort
extends BaseOpenmrsData
implements Serializable

This class represents a list of patientIds. If it is generated from a CohortDefinition via ReportService.evaluate(org.openmrs.report.ReportSchema, Cohort, EvaluationContext) then it will contain a link back to the CohortDefinition it came from and the EvalutionContext that definition was evaluated in.

See Also:

CohortDefinition, Serialized Form

Field Summary

static long

serialVersionUID

Fields inherited from class org.openmrs.BaseOpenmrsData

creator

Constructor Summary

Cohort()

Cohort(Collection patientsOrIds)
This constructor does not check whether the database contains patients with the given ids, but

Cohort(Integer cohortId)
Convenience constructor to create a Cohort object that has an primarykey/internal identifier of cohortId

Cohort(String commaSeparatedIds)
Convenience contructor taking in a string that is a list of comma separated patient ids This constructor does not check whether the database contains patients with the given ids, but

Cohort(String name, String description, Collection patientsOrIds)
This constructor does not check whether the database contains patients with the given ids, but

Cohort(String name, String description, Integer[] ids)
This constructor does not check whether the database contains patients with the given ids, but

Cohort(String name, String description, Patient[] patients)
This constructor does not check whether the database contains patients with the given ids, but

Method Summary

void	addMember(Integer memberId)
boolean	contains(Integer patientId)
boolean	contains(Patient patient)
CohortDefinition	getCohortDefinition() Deprecated.
Integer	getCohortId()
String	getCommaSeparatedPatientIds()
String	getDescription()
EvaluationContext	getEvaluationContext() Deprecated.
Integer	getId()
Set<Integer>	getMemberIds()
String	getName()
Set<Integer>	getPatientIds() Deprecated. use #getMemberIds()
int	getSize()
static Cohort	intersect(Cohort a, Cohort b) Returns the intersection of two cohorts, treating null as an empty cohort
boolean	isEmpty()
void	removeMember(Integer memberId)
void	setCohortDefinition(CohortDefinition cohortDefinition) Deprecated.
void	setCohortId(Integer cohortId)
void	setDescription(String description)
void	setEvaluationContext(EvaluationContext evaluationContext) Deprecated.
void	setId(Integer id)
void	setMemberIds(Set<Integer> memberIds)
void	setName(String name)
int	size()
static Cohort	subtract(Cohort a, Cohort b) Subtracts a cohort from a cohort
String	toString() Returns a string consisting of the name of the class of which the object is an instance and the uuid field surrounded by [ and ].
static Cohort	union(Cohort a, Cohort b) Returns the union of two cohorts

Methods inherited from class org.openmrs.BaseOpenmrsData

getChangedBy, getCreator, getDateChanged, getDateCreated, getDateVoided, getVoided, getVoidedBy, getVoidReason, isVoided, setChangedBy, setCreator, setDateChanged, setDateCreated, setDateVoided, setVoided, setVoidedBy, setVoidReason

Methods inherited from class org.openmrs.BaseOpenmrsObject

equals, getUuid, hashCode, setUuid

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openmrs.OpenmrsObject

getUuid, setUuid

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

Cohort

public Cohort()

Cohort

public Cohort(Integer cohortId)

Convenience constructor to create a Cohort object that has an primarykey/internal identifier of cohortId

Parameters:

cohortId - the internal identifier for this cohort

Cohort

public Cohort(String name,
              String description,
              Integer[] ids)

This constructor does not check whether the database contains patients with the given ids, but

Parameters:

name -

description - optional description

ids - option array of Integer ids

See Also:

will.

Cohort

public Cohort(String name,
              String description,
              Patient[] patients)

This constructor does not check whether the database contains patients with the given ids, but

Parameters:

name -

description - optional description

patients - optional array of patients

See Also:

will.

Cohort

public Cohort(Collection patientsOrIds)

This constructor does not check whether the database contains patients with the given ids, but

Parameters:

patientsOrIds - optional collection which may contain Patients, or patientIds which may be Integers, Strings, or anything whose toString() can be parsed to an Integer.

See Also:

will.

Cohort

public Cohort(String name,
              String description,
              Collection patientsOrIds)

This constructor does not check whether the database contains patients with the given ids, but

Parameters:

name -

description - optional description

patientsOrIds - optional collection which may contain Patients, or patientIds which may be Integers, Strings, or anything whose toString() can be parsed to an Integer.

See Also:

will.

Cohort

public Cohort(String commaSeparatedIds)

Convenience contructor taking in a string that is a list of comma separated patient ids This constructor does not check whether the database contains patients with the given ids, but

Parameters:

commaSeparatedIds -

See Also:

will.

Method Detail

getCommaSeparatedPatientIds

public String getCommaSeparatedPatientIds()

Returns:

Returns a comma-separated list of patient ids in the cohort.

contains

public boolean contains(Patient patient)

contains

public boolean contains(Integer patientId)

toString

public String toString()

Description copied from class: BaseOpenmrsObject

Returns a string consisting of the name of the class of which the object is an instance and the uuid field surrounded by [ and ]. In other words, this method returns a string equal to the value of:

 getClass().getName() + '[' + uuid + ']'
 

If the uuid field is null, it delegates to Object.toString()

Overrides:

toString in class BaseOpenmrsObject

See Also:

Object.toString()

addMember

public void addMember(Integer memberId)

removeMember

public void removeMember(Integer memberId)

size

public int size()

getSize

public int getSize()

isEmpty

public boolean isEmpty()

union

public static Cohort union(Cohort a,
                           Cohort b)

Returns the union of two cohorts

Parameters:

a - The first Cohort

b - The second Cohort

Returns:

Cohort

intersect

public static Cohort intersect(Cohort a,
                               Cohort b)

Returns the intersection of two cohorts, treating null as an empty cohort

Parameters:

a - The first Cohort

b - The second Cohort

Returns:

Cohort

subtract

public static Cohort subtract(Cohort a,
                              Cohort b)

Subtracts a cohort from a cohort

Parameters:

a - the original Cohort

b - the Cohort to subtract

Returns:

Cohort

getCohortId

public Integer getCohortId()

setCohortId

public void setCohortId(Integer cohortId)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getName

public String getName()

setName

public void setName(String name)

getMemberIds

public Set<Integer> getMemberIds()

getPatientIds

public Set<Integer> getPatientIds()

Deprecated. use #getMemberIds()

This method is only here for some backwards compatibility with the PatientSet object that this Cohort object replaced. Do not use this method.

Returns:

the memberIds

setMemberIds

public void setMemberIds(Set<Integer> memberIds)

getCohortDefinition

@Deprecated
public CohortDefinition getCohortDefinition()

Deprecated.

Returns:

the cohortDefinition

setCohortDefinition

@Deprecated
public void setCohortDefinition(CohortDefinition cohortDefinition)

Deprecated.

Parameters:

cohortDefinition - the cohortDefinition to set

getEvaluationContext

@Deprecated
public EvaluationContext getEvaluationContext()

Deprecated.

Returns:

the evaluationContext

setEvaluationContext

@Deprecated
public void setEvaluationContext(EvaluationContext evaluationContext)

Deprecated.

Parameters:

evaluationContext - the evaluationContext to set

getId

public Integer getId()

Specified by:

getId in interface OpenmrsObject

Returns:

id - The unique Identifier for the object

Since:

1.5

See Also:

OpenmrsObject.getId()

setId

public void setId(Integer id)

Specified by:

setId in interface OpenmrsObject

Parameters:

id - - The unique Identifier for the object

Since:

1.5

See Also:

OpenmrsObject.setId(java.lang.Integer)