eu.etaxonomy.cdm.model.agent
Class Institution

java.lang.Object
  eu.etaxonomy.cdm.model.common.CdmBase
      eu.etaxonomy.cdm.model.common.VersionableEntity
          eu.etaxonomy.cdm.model.common.AnnotatableEntity
              eu.etaxonomy.cdm.model.common.IdentifiableEntity<S>
                  eu.etaxonomy.cdm.model.media.IdentifiableMediaEntity<S>
                      eu.etaxonomy.cdm.model.agent.AgentBase<IIdentifiableEntityCacheStrategy<Institution>>
                          eu.etaxonomy.cdm.model.agent.Institution

All Implemented Interfaces:

IAnnotatableEntity, ICdmBase, IIdentifiableEntity, ISourceable<IdentifiableSource>, IVersionableEntity, IMediaDocumented, IMediaEntity, IMatchable, IMergable, Serializable, Cloneable

@Entity
@Indexed(index="eu.etaxonomy.cdm.model.agent.AgentBase")
@Configurable
public class Institution
extends AgentBase<IIdentifiableEntityCacheStrategy<Institution>>

This class represents public or private institutions. It includes name, contact details and institution type.

This class corresponds to:

• Institution according to the TDWG ontology
• Institution according to the TCS
• Organisation (Institution) according to the ABCD schema

Version:

1.0

Author:

m.doering

See Also:

Serialized Form

Field Summary

static Logger

logger

Fields inherited from class eu.etaxonomy.cdm.model.common.IdentifiableEntity

cacheStrategy, NOT_PROTECTED, PROTECTED, protectedTitleCache, titleCache

Fields inherited from class eu.etaxonomy.cdm.model.common.AnnotatableEntity

annotations, markers

Fields inherited from class eu.etaxonomy.cdm.model.common.CdmBase

uuid

Constructor Summary

Institution()
Class constructor.

Method Summary

void	addType(InstitutionType t) Adds a new institutional type (from the corresponding vocabulary) to the set of institution types of this institution.
Object	clone() Clones this Institution.
String	getCode() Returns the string representing the code (can also be an acronym or initials) by which this institution is known among experts.
Institution	getIsPartOf() Returns the parent institution of this institution.
String	getName() Returns the full name, as distinct from a code, an acronym or initials, by which this institution is generally known.
Set<InstitutionType>	getTypes() Returns the set of institution types (categories) used to describe or circumscribe this institution's activities.
static Institution	NewInstance() Creates a new empty institution instance.
void	removeType(InstitutionType t) Removes one element from the set of institution types for this institution.
void	setCode(String code)
void	setIsPartOf(Institution parentInstitution) Assigns a parent institution to which this institution belongs.
void	setName(String name)

Methods inherited from class eu.etaxonomy.cdm.model.agent.AgentBase

addAddress, addAddress, addEmailAddress, addFaxNumber, addPhoneNumber, addUrl, getAddresses, getContact, getEmailAddresses, getFaxNumbers, getPhoneNumbers, getUrls, removeAddress, removeEmailAddress, removeFaxNumber, removePhoneNumber, removeUrl, setContact

Methods inherited from class eu.etaxonomy.cdm.model.media.IdentifiableMediaEntity

addMedia, getMedia, removeMedia

Methods inherited from class eu.etaxonomy.cdm.model.common.IdentifiableEntity

addCredit, addCredit, addExtension, addExtension, addRights, addSource, addSource, compareTo, generateTitle, getCacheStrategy, getCredits, getCredits, getData, getExtensions, getExtensions, getExtensions, getLsid, getRights, getSources, getTitleCache, getTruncatedCache, initListener, isProtectedTitleCache, regenerateTitleCache, removeCredit, removeCredit, removeExtension, removeRights, removeSource, setCacheStrategy, setLsid, setProtectedTitleCache, setTitleCache, setTitleCache, toString

Methods inherited from class eu.etaxonomy.cdm.model.common.AnnotatableEntity

addAnnotation, addMarker, getAnnotations, getMarkers, hasMarker, hasMarker, removeAnnotation, removeMarker

Methods inherited from class eu.etaxonomy.cdm.model.common.VersionableEntity

equals, getUpdated, getUpdatedBy, setUpdated, setUpdatedBy

Methods inherited from class eu.etaxonomy.cdm.model.common.CdmBase

addPropertyChangeListener, addPropertyChangeListener, clone, deproxy, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getCreated, getCreatedBy, getId, getUuid, hashCode, hasListeners, instanceToString, invokeSetMethod, invokeSetMethodWithNull, isInstanceOf, removePropertyChangeListener, removePropertyChangeListener, setCreated, setCreatedBy, setId, setUuid

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface eu.etaxonomy.cdm.model.common.ICdmBase

getCreated, getCreatedBy, getId, getUuid, setCreated, setCreatedBy, setId, setUuid

Methods inherited from interface eu.etaxonomy.cdm.model.common.IAnnotatableEntity

addAnnotation, addMarker, getAnnotations, getMarkers, hasMarker, hasMarker, removeAnnotation, removeMarker

Methods inherited from interface eu.etaxonomy.cdm.model.common.IVersionableEntity

getUpdated, getUpdatedBy, setUpdated, setUpdatedBy

Field Detail

logger

public static final Logger logger

Constructor Detail

Institution

public Institution()

Class constructor.

Method Detail

NewInstance

public static Institution NewInstance()

Creates a new empty institution instance.

getTypes

public Set<InstitutionType> getTypes()

Returns the set of institution types (categories) used to describe or circumscribe this institution's activities. Institution types are items of a controlled vocabulary.

Returns:

the set of institution types

See Also:

InstitutionType

addType

public void addType(InstitutionType t)

Adds a new institutional type (from the corresponding vocabulary) to the set of institution types of this institution.

Parameters:

t - any type of institution

See Also:

getTypes(), InstitutionType

removeType

public void removeType(InstitutionType t)

Removes one element from the set of institution types for this institution.

Parameters:

t - the institution type which should be deleted

See Also:

getTypes()

getIsPartOf

public Institution getIsPartOf()

Returns the parent institution of this institution. This is for instance the case when this institution is a herbarium belonging to a parent institution such as a museum.

setIsPartOf

public void setIsPartOf(Institution parentInstitution)

Assigns a parent institution to which this institution belongs.

Parameters:

isPartOf - the parent institution

See Also:

getIsPartOf()

getCode

public String getCode()

Returns the string representing the code (can also be an acronym or initials) by which this institution is known among experts.

setCode

public void setCode(String code)

See Also:

getCode()

getName

public String getName()

Returns the full name, as distinct from a code, an acronym or initials, by which this institution is generally known.

setName

public void setName(String name)

See Also:

getName()

clone

public Object clone()

Clones this Institution. This is a shortcut that enables to create a new instance that differs only slightly from this Institution.

Overrides:

clone in class IdentifiableMediaEntity<IIdentifiableEntityCacheStrategy<Institution>>

See Also:

IdentifiableMediaEntity, Object.clone()