org.gbif.api.model.collections

Class Collection

java.lang.Object

org.gbif.api.model.collections.Collection

All Implemented Interfaces:

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

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

A group of specimens or other natural history objects. Types of collections can be: specimens, original artwork, archives, observations, library materials, datasets, photographs or mixed collections such as those that result from expeditions and voyages of discovery.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Collection()

Method Summary

Modifier and Type	Method and Description
void	addMachineTag(MachineTag machineTag)
AccessionStatus	getAccessionStatus() Defines how a collection as been added or joined.
@Valid Address	getAddress() Address where this collection is situated.
List<AlternativeCode>	getAlternativeCodes() Alternative codes for a collection.
URI	getApiUrl() Machine consumable endpoint of information about a collection.
URI	getCatalogUrl() URI that exposes data about the catalog associated to a collection.
String	getCity()
@NotNull(groups=PrePersist.class) String	getCode() Collection code: identifies a collection at the owner's location.
Map<String,Integer>	getCollectionSummary()
@NotNull List<Comment>	getComments()
@Valid List<Contact>	getContactPersons() List of associated contacts.
List<CollectionContentType>	getContentTypes() Content type of the elements found in a collection.
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.
String	getDepartment()
@Size(min=1) String	getDescription() Textual description/summary of the contents of a collection.
Boolean	getDisplayOnNHCPortal() Flag to display the entity in the NHC portal.
String	getDivision()
DOI	getDoi() Digital Object Identifier assigned to this collection.
List<String>	getEmail() Emails of the entity
String	getGeography()
URI	getHomepage() URL containing information about a collection.
List<Identifier>	getIdentifiers() List of alternative identifiers: UUIDs, external system identifiers, LSIDs, etc..
List<String>	getImportantCollectors()
List<String>	getIncorporatedCollections()
UUID	getInstitutionKey() Institution that owns or hosts this collection.
UUID	getKey() GBIF Unique identifier of this collection.
@Valid @NotNull List<MachineTag>	getMachineTags()
@Valid Address	getMailingAddress() Address used to send/receive physical 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() Descriptive name of a collection.
String	getNotes()
Integer	getNumberSpecimens()
Integer	getOccurrenceCount()
@NotNull List<OccurrenceMapping>	getOccurrenceMappings()
List<String>	getPhone() Phones of the entity
List<PreservationType>	getPreservationTypes() Types of preservation mechanisms used for this collections.
String	getProvince()
UUID	getReplacedBy() Replacement of the entity (if applies).
@Valid List<Tag>	getTags() (Meta)Tags or labels.
String	getTaxonomicCoverage()
Integer	getTypeSpecimenCount()
boolean	isActive() Is this collection currently active/maintained.
boolean	isIndexHerbariorumRecord()
boolean	isPersonalCollection() Does this collections belong to an individual?.
boolean	lenientEquals(Collection other) Leniently tests if the objects are the same.
void	setAccessionStatus(AccessionStatus accessionStatus)
void	setActive(boolean active)
void	setAddress(Address address)
void	setAlternativeCodes(List<AlternativeCode> alternativeCodes)
void	setApiUrl(URI apiUrl)
void	setCatalogUrl(URI catalogUrl)
void	setCode(String code)
void	setCollectionSummary(Map<String,Integer> collectionSummary)
void	setComments(List<Comment> comments)
void	setContactPersons(List<Contact> contactPersons)
void	setContentTypes(List<CollectionContentType> contentTypes)
void	setCreated(Date created)
void	setCreatedBy(String createdBy)
void	setDeleted(Date deleted)
void	setDepartment(String department)
void	setDescription(String description)
void	setDisplayOnNHCPortal(Boolean displayOnNHCPortal)
void	setDivision(String division)
void	setDoi(DOI doi)
void	setEmail(List<String> email)
void	setGeography(String geography)
void	setHomepage(URI homepage)
void	setIdentifiers(List<Identifier> identifiers)
void	setImportantCollectors(List<String> importantCollectors)
void	setIncorporatedCollections(List<String> incorporatedCollections)
void	setIndexHerbariorumRecord(boolean indexHerbariorumRecord)
void	setInstitutionKey(UUID institutionKey)
void	setKey(UUID key)
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	setNotes(String notes)
void	setNumberSpecimens(Integer numberSpecimens)
void	setOccurrenceCount(Integer occurrenceCount)
void	setOccurrenceMappings(List<OccurrenceMapping> occurrenceMappings)
void	setPersonalCollection(boolean personalCollection)
void	setPhone(List<String> phone)
void	setPreservationTypes(List<PreservationType> preservationTypes)
void	setReplacedBy(UUID replacedBy)
void	setTags(List<Tag> tags)
void	setTaxonomicCoverage(String taxonomicCoverage)
void	setTypeSpecimenCount(Integer typeSpecimenCount)

Methods inherited from class java.lang.Object

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

Constructor Detail

Collection

public Collection()

Method Detail

getIdentifiers

public List<Identifier> getIdentifiers()

List of alternative identifiers: UUIDs, external system identifiers, LSIDs, etc..

Specified by:

getIdentifiers in interface Identifiable

setIdentifiers

public void setIdentifiers(List<Identifier> identifiers)

Specified by:

setIdentifiers in interface Identifiable

getTags

@Valid
public @Valid List<Tag> getTags()

(Meta)Tags or labels.

Specified by:

getTags in interface Taggable

setTags

public void setTags(List<Tag> tags)

Specified by:

setTags in interface Taggable

getKey

public UUID getKey()

GBIF Unique identifier of this collection.

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()

Collection code: identifies a collection at the owner's location.

Specified by:

getCode in interface CollectionEntity

setCode

public void setCode(String code)

Specified by:

setCode in interface CollectionEntity

getName

@NotNull
public @NotNull String getName()

Descriptive name of a collection.

Specified by:

getName in interface CollectionEntity

setName

public void setName(String name)

Specified by:

setName in interface CollectionEntity

getDescription

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

Textual description/summary of the contents of a collection.

Specified by:

getDescription in interface CollectionEntity

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface CollectionEntity

getContentTypes

public List<CollectionContentType> getContentTypes()

Content type of the elements found in a collection.

setContentTypes

public void setContentTypes(List<CollectionContentType> contentTypes)

isActive

public boolean isActive()

Is this collection currently active/maintained.

Specified by:

isActive in interface CollectionEntity

setActive

public void setActive(boolean active)

Specified by:

setActive in interface CollectionEntity

isPersonalCollection

public boolean isPersonalCollection()

Does this collections belong to an individual?.

setPersonalCollection

public void setPersonalCollection(boolean personalCollection)

getDoi

public DOI getDoi()

Digital Object Identifier assigned to this collection.

setDoi

public void setDoi(DOI doi)

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 containing information about a collection.

setHomepage

public void setHomepage(URI homepage)

getCatalogUrl

@Nullable
public URI getCatalogUrl()

URI that exposes data about the catalog associated to a collection.

setCatalogUrl

public void setCatalogUrl(URI catalogUrl)

getApiUrl

@Nullable
public URI getApiUrl()

Machine consumable endpoint of information about a collection.

setApiUrl

public void setApiUrl(URI apiUrl)

getPreservationTypes

public List<PreservationType> getPreservationTypes()

Types of preservation mechanisms used for this collections.

setPreservationTypes

public void setPreservationTypes(List<PreservationType> preservationTypes)

getAccessionStatus

public AccessionStatus getAccessionStatus()

Defines how a collection as been added or joined.

setAccessionStatus

public void setAccessionStatus(AccessionStatus accessionStatus)

getInstitutionKey

public UUID getInstitutionKey()

Institution that owns or hosts this collection.

setInstitutionKey

public void setInstitutionKey(UUID institutionKey)

getMailingAddress

@Nullable
 @Valid
public @Valid Address getMailingAddress()

Address used to send/receive physical 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()

Address where this collection is situated.

Specified by:

getAddress in interface Contactable

setAddress

public void setAddress(Address address)

Specified by:

setAddress in interface Contactable

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

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

isIndexHerbariorumRecord

public boolean isIndexHerbariorumRecord()

setIndexHerbariorumRecord

public void setIndexHerbariorumRecord(boolean indexHerbariorumRecord)

getNumberSpecimens

public Integer getNumberSpecimens()

setNumberSpecimens

public void setNumberSpecimens(Integer numberSpecimens)

getMachineTags

@Valid
 @NotNull
public @Valid @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

getTaxonomicCoverage

public String getTaxonomicCoverage()

setTaxonomicCoverage

public void setTaxonomicCoverage(String taxonomicCoverage)

getGeography

public String getGeography()

setGeography

public void setGeography(String geography)

getNotes

public String getNotes()

setNotes

public void setNotes(String notes)

getIncorporatedCollections

public List<String> getIncorporatedCollections()

setIncorporatedCollections

public void setIncorporatedCollections(List<String> incorporatedCollections)

getImportantCollectors

public List<String> getImportantCollectors()

setImportantCollectors

public void setImportantCollectors(List<String> importantCollectors)

getCollectionSummary

public Map<String,Integer> getCollectionSummary()

setCollectionSummary

public void setCollectionSummary(Map<String,Integer> collectionSummary)

getAlternativeCodes

public List<AlternativeCode> getAlternativeCodes()

Alternative codes for a collection.

Specified by:

getAlternativeCodes in interface CollectionEntity

setAlternativeCodes

public void setAlternativeCodes(List<AlternativeCode> alternativeCodes)

Specified by:

setAlternativeCodes in interface CollectionEntity

getComments

@NotNull
public @NotNull List<Comment> getComments()

Specified by:

getComments in interface Commentable

setComments

public void setComments(List<Comment> comments)

Specified by:

setComments in interface Commentable

getOccurrenceMappings

@NotNull
public @NotNull 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

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

getDepartment

public String getDepartment()

setDepartment

public void setDepartment(String department)

getDivision

public String getDivision()

setDivision

public void setDivision(String division)

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

getCountry

public String getCountry()

getCity

public String getCity()

getProvince

public String getProvince()

getOccurrenceCount

public Integer getOccurrenceCount()

setOccurrenceCount

public void setOccurrenceCount(Integer occurrenceCount)

getTypeSpecimenCount

public Integer getTypeSpecimenCount()

setTypeSpecimenCount

public void setTypeSpecimenCount(Integer typeSpecimenCount)

lenientEquals

public boolean lenientEquals(Collection 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<Collection>

Parameters:

other - To compare against

Returns:

true if...