org.gbif.api.model.collections

Class Institution

java.lang.Object

org.gbif.api.model.collections.Institution

All Implemented Interfaces:

Serializable, CollectionEntity, Contactable, OccurrenceMappeable, Commentable, Identifiable, LenientEquals<Institution>, MachineTaggable, Taggable

public class Institution
extends Object
implements CollectionEntity, LenientEquals<Institution>

The owner or location of collection. Usually an established organization or foundation, especially one dedicated to education, public service, or culture.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Institution()

Method Summary

Modifier and Type	Method and Description
void	addMachineTag(MachineTag machineTag)
List<String>	getAdditionalNames() Alternative names of institution.
@Valid Address	getAddress() Physical or associated address.
List<AlternativeCode>	getAlternativeCodes() Alternative codes for an institution.
URI	getApiUrl() Machine-consumable endpoint of an institution and probably its collections.
URI	getCatalogUrl() URL to the main catalogue of an institution.
String	getCitesPermitNumber() CITES (see http://ec.europa.eu/environment/cites/info_permits_en.htm) licence given for this collection.
String	getCity()
@NotNull(groups=PrePersist.class) String	getCode() Code used to identify the collection.
List<Comment>	getComments()
@Valid List<Contact>	getContactPersons() List of associated contacts.
UUID	getConvertedToCollection()
String	getCountry()
Date	getCreated() Date when the records as created.
String	getCreatedBy() Creator of the database record.
Date	getDeleted() Date when the records was (logically) deleted.
@Size(min=1) String	getDescription() Textual description of institution.
List<Discipline>	getDisciplines() Activities to which an institution is dedicated.
Boolean	getDisplayOnNHCPortal() Flag to display the entity in the NHC portal.
List<String>	getEmail() Emails of the entity
Integer	getFoundingDate() Date when the institution was founded or established.
String	getGeographicDescription() Geographical coverage of the activities performed by an institution.
URI	getHomepage() URL to the home page of an institution.
List<Identifier>	getIdentifiers()
InstitutionGovernance	getInstitutionalGovernance() Governance nature of an institution.
UUID	getKey() GBIF unique identifier.
BigDecimal	getLatitude() Decimal latitude of where this institution is located.
URI	getLogoUrl() Logo/Image that identifies the institution.
BigDecimal	getLongitude() Decimal longitude of where this institution is located.
@NotNull List<MachineTag>	getMachineTags()
@Valid Address	getMailingAddress() Address used to send and receive mail.
MasterSourceType	getMasterSource() Master source of the entity.
MasterSourceMetadata	getMasterSourceMetadata() Master source metadata
Date	getModified() Date when the records was last modified.
String	getModifiedBy() Person or agent that modified the database record.
@NotNull String	getName() Name or title of an institution.
Integer	getNumberSpecimens() Estimated number of specimens hosted by an institution.
Integer	getOccurrenceCount()
List<OccurrenceMapping>	getOccurrenceMappings()
List<String>	getPhone() Phones of the entity
String	getProvince()
UUID	getReplacedBy() Replacement of the entity (if applies).
List<Tag>	getTags()
String	getTaxonomicDescription() Taxonomic description of the collections maintained by an institution.
InstitutionType	getType() Describes the main activity of an institution.
Integer	getTypeSpecimenCount()
boolean	isActive() Is the institution active/operational?.
boolean	isIndexHerbariorumRecord() Was the institution record imported form Index Herbariorum.
boolean	lenientEquals(Institution other) Leniently tests if the objects are the same.
void	setActive(boolean active)
void	setAdditionalNames(List<String> additionalNames)
void	setAddress(Address address)
void	setAlternativeCodes(List<AlternativeCode> alternativeCodes)
void	setApiUrl(URI apiUrl)
void	setCatalogUrl(URI catalogUrl)
void	setCitesPermitNumber(String citesPermitNumber)
void	setCode(String code)
void	setComments(List<Comment> comments)
void	setContactPersons(List<Contact> contactPersons)
void	setConvertedToCollection(UUID convertedToCollection)
void	setCreated(Date created)
void	setCreatedBy(String createdBy)
void	setDeleted(Date deleted)
void	setDescription(String description)
void	setDisciplines(List<Discipline> disciplines)
void	setDisplayOnNHCPortal(Boolean displayOnNHCPortal)
void	setEmail(List<String> email)
void	setFoundingDate(Integer foundingDate)
void	setGeographicDescription(String geographicDescription)
void	setHomepage(URI homepage)
void	setIdentifiers(List<Identifier> identifiers)
void	setIndexHerbariorumRecord(boolean indexHerbariorumRecord)
void	setInstitutionalGovernance(InstitutionGovernance institutionalGovernance)
void	setKey(UUID key)
void	setLatitude(BigDecimal latitude)
void	setLogoUrl(URI logoUrl)
void	setLongitude(BigDecimal longitude)
void	setMachineTags(List<MachineTag> machineTags)
void	setMailingAddress(Address mailingAddress)
void	setMasterSource(MasterSourceType masterSource)
void	setMasterSourceMetadata(MasterSourceMetadata masterSourceMetadata)
void	setModified(Date modified)
void	setModifiedBy(String modifiedBy)
void	setName(String name)
void	setNumberSpecimens(Integer numberSpecimens)
void	setOccurrenceCount(Integer occurrenceCount)
void	setOccurrenceMappings(List<OccurrenceMapping> occurrenceMappings)
void	setPhone(List<String> phone)
void	setReplacedBy(UUID replacedBy)
void	setTags(List<Tag> tags)
void	setTaxonomicDescription(String taxonomicDescription)
void	setType(InstitutionType type)
void	setTypeSpecimenCount(Integer typeSpecimenCount)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Institution

public Institution()

Method Detail

getKey

public UUID getKey()

GBIF unique identifier.

Specified by:

getKey in interface CollectionEntity

setKey

public void setKey(UUID key)

Specified by:

setKey in interface CollectionEntity

getCode

@NotNull(groups=PrePersist.class)
public @NotNull(groups=PrePersist.class) String getCode()

Code used to identify the collection.

Specified by:

getCode in interface CollectionEntity

setCode

public void setCode(String code)

Specified by:

setCode in interface CollectionEntity

getName

@NotNull
public @NotNull String getName()

Name or title of an institution.

Specified by:

getName in interface CollectionEntity

setName

public void setName(String name)

Specified by:

setName in interface CollectionEntity

getDescription

@Nullable
 @Size(min=1)
public @Size(min=1) String getDescription()

Textual description of institution.

Specified by:

getDescription in interface CollectionEntity

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface CollectionEntity

getType

public InstitutionType getType()

Describes the main activity of an institution.

setType

public void setType(InstitutionType type)

isActive

public boolean isActive()

Is the institution active/operational?.

Specified by:

isActive in interface CollectionEntity

setActive

public void setActive(boolean active)

Specified by:

setActive in interface CollectionEntity

getEmail

public List<String> getEmail()

Description copied from interface: CollectionEntity

Emails of the entity

Specified by:

getEmail in interface CollectionEntity

setEmail

public void setEmail(List<String> email)

Specified by:

setEmail in interface CollectionEntity

getPhone

public List<String> getPhone()

Description copied from interface: CollectionEntity

Phones of the entity

Specified by:

getPhone in interface CollectionEntity

setPhone

public void setPhone(List<String> phone)

Specified by:

setPhone in interface CollectionEntity

getHomepage

@Nullable
public URI getHomepage()

URL to the home page of an institution.

setHomepage

public void setHomepage(URI homepage)

getCatalogUrl

@Nullable
public URI getCatalogUrl()

URL to the main catalogue of an institution.

setCatalogUrl

public void setCatalogUrl(URI catalogUrl)

getApiUrl

@Nullable
public URI getApiUrl()

Machine-consumable endpoint of an institution and probably its collections.

setApiUrl

public void setApiUrl(URI apiUrl)

getInstitutionalGovernance

public InstitutionGovernance getInstitutionalGovernance()

Governance nature of an institution.

setInstitutionalGovernance

public void setInstitutionalGovernance(InstitutionGovernance institutionalGovernance)

getDisciplines

public List<Discipline> getDisciplines()

Activities to which an institution is dedicated.

setDisciplines

public void setDisciplines(List<Discipline> disciplines)

getLatitude

public BigDecimal getLatitude()

Decimal latitude of where this institution is located.

setLatitude

public void setLatitude(BigDecimal latitude)

getLongitude

public BigDecimal getLongitude()

Decimal longitude of where this institution is located.

setLongitude

public void setLongitude(BigDecimal longitude)

getMailingAddress

@Nullable
 @Valid
public @Valid Address getMailingAddress()

Description copied from interface: Contactable

Address used to send and receive mail.

Specified by:

getMailingAddress in interface Contactable

setMailingAddress

public void setMailingAddress(Address mailingAddress)

Specified by:

setMailingAddress in interface Contactable

getAddress

@Nullable
 @Valid
public @Valid Address getAddress()

Description copied from interface: Contactable

Physical or associated address.

Specified by:

getAddress in interface Contactable

setAddress

public void setAddress(Address address)

Specified by:

setAddress in interface Contactable

getAdditionalNames

public List<String> getAdditionalNames()

Alternative names of institution.

setAdditionalNames

public void setAdditionalNames(List<String> additionalNames)

getFoundingDate

public Integer getFoundingDate()

Date when the institution was founded or established.

setFoundingDate

public void setFoundingDate(Integer foundingDate)

getGeographicDescription

public String getGeographicDescription()

Geographical coverage of the activities performed by an institution.

setGeographicDescription

public void setGeographicDescription(String geographicDescription)

getTaxonomicDescription

public String getTaxonomicDescription()

Taxonomic description of the collections maintained by an institution.

setTaxonomicDescription

public void setTaxonomicDescription(String taxonomicDescription)

getNumberSpecimens

public Integer getNumberSpecimens()

Estimated number of specimens hosted by an institution.

setNumberSpecimens

public void setNumberSpecimens(Integer numberSpecimens)

isIndexHerbariorumRecord

public boolean isIndexHerbariorumRecord()

Was the institution record imported form Index Herbariorum.

setIndexHerbariorumRecord

public void setIndexHerbariorumRecord(boolean indexHerbariorumRecord)

getLogoUrl

@Nullable
public URI getLogoUrl()

Logo/Image that identifies the institution.

setLogoUrl

public void setLogoUrl(URI logoUrl)

getCitesPermitNumber

public String getCitesPermitNumber()

CITES (see http://ec.europa.eu/environment/cites/info_permits_en.htm) licence given for this collection.

setCitesPermitNumber

public void setCitesPermitNumber(String citesPermitNumber)

getCreatedBy

public String getCreatedBy()

Description copied from interface: CollectionEntity

Creator of the database record.

Specified by:

getCreatedBy in interface CollectionEntity

setCreatedBy

public void setCreatedBy(String createdBy)

Specified by:

setCreatedBy in interface CollectionEntity

getModifiedBy

public String getModifiedBy()

Description copied from interface: CollectionEntity

Person or agent that modified the database record.

Specified by:

getModifiedBy in interface CollectionEntity

setModifiedBy

public void setModifiedBy(String modifiedBy)

Specified by:

setModifiedBy in interface CollectionEntity

getCreated

public Date getCreated()

Description copied from interface: CollectionEntity

Date when the records as created.

Specified by:

getCreated in interface CollectionEntity

setCreated

public void setCreated(Date created)

Specified by:

setCreated in interface CollectionEntity

getModified

public Date getModified()

Description copied from interface: CollectionEntity

Date when the records was last modified.

Specified by:

getModified in interface CollectionEntity

setModified

public void setModified(Date modified)

Specified by:

setModified in interface CollectionEntity

getDeleted

public Date getDeleted()

Description copied from interface: CollectionEntity

Date when the records was (logically) deleted.

Specified by:

getDeleted in interface CollectionEntity

setDeleted

public void setDeleted(Date deleted)

Specified by:

setDeleted in interface CollectionEntity

getIdentifiers

public List<Identifier> getIdentifiers()

Specified by:

getIdentifiers in interface Identifiable

setIdentifiers

public void setIdentifiers(List<Identifier> identifiers)

Specified by:

setIdentifiers in interface Identifiable

getTags

public List<Tag> getTags()

Specified by:

getTags in interface Taggable

setTags

public void setTags(List<Tag> tags)

Specified by:

setTags in interface Taggable

getContactPersons

@Valid
public @Valid List<Contact> getContactPersons()

Description copied from interface: Contactable

List of associated contacts.

Specified by:

getContactPersons in interface Contactable

setContactPersons

public void setContactPersons(List<Contact> contactPersons)

Specified by:

setContactPersons in interface Contactable

getMachineTags

@NotNull
public @NotNull List<MachineTag> getMachineTags()

Specified by:

getMachineTags in interface MachineTaggable

setMachineTags

public void setMachineTags(List<MachineTag> machineTags)

Specified by:

setMachineTags in interface MachineTaggable

addMachineTag

public void addMachineTag(MachineTag machineTag)

Specified by:

addMachineTag in interface MachineTaggable

getAlternativeCodes

public List<AlternativeCode> getAlternativeCodes()

Alternative codes for an institution.

Specified by:

getAlternativeCodes in interface CollectionEntity

setAlternativeCodes

public void setAlternativeCodes(List<AlternativeCode> alternativeCodes)

Specified by:

setAlternativeCodes in interface CollectionEntity

getComments

public List<Comment> getComments()

Specified by:

getComments in interface Commentable

setComments

public void setComments(List<Comment> comments)

Specified by:

setComments in interface Commentable

getOccurrenceMappings

public List<OccurrenceMapping> getOccurrenceMappings()

Specified by:

getOccurrenceMappings in interface OccurrenceMappeable

setOccurrenceMappings

public void setOccurrenceMappings(List<OccurrenceMapping> occurrenceMappings)

Specified by:

setOccurrenceMappings in interface OccurrenceMappeable

getReplacedBy

public UUID getReplacedBy()

Description copied from interface: CollectionEntity

Replacement of the entity (if applies).

Specified by:

getReplacedBy in interface CollectionEntity

setReplacedBy

public void setReplacedBy(UUID replacedBy)

Specified by:

setReplacedBy in interface CollectionEntity

getConvertedToCollection

public UUID getConvertedToCollection()

setConvertedToCollection

public void setConvertedToCollection(UUID convertedToCollection)

getMasterSource

public MasterSourceType getMasterSource()

Description copied from interface: CollectionEntity

Master source of the entity.

Specified by:

getMasterSource in interface CollectionEntity

setMasterSource

public void setMasterSource(MasterSourceType masterSource)

Specified by:

setMasterSource in interface CollectionEntity

getMasterSourceMetadata

public MasterSourceMetadata getMasterSourceMetadata()

Description copied from interface: CollectionEntity

Master source metadata

Specified by:

getMasterSourceMetadata in interface CollectionEntity

setMasterSourceMetadata

public void setMasterSourceMetadata(MasterSourceMetadata masterSourceMetadata)

Specified by:

setMasterSourceMetadata in interface CollectionEntity

getDisplayOnNHCPortal

public Boolean getDisplayOnNHCPortal()

Description copied from interface: CollectionEntity

Flag to display the entity in the NHC portal.

Specified by:

getDisplayOnNHCPortal in interface CollectionEntity

setDisplayOnNHCPortal

public void setDisplayOnNHCPortal(Boolean displayOnNHCPortal)

Specified by:

setDisplayOnNHCPortal in interface CollectionEntity

getOccurrenceCount

public Integer getOccurrenceCount()

setOccurrenceCount

public void setOccurrenceCount(Integer occurrenceCount)

getTypeSpecimenCount

public Integer getTypeSpecimenCount()

setTypeSpecimenCount

public void setTypeSpecimenCount(Integer typeSpecimenCount)

getCountry

public String getCountry()

getCity

public String getCity()

getProvince

public String getProvince()

lenientEquals

public boolean lenientEquals(Institution other)

Description copied from interface: LenientEquals

Leniently tests if the objects are the same. Implementors should declare what this means in practice.

Specified by:

lenientEquals in interface LenientEquals<Institution>

Parameters:

other - To compare against

Returns:

true if...