/**
* 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 org.apache.commons.lang.builder.HashCodeBuilder;
import org.apache.log4j.Logger;
import org.dspace.content.factory.ContentServiceFactory;
import org.dspace.content.service.CommunityService;
import org.dspace.core.*;
import org.dspace.eperson.Group;
import org.hibernate.proxy.HibernateProxyHelper;
import javax.persistence.*;
import java.util.*;
/**
* Class representing a community
* <P>
* The community's metadata (name, introductory text etc.) is loaded into'
* memory. Changes to this metadata are only reflected in the database after
* <code>update</code> is called.
*
* @author Robert Tansley
* @version $Revision$
*/
@Entity
@Table(name="community")
public class Community extends DSpaceObject implements DSpaceObjectLegacySupport
{
/** log4j category */
private static final Logger log = Logger.getLogger(Community.class);
@Column(name="community_id", insertable = false, updatable = false)
private Integer legacyId;
@ManyToMany(fetch = FetchType.LAZY)
@JoinTable(
name = "community2community",
joinColumns = {@JoinColumn(name = "parent_comm_id") },
inverseJoinColumns = {@JoinColumn(name = "child_comm_id") }
)
private final List<Community> subCommunities = new ArrayList<>();
@ManyToMany(fetch = FetchType.LAZY, mappedBy = "subCommunities")
private List<Community> parentCommunities = new ArrayList<>();
@ManyToMany(fetch = FetchType.LAZY, mappedBy = "communities", cascade = {CascadeType.PERSIST})
private final List<Collection> collections = new ArrayList<>();
@OneToOne
@JoinColumn(name = "admin")
/** The default group of administrators */
private Group admins;
/** The logo bitstream */
@OneToOne
@JoinColumn(name = "logo_bitstream_id")
private Bitstream logo = null;
// Keys for accessing Community metadata
public static final String COPYRIGHT_TEXT = "copyright_text";
public static final String INTRODUCTORY_TEXT = "introductory_text";
public static final String SHORT_DESCRIPTION = "short_description";
public static final String SIDEBAR_TEXT = "side_bar_text";
@Transient
protected transient CommunityService communityService;
/**
* Protected constructor, create object using:
* {@link org.dspace.content.service.CommunityService#create(Community, Context)}
* or
* {@link org.dspace.content.service.CommunityService#create(Community, Context, String)}
*
*/
protected Community()
{
}
void addSubCommunity(Community subCommunity)
{
getSubcommunities().add(subCommunity);
setModified();
}
void removeSubCommunity(Community subCommunity)
{
getSubcommunities().remove(subCommunity);
setModified();
}
/**
* Get the logo for the community. <code>null</code> is return if the
* community does not have a logo.
*
* @return the logo of the community, or <code>null</code>
*/
public Bitstream getLogo()
{
return logo;
}
void setLogo(Bitstream logo) {
this.logo = logo;
setModified();
}
/**
* Get the default group of administrators, if there is one. Note that the
* authorization system may allow others to be administrators for the
* community.
* <P>
* The default group of administrators for community 100 is the one called
* <code>community_100_admin</code>.
*
* @return group of administrators, or <code>null</code> if there is no
* default group.
*/
public Group getAdministrators()
{
return admins;
}
void setAdmins(Group admins) {
this.admins = admins;
setModified();
}
/**
* Get the collections in this community. Throws an SQLException because
* creating a community object won't load in all collections.
*
* @return array of Collection objects
*/
public List<Collection> getCollections()
{
return collections;
}
void addCollection(Collection collection)
{
getCollections().add(collection);
}
void removeCollection(Collection collection)
{
getCollections().remove(collection);
}
/**
* Get the immediate sub-communities of this community. Throws an
* SQLException because creating a community object won't load in all
* collections.
*
* @return array of Community objects
*/
public List<Community> getSubcommunities()
{
return subCommunities;
}
/**
* Return the parent community of this community, or null if the community
* is top-level
*
* @return the immediate parent community, or null if top-level
*/
public List<Community> getParentCommunities()
{
return parentCommunities;
}
void addParentCommunity(Community parentCommunity) {
getParentCommunities().add(parentCommunity);
}
void clearParentCommunities(){
this.parentCommunities.clear();
this.parentCommunities = null;
}
/**
* Return <code>true</code> if <code>other</code> is the same Community
* as this object, <code>false</code> otherwise
*
* @param other
* object to compare to
*
* @return <code>true</code> if object passed in represents the same
* community 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 Community otherCommunity = (Community) other;
if (!this.getID().equals(otherCommunity.getID() ))
{
return false;
}
return true;
}
@Override
public int hashCode()
{
return new HashCodeBuilder().append(getID()).toHashCode();
}
/**
* return type found in Constants
* @return Community type
*/
@Override
public int getType()
{
return Constants.COMMUNITY;
}
@Override
public String getName() {
String value = getCommunityService().getMetadataFirstValue(this, MetadataSchema.DC_SCHEMA, "title", null, Item.ANY);
return value == null ? "" : value;
}
@Override
public Integer getLegacyId() {
return legacyId;
}
private CommunityService getCommunityService() {
if(communityService == null)
{
communityService = ContentServiceFactory.getInstance().getCommunityService();
}
return communityService;
}
}