org.dspace.eperson.Group Maven / Gradle / Ivy
Show all versions of dspace-api Show documentation
/**
* The contents of this file are subject to the license and copyright
* detailed in the LICENSE and NOTICE files at the root of the source
* tree and available online at
*
* http://www.dspace.org/license/
*/
package org.dspace.eperson;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;
import jakarta.persistence.Column;
import jakarta.persistence.Entity;
import jakarta.persistence.FetchType;
import jakarta.persistence.JoinColumn;
import jakarta.persistence.JoinTable;
import jakarta.persistence.ManyToMany;
import jakarta.persistence.Table;
import jakarta.persistence.Transient;
import org.apache.commons.lang3.StringUtils;
import org.dspace.content.CacheableDSpaceObject;
import org.dspace.content.DSpaceObjectLegacySupport;
import org.dspace.core.Constants;
import org.dspace.core.Context;
import org.dspace.core.HibernateProxyHelper;
/**
* Class representing a group of e-people.
*
* @author David Stuve
*/
@Entity
@Table(name = "epersongroup")
public class Group extends CacheableDSpaceObject implements DSpaceObjectLegacySupport {
@Transient
public static final String ANONYMOUS = "Anonymous";
@Transient
public static final String ADMIN = "Administrator";
/**
* Initial value is set to 2 since 0 and 1 are reserved for anonymous and administrative uses, respectively
*/
@Column(name = "eperson_group_id", insertable = false, updatable = false)
private Integer legacyId;
/**
* This Group may not be deleted or renamed.
*/
@Column
private Boolean permanent = false;
@Column(length = 250, unique = true)
private String name;
/**
* lists of epeople and groups in the group
*/
@ManyToMany(fetch = FetchType.LAZY)
@JoinTable(
name = "epersongroup2eperson",
joinColumns = {@JoinColumn(name = "eperson_group_id")},
inverseJoinColumns = {@JoinColumn(name = "eperson_id")}
)
private final List epeople = new ArrayList<>();
@ManyToMany(fetch = FetchType.LAZY)
@JoinTable(
name = "group2group",
joinColumns = {@JoinColumn(name = "parent_id")},
inverseJoinColumns = {@JoinColumn(name = "child_id")}
)
private final List groups = new ArrayList<>();
@ManyToMany(fetch = FetchType.LAZY, mappedBy = "groups")
private final List parentGroups = new ArrayList<>();
@Transient
private boolean groupsChanged;
/**
* Protected constructor, create object using:
* {@link org.dspace.eperson.service.GroupService#create(Context)}
*/
protected Group() {
}
void addMember(EPerson e) {
getMembers().add(e);
}
/**
* Return EPerson members of a Group.
*
* WARNING: This method may have bad performance for Groups with large numbers of EPerson members.
* Therefore, only use this when you need to access every EPerson member. Instead, consider using
* EPersonService.findByGroups() for a paginated list of EPersons.
*
* @return list of EPersons
*/
public List getMembers() {
return epeople;
}
void addMember(Group g) {
getMemberGroups().add(g);
groupsChanged = true;
}
void addParentGroup(Group group) {
getParentGroups().add(group);
groupsChanged = true;
}
void removeParentGroup(Group group) {
getParentGroups().remove(group);
groupsChanged = true;
}
boolean remove(EPerson e) {
return getMembers().remove(e);
}
boolean remove(Group g) {
groupsChanged = true;
return getMemberGroups().remove(g);
}
boolean contains(Group g) {
return getMemberGroups().contains(g);
}
boolean contains(EPerson e) {
return getMembers().contains(e);
}
List getParentGroups() {
return parentGroups;
}
/**
* Return Group members (i.e. direct subgroups) of a Group.
*
* WARNING: This method may have bad performance for Groups with large numbers of Subgroups.
* Therefore, only use this when you need to access every Subgroup. Instead, consider using
* GroupService.findByParent() for a paginated list of Subgroups.
*
* @return list of subgroups
*/
public List getMemberGroups() {
return groups;
}
/**
* Return true if other is the same Group as
* this object, false otherwise
*
* @param obj object to compare to
* @return true if object passed in represents the same group
* as this object
*/
@Override
public boolean equals(Object obj) {
if (obj == null) {
return false;
}
Class objClass = HibernateProxyHelper.getClassWithoutInitializingProxy(obj);
if (getClass() != objClass) {
return false;
}
final Group other = (Group) obj;
return this.getID().equals(other.getID());
}
@Override
public int hashCode() {
int hash = 7;
hash = 59 * hash + this.getID().hashCode();
hash = 59 * hash + (this.getName() != null ? this.getName().hashCode() : 0);
return hash;
}
@Override
public int getType() {
return Constants.GROUP;
}
@Override
public String getName() {
return name;
}
/**
* Change the name of this Group.
*/
void setName(String name) throws SQLException {
if (!StringUtils.equals(this.name, name) && !isPermanent()) {
this.name = name;
setMetadataModified();
}
}
public boolean isGroupsChanged() {
return groupsChanged;
}
public void clearGroupsChanged() {
this.groupsChanged = false;
}
@Override
public Integer getLegacyId() {
return legacyId;
}
/**
* May this Group be renamed or deleted? (The content of any group may be
* changed.)
*
* @return true if this Group may not be renamed or deleted.
*/
public Boolean isPermanent() {
return permanent;
}
/**
* May this Group be renamed or deleted? (The content of any group may be
* changed.)
*
* @param permanence true if this group may not be renamed or deleted.
*/
void setPermanent(boolean permanence) {
permanent = permanence;
setModified();
}
}