org.openmrs

Class Cohort

java.lang.Object

org.openmrs.BaseOpenmrsObject

org.openmrs.BaseOpenmrsData

org.openmrs.BaseChangeableOpenmrsData

org.openmrs.Cohort

All Implemented Interfaces:

Serializable, Auditable, Changeable, Creatable, OpenmrsData, OpenmrsObject, Voidable

public class Cohort
extends BaseChangeableOpenmrsData

This class represents a list of patientIds.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from class org.openmrs.BaseOpenmrsData

creator

Constructor Summary

Constructors

Constructor and Description
Cohort()
Cohort(Collection<?> patientsOrIds) This constructor does not check whether the database contains patients with the given ids, but CohortService.saveCohort(Cohort) will.
Cohort(Integer cohortId) Convenience constructor to create a Cohort object that has an primarykey/internal identifier of cohortId
Cohort(String commaSeparatedIds) Convenience constructor 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 CohortService.saveCohort(Cohort) will.
Cohort(String name, String description, Collection<?> patientsOrIds) This constructor does not check whether the database contains patients with the given ids, but CohortService.saveCohort(Cohort) will.
Cohort(String name, String description, Integer[] ids) This constructor does not check whether the database contains patients with the given ids, but CohortService.saveCohort(Cohort) will.
Cohort(String name, String description, Patient[] patients) This constructor does not check whether the database contains patients with the given ids, but CohortService.saveCohort(Cohort) will.

Method Summary

Modifier and Type	Method and Description
int	activeMembershipSize()
void	addMember(Integer memberId)
boolean	addMembership(CohortMembership cohortMembership)
boolean	contains(Integer patientId)
CohortMembership	getActiveMembership(Patient patient)
Collection<CohortMembership>	getActiveMemberships()
Collection<CohortMembership>	getActiveMemberships(Date asOfDate)
Integer	getCohortId()
String	getCommaSeparatedPatientIds() Deprecated. since 2.1.0 cohorts are more complex than just a set of patient ids, so there is no one-line replacement
String	getDescription()
Integer	getId()
Set<Integer>	getMemberIds() Deprecated. since 2.1.0 cohorts are more complex than just a set of patient ids, so there is no one-line replacement
Collection<CohortMembership>	getMemberships()
Collection<CohortMembership>	getMemberships(boolean includeVoided)
String	getName()
int	getSize() Deprecated. use size()
boolean	hasActiveMembership(int patientId)
boolean	hasNoActiveMemberships()
static Cohort	intersect(Cohort a, Cohort b) Returns the intersection of two cohorts, treating null as an empty cohort
boolean	isEmpty()
boolean	removeMembership(CohortMembership cohortMembership)
void	setCohortId(Integer cohortId)
void	setDescription(String description)
void	setId(Integer id)
void	setMemberIds(Set<Integer> memberIds) Deprecated. since 2.1.0 cohorts are more complex than just a set of patient ids, so there is no one-line replacement
void	setMemberships(Collection<CohortMembership> members)
void	setName(String name)
int	size()
static Cohort	subtract(Cohort a, Cohort b) Subtracts a cohort from a cohort
String	toString() Returns a string equal to the value of: ClassName{hashCode=..., uuid=...}
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 CohortService.saveCohort(Cohort) will.

Parameters:

name -

description - optional description

ids - option array of Integer ids

Cohort

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

This constructor does not check whether the database contains patients with the given ids, but CohortService.saveCohort(Cohort) will.

Parameters:

name -

description - optional description

patients - optional array of patients

Cohort

public Cohort(Collection<?> patientsOrIds)

This constructor does not check whether the database contains patients with the given ids, but CohortService.saveCohort(Cohort) will.

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.

Cohort

public Cohort(String name,
              String description,
              Collection<?> patientsOrIds)

This constructor does not check whether the database contains patients with the given ids, but CohortService.saveCohort(Cohort) will.

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.

Cohort

public Cohort(String commaSeparatedIds)

Convenience constructor 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 CohortService.saveCohort(Cohort) will.

Parameters:

commaSeparatedIds -

Method Detail

getCommaSeparatedPatientIds

@Deprecated
public String getCommaSeparatedPatientIds()

Deprecated. since 2.1.0 cohorts are more complex than just a set of patient ids, so there is no one-line replacement

Returns:

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

contains

public boolean contains(Integer patientId)

toString

public String toString()

Description copied from class: BaseOpenmrsObject

Returns a string equal to the value of:

ClassName{hashCode=..., uuid=...}

If the uuid field is null, it returns:

ClassName{hashCode=...}

Should include hashCode if uuid is null Should include uuid if not null

Overrides:

toString in class BaseOpenmrsObject

addMember

public void addMember(Integer memberId)

addMembership

public boolean addMembership(CohortMembership cohortMembership)

Since:

2.1.0

removeMembership

public boolean removeMembership(CohortMembership cohortMembership)

Since:

2.1.0

getMemberships

public Collection<CohortMembership> getMemberships(boolean includeVoided)

Parameters:

includeVoided - boolean true/false to include/exclude voided memberships

Returns:

Collection of cohort memberships

Since:

2.1.0

getMemberships

public Collection<CohortMembership> getMemberships()

Since:

2.1.0

getActiveMemberships

public Collection<CohortMembership> getActiveMemberships(Date asOfDate)

Parameters:

asOfDate - date used to return active memberships

Returns:

Collection of cohort memberships

Since:

2.1.0

getActiveMemberships

public Collection<CohortMembership> getActiveMemberships()

getActiveMembership

public CohortMembership getActiveMembership(Patient patient)

Since:

2.1.0

size

public int size()

getSize

@Deprecated
public int getSize()

Deprecated. use size()

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

@Deprecated
public Set<Integer> getMemberIds()

Deprecated. since 2.1.0 cohorts are more complex than just a set of patient ids, so there is no one-line replacement

setMemberIds

@Deprecated
public void setMemberIds(Set<Integer> memberIds)

Deprecated. since 2.1.0 cohorts are more complex than just a set of patient ids, so there is no one-line replacement

Parameters:

memberIds -

setMemberships

public void setMemberships(Collection<CohortMembership> members)

getId

public Integer getId()

Returns:

id - The unique Identifier for the object

Since:

1.5

See Also:

OpenmrsObject.getId()

setId

public void setId(Integer id)

Parameters:

id - - The unique Identifier for the object

Since:

1.5

See Also:

OpenmrsObject.setId(java.lang.Integer)

hasActiveMembership

public boolean hasActiveMembership(int patientId)

Parameters:

patientId - is the patientid that should be checked for activity in cohort

Returns:

true if cohort has active membership for the requested patient

Since:

2.3 This function checks if there exists any active CohortMembership for a given patientId

activeMembershipSize

public int activeMembershipSize()

Returns:

number of active memberships in the cohort

Since:

2.3 This method returns the number of active members in the cohort

hasNoActiveMemberships

public boolean hasNoActiveMemberships()

Returns:

true if no active cohort exists

Since:

2.3 This method returns true if cohort has no active memberships