Skip to content

TRUNK-5891: Migrated Cohort and CohortMembership to Annotations #5552

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Chaz0rk wants to merge 1 commit into
base: master
Choose a base branch
from
Open

TRUNK-5891: Migrated Cohort and CohortMembership to Annotations #5552

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
147 changes: 77 additions & 70 deletions api/src/main/java/org/openmrs/Cohort.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@
*/
package org.openmrs;

import jakarta.persistence.CascadeType;
import jakarta.persistence.Column;
import jakarta.persistence.Entity;
import jakarta.persistence.GeneratedValue;
import jakarta.persistence.GenerationType;
import jakarta.persistence.Id;
import jakarta.persistence.OneToMany;
import jakarta.persistence.Table;
import org.apache.commons.lang3.StringUtils;
import org.hibernate.envers.Audited;

Expand All @@ -23,22 +31,30 @@
* This class represents a list of patientIds.
*/
@Audited
@Entity
@Table(name = "cohort")
public class Cohort extends BaseChangeableOpenmrsData {

public static final long serialVersionUID = 0L;


@Id
@GeneratedValue(strategy = GenerationType.AUTO)
@Column(name = "cohort_id")
private Integer cohortId;


@Column(name = "name", nullable = false)
private String name;


@Column(name = "description", nullable = false, length = 1000)
private String description;


@OneToMany(mappedBy = "cohort", cascade = CascadeType.ALL, orphanRemoval = true)
private Collection<CohortMembership> memberships;

public Cohort() {
memberships = new TreeSet<>();
}

/**
* Convenience constructor to create a Cohort object that has an primarykey/internal identifier
* of <code>cohortId</code>
Expand All @@ -49,12 +65,11 @@ public Cohort(Integer cohortId) {
this();
this.cohortId = cohortId;
}

/**
* This constructor does not check whether the database contains patients with the given ids,
* but {@link org.openmrs.api.CohortService#saveCohort(Cohort)} will.
*
* @param name
* * @param name
* @param description optional description
* @param ids option array of Integer ids
*/
Expand All @@ -66,12 +81,11 @@ public Cohort(String name, String description, Integer[] ids) {
Arrays.stream(ids).forEach(this::addMember);
}
}

/**
* This constructor does not check whether the database contains patients with the given ids,
* but {@link org.openmrs.api.CohortService#saveCohort(Cohort)} will.
*
* @param name
* * @param name
* @param description optional description
* @param patients optional array of patients
*/
Expand All @@ -81,26 +95,24 @@ public Cohort(String name, String description, Patient[] patients) {
Arrays.stream(patients).forEach(p -> addMembership(new CohortMembership(p.getPatientId())));
}
}

/**
* This constructor does not check whether the database contains patients with the given ids,
* but {@link org.openmrs.api.CohortService#saveCohort(Cohort)} will.
*
* @param patientsOrIds optional collection which may contain Patients, or patientIds which may
* be Integers, Strings, or anything whose toString() can be parsed to an Integer.
* * @param patientsOrIds optional collection which may contain Patients, or patientIds which may
* be Integers, Strings, or anything whose toString() can be parsed to an Integer.
*/
public Cohort(Collection<?> patientsOrIds) {
this(null, null, patientsOrIds);
}

/**
* This constructor does not check whether the database contains patients with the given ids,
* but {@link org.openmrs.api.CohortService#saveCohort(Cohort)} will.
*
* @param name
* * @param name
* @param description optional description
* @param patientsOrIds optional collection which may contain Patients, or patientIds which may
* be Integers, Strings, or anything whose toString() can be parsed to an Integer.
* be Integers, Strings, or anything whose toString() can be parsed to an Integer.
*/
public Cohort(String name, String description, Collection<?> patientsOrIds) {
this(name, description, (Integer[]) null);
Expand All @@ -114,20 +126,19 @@ public Cohort(String name, String description, Collection<?> patientsOrIds) {
}
}
}

/**
* 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
* {@link org.openmrs.api.CohortService#saveCohort(Cohort)} will.
*
* @param commaSeparatedIds
* * @param commaSeparatedIds
*/
public Cohort(String commaSeparatedIds) {
this();
String[] ids = StringUtils.split(commaSeparatedIds, ',');
Arrays.stream(ids).forEach(id -> addMembership(new CohortMembership(Integer.valueOf(id.trim()))));
}

/**
* @deprecated since 2.1.0 cohorts are more complex than just a set of patient ids, so there is no one-line replacement
* @return Returns a comma-separated list of patient ids in the cohort.
Expand All @@ -136,12 +147,12 @@ public Cohort(String commaSeparatedIds) {
public String getCommaSeparatedPatientIds() {
return StringUtils.join(getMemberIds(), ',');
}

public boolean contains(Integer patientId) {
return getMemberships() != null
&& getMemberships().stream().anyMatch(m -> m.getPatientId().equals(patientId) && !m.getVoided());
&& getMemberships().stream().anyMatch(m -> m.getPatientId().equals(patientId) && !m.getVoided());
}

@Override
public String toString() {
StringBuilder sb = new StringBuilder("Cohort id=" + getCohortId());
Expand All @@ -153,11 +164,11 @@ public String toString() {
}
return sb.toString();
}

public void addMember(Integer memberId) {
this.addMembership(new CohortMembership(memberId));
}

/**
* @since 2.1.0
*/
Expand All @@ -168,14 +179,14 @@ public boolean addMembership(CohortMembership cohortMembership) {
}
return false;
}

/**
* @since 2.1.0
*/
public boolean removeMembership(CohortMembership cohortMembership) {
return getMemberships().remove(cohortMembership);
}

/**
* @since 2.1.0
* @param includeVoided boolean true/false to include/exclude voided memberships
Expand All @@ -187,7 +198,7 @@ public Collection<CohortMembership> getMemberships(boolean includeVoided) {
}
return getMemberships().stream().filter(m -> m.getVoided() == includeVoided).collect(Collectors.toList());
}

/**
* @since 2.1.0
*/
Expand All @@ -197,7 +208,7 @@ public Collection<CohortMembership> getMemberships() {
}
return memberships;
}

/**
* @since 2.1.0
* @param asOfDate date used to return active memberships
Expand All @@ -206,37 +217,37 @@ public Collection<CohortMembership> getMemberships() {
public Collection<CohortMembership> getActiveMemberships(Date asOfDate) {
return getMemberships().stream().filter(m -> m.isActive(asOfDate)).collect(Collectors.toList());
}

public Collection<CohortMembership> getActiveMemberships() {
return getActiveMemberships(new Date());
}

/**
* @since 2.1.0
*/
public CohortMembership getActiveMembership(Patient patient) {
return getMemberships().stream().filter(m -> m.isActive() && m.getPatientId().equals(patient.getPatientId())).findFirst().get();
}

public int size() {
return getMemberships().stream().filter(m -> !m.getVoided()).collect(Collectors.toList())
.size();
.size();
}

/**
* @deprecated use {@link #size()}
*/
@Deprecated
public int getSize() {
return size();
}

public boolean isEmpty() {
return size() == 0;
}

// static utility methods

/**
* Returns the union of two cohorts
*
Expand All @@ -257,7 +268,7 @@ public static Cohort union(Cohort a, Cohort b) {
}
return ret;
}

/**
* Returns the intersection of two cohorts, treating null as an empty cohort
*
Expand All @@ -274,7 +285,7 @@ public static Cohort intersect(Cohort a, Cohort b) {
}
return ret;
}

/**
* Subtracts a cohort from a cohort
*
Expand All @@ -293,33 +304,33 @@ public static Cohort subtract(Cohort a, Cohort b) {
}
return ret;
}

// getters and setters

public Integer getCohortId() {
return cohortId;
}

public void setCohortId(Integer cohortId) {
this.cohortId = cohortId;
}

public String getDescription() {
return description;
}

public void setDescription(String description) {
this.description = description;
}

public String getName() {
return name;
}

public void setName(String name) {
this.name = name;
}

/**
* @deprecated since 2.1.0 cohorts are more complex than just a set of patient ids, so there is no one-line replacement
*/
Expand All @@ -331,7 +342,7 @@ public Set<Integer> getMemberIds() {
}
return memberIds;
}

/**
* @deprecated since 2.1.0 cohorts are more complex than just a set of patient ids, so there is no one-line replacement
* @param memberIds
Expand All @@ -347,60 +358,56 @@ public void setMemberIds(Set<Integer> memberIds) {
throw new IllegalArgumentException("since 2.1.0 cohorts are more complex than just a set of patient ids");
}
}

public void setMemberships(Collection<CohortMembership> members) {
this.memberships = members;
}

/**
* @since 1.5
* @see org.openmrs.OpenmrsObject#getId()
*/
@Override
public Integer getId() {

return getCohortId();
}

/**
* @since 1.5
* @see org.openmrs.OpenmrsObject#setId(java.lang.Integer)
*/
@Override
public void setId(Integer id) {
setCohortId(id);

}

/**
* @since 2.3
*
* This function checks if there exists any active CohortMembership for a given patientId
*
* @param patientId is the patientid that should be checked for activity in cohort
* * This function checks if there exists any active CohortMembership for a given patientId
* * @param patientId is the patientid that should be checked for activity in cohort
* @return true if cohort has active membership for the requested patient
*/
public boolean hasActiveMembership(int patientId) {
return getMemberships().stream().anyMatch(m -> m.getPatientId() == patientId && m.isActive());
}

/**
*
* @since 2.3
* * @since 2.3
* This method returns the number of active members in the cohort
*
* @return number of active memberships in the cohort
* * @return number of active memberships in the cohort
*/
public int activeMembershipSize() {
return getActiveMemberships().size();
}

/**
*
* @since 2.3
* This method returns true if cohort has no active memberships
*
* @return true if no active cohort exists
* @return true if no active cohort exist
**/
public boolean hasNoActiveMemberships() {
return getActiveMemberships().isEmpty();
Expand Down
Loading
Loading