eu.etaxonomy.cdm.model.occurrence
Class DerivedUnitBase<S extends IIdentifiableEntityCacheStrategy>

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.occurrence.SpecimenOrObservationBase<S>
                          eu.etaxonomy.cdm.model.occurrence.DerivedUnitBase<S>

All Implemented Interfaces:

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

Direct Known Subclasses:

DerivedUnit, LivingBeing, Observation, Specimen

@Entity
@Indexed(index="eu.etaxonomy.cdm.model.occurrence.SpecimenOrObservationBase")
public abstract class DerivedUnitBase<S extends IIdentifiableEntityCacheStrategy>
extends SpecimenOrObservationBase<S>
implements Cloneable

http://www.bgbm.org/biodivinf/docs/CollectionModel/ReprintTNR.pdf http://www.bgbm.org/biodivinf/docs/CollectionModel/
Type figures are derived units with at least a figure object in media

Author:

markus

See Also:

Serialized Form

Field Summary

Fields inherited from class eu.etaxonomy.cdm.model.occurrence.SpecimenOrObservationBase

definition, derivationEvents

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

protected	DerivedUnitBase() Constructor
protected	DerivedUnitBase(FieldObservation fieldObservation) create new unit derived from an existing field observation
protected	DerivedUnitBase(GatheringEvent gatheringEvent) create new unit derived from an existing gathering event, thereby creating a new empty field observation

Method Summary

void	addSpecimenTypeDesignation(SpecimenTypeDesignation specimenTypeDesignation)
Object	clone() Clones this derivedUnitBase.
String	getAccessionNumber()
String	getBarcode()
String	getCatalogNumber()
Collection	getCollection()
String	getCollectorsNumber() Deprecated.
DerivationEvent	getDerivedFrom()
Set<SpecimenOrObservationBase>	getOriginals()
Set<SpecimenTypeDesignation>	getSpecimenTypeDesignations()
TaxonNameBase	getStoredUnder()
void	removeSpecimenTypeDesignation(SpecimenTypeDesignation specimenTypeDesignation)
void	setAccessionNumber(String accessionNumber)
void	setBarcode(String barcode)
void	setCatalogNumber(String catalogNumber)
void	setCollection(Collection collection)
void	setCollectorsNumber(String collectorsNumber) Deprecated.
void	setDerivedFrom(DerivationEvent derivedFrom)
void	setStoredUnder(TaxonNameBase storedUnder)

Methods inherited from class eu.etaxonomy.cdm.model.occurrence.SpecimenOrObservationBase

addDefinition, addDefinition, addDerivationEvent, addDescription, addDetermination, generateTitle, getDefinition, getDerivationEvents, getDescriptions, getDeterminations, getIndividualCount, getLifeStage, getOriginalUnit, getSex, getSpecimenDescriptionImageGallery, getSpecimenDescriptions, getSpecimenDescriptions, putDefinition, putDefinition, removeDefinition, removeDerivationEvent, removeDescription, removeDetermination, setIndividualCount, setLifeStage, setSex

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, 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.IAnnotatableEntity

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

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

getUpdated, getUpdatedBy, setUpdated, setUpdatedBy

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

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

Constructor Detail

DerivedUnitBase

protected DerivedUnitBase()

Constructor

DerivedUnitBase

protected DerivedUnitBase(FieldObservation fieldObservation)

create new unit derived from an existing field observation

Parameters:

fieldObservation - existing field observation from where this unit is derived

DerivedUnitBase

protected DerivedUnitBase(GatheringEvent gatheringEvent)

create new unit derived from an existing gathering event, thereby creating a new empty field observation

Parameters:

gatheringEvent - the gathering event this unit was collected at

Method Detail

getDerivedFrom

public DerivationEvent getDerivedFrom()

setDerivedFrom

public void setDerivedFrom(DerivationEvent derivedFrom)

getOriginals

public Set<SpecimenOrObservationBase> getOriginals()

getCollection

public Collection getCollection()

setCollection

public void setCollection(Collection collection)

getCatalogNumber

public String getCatalogNumber()

setCatalogNumber

public void setCatalogNumber(String catalogNumber)

setBarcode

public void setBarcode(String barcode)

getBarcode

public String getBarcode()

setStoredUnder

public void setStoredUnder(TaxonNameBase storedUnder)

getAccessionNumber

public String getAccessionNumber()

setAccessionNumber

public void setAccessionNumber(String accessionNumber)

getCollectorsNumber

@Deprecated
public String getCollectorsNumber()

Deprecated.

Will be removed in future versions as semantics is not clear. For accessing the collecting number use FieldObservation.getFieldNumber() instead.

Returns:

setCollectorsNumber

@Deprecated
public void setCollectorsNumber(String collectorsNumber)

Deprecated.

Will be removed in future versions as semantics is not clear. For editing the collecting number use FieldObservation.getFieldNumber() instead.

getStoredUnder

public TaxonNameBase getStoredUnder()

addSpecimenTypeDesignation

public void addSpecimenTypeDesignation(SpecimenTypeDesignation specimenTypeDesignation)

removeSpecimenTypeDesignation

public void removeSpecimenTypeDesignation(SpecimenTypeDesignation specimenTypeDesignation)

getSpecimenTypeDesignations

public Set<SpecimenTypeDesignation> getSpecimenTypeDesignations()

clone

public Object clone()
             throws CloneNotSupportedException

Clones this derivedUnitBase. This is a shortcut that enables to create a new instance that differs only slightly from this specimen by modifying only some of the attributes.
This method overrides the clone method from SpecimenOrObservationBase.

Overrides:

clone in class SpecimenOrObservationBase<S extends IIdentifiableEntityCacheStrategy>

Throws:

CloneNotSupportedException

See Also:

SpecimenOrObservationBase.clone(), IdentifiableMediaEntity.clone(), Object.clone()