@Entity @ClassBridge(impl=DescriptionBaseClassBridge.class) @ClassBridge(impl=GroupByTaxonClassBridge.class) public abstract class DescriptionBase<S extends IIdentifiableEntityCacheStrategy> extends IdentifiableEntity<S> implements ICdmTarget
elementary information data
)
for a specimen
, a taxon
or even a taxon name
.
This class corresponds to:
cacheStrategy, NOT_PROTECTED, PROTECTED, protectedTitleCache, titleCache
annotations, markers
CLOB_LENGTH, uuid
Constructor and Description |
---|
DescriptionBase() |
Modifier and Type | Method and Description |
---|---|
void |
addDescriptionSource(Reference descriptionSource)
Deprecated.
|
boolean |
addDescriptiveDataSet(DescriptiveDataSet descriptiveDataSet) |
void |
addElement(DescriptionElementBase element)
Adds an existing
elementary description to the set of
elementary description data which constitute this
description as a whole. |
void |
addElements(DescriptionElementBase... elements)
Convenience method to add multiple elements.
|
void |
addType(DescriptionType type) |
void |
addTypes(java.util.Set<DescriptionType> types) |
java.lang.Object |
clone()
Clones this description.
|
SpecimenOrObservationBase |
getDescribedSpecimenOrObservation()
Returns a
specimen or observation involved in
this description as a whole. |
java.util.Set<Reference> |
getDescriptionSources()
Deprecated.
|
java.util.Set<DescriptiveDataSet> |
getDescriptiveDataSets() |
java.util.Set<DescriptionElementBase> |
getElements()
Returns the set of
elementary description data which constitute
this description as a whole. |
java.util.EnumSet<DescriptionType> |
getTypes() |
boolean |
hasStructuredData() |
boolean |
isAggregated() |
boolean |
isAggregatedDistribution() |
boolean |
isAggregatedStructuredDescription() |
boolean |
isCloneForSource() |
boolean |
isComputed()
|
boolean |
isDefault() |
static boolean |
isDefaultForAggregation(java.util.EnumSet<DescriptionType> set) |
boolean |
isImageGallery() |
static boolean |
isSecondaryData(java.util.EnumSet<DescriptionType> set) |
void |
removeDescriptionSource(Reference descriptionSource)
Deprecated.
|
boolean |
removeDescriptiveDataSet(DescriptiveDataSet descriptiveDataSet) |
void |
removeElement(DescriptionElementBase element)
Removes one element from the set of
elementary description data which
constitute this description as a whole. |
void |
setDefault(boolean isDefault) |
void |
setDescribedSpecimenOrObservation(SpecimenOrObservationBase describedSpecimenOrObservation) |
protected void |
setDescriptiveDataSet(java.util.Set<DescriptiveDataSet> descriptiveDataSets) |
void |
setImageGallery(boolean imageGallery) |
void |
setTypes(java.util.EnumSet<DescriptionType> types) |
int |
size()
Returns the number of
elementary description data which constitute
this description as a whole. |
addCredit, addCredit, addExtension, addExtension, addIdentifier, addIdentifier, addIdentifier, addRights, addSource, addSources, createNewSource, generateTitle, getCacheStrategy, getCredits, getCredits, getData, getExtensions, getExtensions, getExtensions, getExtensionsConcat, getExtensionsConcat, getFilteredExtensions, getIdentifiers, getIdentifiers, getIdentifiers, getLsid, getRights, getTitleCache, getTruncatedCache, hasEmptyTitleCache, hasExtension, hasExtension, initListener, isProtectedTitleCache, removeCredit, removeCredit, removeExtension, removeIdentifier, removeIdentifier, removeRights, replaceCredit, replaceIdentifier, resetTitleCache, setCacheStrategy, setLsid, setProtectedTitleCache, setTitleCache, setTitleCache, toString, updateCaches, updateCaches
addAggregationSource, addImportSource, addPrimaryTaxonomicSource, addPrimaryTaxonomicSource, addSource, addSource, getSources, removeSource, removeSources
addAnnotation, addMarker, addMarker, getAnnotations, getAnnotations, getMarkers, getMarkers, hasMarker, hasMarker, markerValue, removeAnnotation, removeMarker, removeMarker, setAnnotations
cloneLanguageString, equals, getUpdated, getUpdatedBy, setUpdated, setUpdatedBy
addPropertyChangeListener, addPropertyChangeListener, addToSetWithChangeEvent, deproxy, deproxy, fireOnCreateEvent, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getCreated, getCreatedBy, getId, getUserFriendlyDescription, getUserFriendlyFieldName, getUserFriendlyTypeName, getUuid, hashCode, hasListeners, instanceToString, invokeSetMethod, invokeSetMethodWithNull, isBlank, isInstanceOf, isNotBlank, isPersited, removeFromSetWithChangeEvent, removePropertyChangeListener, removePropertyChangeListener, replaceInList, setCreated, setCreatedBy, setId, setNewEntityListener, setUuid
finalize, getClass, notify, notifyAll, wait, wait, wait
removeSources
addAggregationSource, addImportSource, addPrimaryTaxonomicSource, addPrimaryTaxonomicSource, addSource, addSource, getSources, removeSource
addAnnotation, addMarker, getAnnotations, getMarkers, getMarkers, hasMarker, hasMarker, markerValue, removeAnnotation, removeMarker, removeMarker
getUpdated, getUpdatedBy, setUpdated, setUpdatedBy
getCreated, getCreatedBy, getId, getUuid, isInstanceOf, isPersited, setCreated, setCreatedBy, setId, setUuid
public SpecimenOrObservationBase getDescribedSpecimenOrObservation()
specimen or observation
involved in
this description as a whole. Taxon descriptions
are also often based
on concrete specimens or observations. For taxon name descriptions
this attribute should be empty.
To handle sets of specimen or observations one may first group them by a derivation event of type
"Grouping" and then use the grouped unit here.public void setDescribedSpecimenOrObservation(SpecimenOrObservationBase describedSpecimenOrObservation)
describedSpecimenOrObservation
- getDescribedSpecimenOrObservation()
public java.util.Set<DescriptionElementBase> getElements()
elementary description data
which constitute
this description as a whole.public void addElement(DescriptionElementBase element)
elementary description
to the set of
elementary description data
which constitute this
description as a whole.
If the elementary descriptions already belongs to a description it is first removed from
the old description.element
- the elementary description to be added to this descriptiongetDescriptionSources()
public void addElements(DescriptionElementBase... elements)
elements
- public void removeElement(DescriptionElementBase element)
elementary description data
which
constitute this description as a whole.element
- the reference source which should be deletedgetElements()
,
addElement(DescriptionElementBase)
public int size()
elementary description data
which constitute
this description as a whole. This is the cardinality of the set of
elementary description data.getElements()
public boolean isImageGallery()
public void setImageGallery(boolean imageGallery)
public boolean isDefault()
public void setDefault(boolean isDefault)
public java.util.EnumSet<DescriptionType> getTypes()
public void setTypes(java.util.EnumSet<DescriptionType> types)
public void addType(DescriptionType type)
public void addTypes(java.util.Set<DescriptionType> types)
public java.util.Set<DescriptiveDataSet> getDescriptiveDataSets()
public boolean addDescriptiveDataSet(DescriptiveDataSet descriptiveDataSet)
public boolean removeDescriptiveDataSet(DescriptiveDataSet descriptiveDataSet)
protected void setDescriptiveDataSet(java.util.Set<DescriptiveDataSet> descriptiveDataSets)
@Deprecated public java.util.Set<Reference> getDescriptionSources()
references
used as sources for this description as a
whole. More than one source can be used for a general description without
assigning for each data element of the description one of those sources.@Deprecated public void addDescriptionSource(Reference descriptionSource)
reference
to the set of
references
used as sources for this
description.descriptionSource
- the reference source to be added to this descriptiongetDescriptionSources()
@Deprecated public void removeDescriptionSource(Reference descriptionSource)
references
used as
sources for this description.descriptionSource
- the reference source which should be deletedgetDescriptionSources()
,
addDescriptionSource(Reference)
public boolean hasStructuredData()
public boolean isComputed()
DescriptionType.COMPUTED
computed.DescriptionType.AGGREGATED
.
Also for them this method returns true
.public boolean isAggregated()
public boolean isAggregatedDistribution()
public boolean isAggregatedStructuredDescription()
public boolean isCloneForSource()
public static boolean isDefaultForAggregation(java.util.EnumSet<DescriptionType> set)
public static boolean isSecondaryData(java.util.EnumSet<DescriptionType> set)
public java.lang.Object clone()
Name descriptions
are cloned as XXX.Type designations
are cloned as XXX.Name relation
are cloned as XXX.clone
in class IdentifiableEntity<S extends IIdentifiableEntityCacheStrategy>
eu.etaxonomy.cdm.model.media.IdentifiableEntity#clone()
,
Object.clone()
Copyright © 2007-2020 EDIT. All Rights Reserved.