org.dspace.content.Collection 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.content;
import static org.dspace.content.service.DSpaceObjectService.MD_LICENSE;
import java.sql.SQLException;
import java.util.Arrays;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.UUID;
import javax.annotation.Nonnull;
import javax.persistence.Cacheable;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.JoinColumn;
import javax.persistence.JoinTable;
import javax.persistence.ManyToMany;
import javax.persistence.OneToOne;
import javax.persistence.Table;
import javax.persistence.Transient;
import org.dspace.authorize.AuthorizeException;
import org.dspace.content.comparator.NameAscendingComparator;
import org.dspace.content.factory.ContentServiceFactory;
import org.dspace.content.service.CollectionService;
import org.dspace.core.Constants;
import org.dspace.core.Context;
import org.dspace.eperson.Group;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.proxy.HibernateProxyHelper;
/**
* Class representing a collection.
*
* The collection's metadata (name, introductory text etc), workflow groups, and
* default group of submitters are loaded into memory. Changes to metadata are
* not written to the database until update is called. If you
* create or remove a workflow group, the change is only reflected in the
* database after calling update. The default group of
* submitters is slightly different - creating or removing this has instant
* effect.
*
* @author Robert Tansley
*/
@Entity
@Table(name = "collection")
@Cacheable
@org.hibernate.annotations.Cache(usage = CacheConcurrencyStrategy.NONSTRICT_READ_WRITE, include = "non-lazy")
public class Collection extends DSpaceObject implements DSpaceObjectLegacySupport {
@Column(name = "collection_id", insertable = false, updatable = false)
private Integer legacyId;
/**
* The logo bitstream
*/
@OneToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "logo_bitstream_id")
private Bitstream logo;
/**
* The item template
*/
@OneToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "template_item_id")
private Item template;
@OneToOne
@JoinColumn(name = "submitter")
/** The default group of administrators */
private Group submitters;
@OneToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "admin")
/** The default group of administrators */
private Group admins;
@ManyToMany(fetch = FetchType.LAZY, cascade = {CascadeType.PERSIST})
@JoinTable(
name = "community2collection",
joinColumns = {@JoinColumn(name = "collection_id")},
inverseJoinColumns = {@JoinColumn(name = "community_id")}
)
private final Set communities = new HashSet<>();
@Transient
private transient CollectionService collectionService;
/**
* Protected constructor, create object using:
* {@link org.dspace.content.service.CollectionService#create(Context, Community)}
* or
* {@link org.dspace.content.service.CollectionService#create(Context, Community, String)}
*/
protected Collection() {
}
/**
* Takes a pre-determined UUID to be passed to the object to allow for the
* restoration of previously defined UUID's.
*
* @param uuid Takes a uuid to be passed to the Pre-Defined UUID Generator
*/
protected Collection(UUID uuid) {
this.predefinedUUID = uuid;
}
@Override
public String getName() {
String value = getCollectionService()
.getMetadataFirstValue(this, MetadataSchemaEnum.DC.getName(), "title", null, Item.ANY);
return value == null ? "" : value;
}
/**
* Get the logo for the collection. null is returned if the
* collection does not have a logo.
*
* @return the logo of the collection, or null
*/
public Bitstream getLogo() {
return logo;
}
protected void setLogo(Bitstream logo) {
this.logo = logo;
setModified();
}
/**
* Get the default group of submitters, if there is one. Note that the
* authorization system may allow others to submit to the collection, so
* this is not necessarily a definitive list of potential submitters.
*
* The default group of submitters for collection 100 is the one called
* collection_100_submit.
*
* @return the default group of submitters, or null if there
* is no default group.
*/
public Group getSubmitters() {
return submitters;
}
/**
* Set the default group of submitters
*
* Package protected in order to preven unauthorized calls to this method
*
* @param submitters the group of submitters
*/
void setSubmitters(Group submitters) {
this.submitters = submitters;
setModified();
}
/**
* Get the default group of administrators, if there is one. Note that the
* authorization system may allow others to be administrators for the
* collection.
*
* The default group of administrators for collection 100 is the one called
* collection_100_admin.
*
* @return group of administrators, or null if there is no
* default group.
*/
public Group getAdministrators() {
return admins;
}
void setAdmins(Group admins) {
this.admins = admins;
setModified();
}
// FIXME this should be moved to the collectionService or completely removed, see also
// https://jira.duraspace.org/browse/DS-3041
public Group getWorkflowStep1(Context context) {
return getCollectionService().getWorkflowGroup(context, this, 1);
}
// FIXME this should be moved to the collectionService or completely removed, see also
// https://jira.duraspace.org/browse/DS-3041
public Group getWorkflowStep2(Context context) {
return getCollectionService().getWorkflowGroup(context, this, 2);
}
// FIXME this should be moved to the collectionService or completely removed, see also
// https://jira.duraspace.org/browse/DS-3041
public Group getWorkflowStep3(Context context) {
return getCollectionService().getWorkflowGroup(context, this, 3);
}
/**
* Get the license that users must grant before submitting to this
* collection.
*
* @return the license for this collection. Never null.
*/
@Nonnull
public String getLicenseCollection() {
String license = getCollectionService()
.getMetadataFirstValue(this, CollectionService.MD_LICENSE, Item.ANY);
if (null == license) {
return "";
} else {
return license;
}
}
/**
* Set the license for this collection. Passing in null means
* that the site-wide default will be used.
*
* @param context context
* @param license the license, or null
* @throws SQLException if database error
*/
public void setLicense(Context context, String license) throws SQLException {
getCollectionService().setMetadataSingleValue(context, this, MD_LICENSE, Item.ANY, license);
}
/**
* Get the template item for this collection. null is
* returned if the collection does not have a template. Submission
* mechanisms may copy this template to provide a convenient starting point
* for a submission.
*
* @return the item template, or null
* @throws SQLException if database error
*/
public Item getTemplateItem() throws SQLException {
return template;
}
void setTemplateItem(Item template) {
this.template = template;
setModified();
}
/**
* Get the communities this collection appears in
*
* @return array of Community objects
* @throws SQLException if database error
*/
public List getCommunities() throws SQLException {
// We return a copy because we do not want people to add elements to this collection directly.
// We return a list to maintain backwards compatibility
Community[] output = communities.toArray(new Community[] {});
Arrays.sort(output, new NameAscendingComparator());
return Arrays.asList(output);
}
void addCommunity(Community community) {
this.communities.add(community);
setModified();
}
void removeCommunity(Community community) {
this.communities.remove(community);
setModified();
}
/**
* Return true if other is the same Collection
* as this object, false otherwise
*
* @param other object to compare to
* @return true if object passed in represents the same
* collection as this object
*/
@Override
public boolean equals(Object other) {
if (other == null) {
return false;
}
Class objClass = HibernateProxyHelper.getClassWithoutInitializingProxy(other);
if (this.getClass() != objClass) {
return false;
}
final Collection otherCollection = (Collection) other;
if (!this.getID().equals(otherCollection.getID())) {
return false;
}
return true;
}
@Override
public int hashCode() {
int hash = 5;
hash += 71 * hash + getType();
hash += 71 * hash + getID().hashCode();
return hash;
}
/**
* return type found in Constants
*
* @return int Constants.COLLECTION
*/
@Override
public int getType() {
return Constants.COLLECTION;
}
public void setWorkflowGroup(Context context, int step, Group g)
throws SQLException, AuthorizeException {
getCollectionService().setWorkflowGroup(context, this, step, g);
}
@Override
public Integer getLegacyId() {
return legacyId;
}
private CollectionService getCollectionService() {
if (collectionService == null) {
collectionService = ContentServiceFactory.getInstance().getCollectionService();
}
return collectionService;
}
}