eu.etaxonomy.cdm.model.description

Class DescriptionElementBase

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.description.DescriptionElementBase

All Implemented Interfaces:

IAnnotatableEntity, ICdmBase, IMultiLanguageTextHolder, ISelfDescriptive, IVersionableEntity, IModifiable, ISourceable<DescriptionElementSource>, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

CategoricalData, CommonTaxonName, Distribution, IndividualsAssociation, QuantitativeData, TaxonInteraction, TextData

@Entity
public abstract class DescriptionElementBase
extends AnnotatableEntity
implements ISourceable<DescriptionElementSource>, IModifiable, IMultiLanguageTextHolder

The upmost (abstract) class for a piece of information) about a specimen, a taxon or even a taxon name. A concrete description element assigns descriptive data to one feature.
Experts use the word feature for the property itself but not for the actual description element. Therefore naming this class FeatureBase would have leaded to confusion.

This class corresponds to:

• DescriptionsBaseType according to the the SDD schema
• InfoItem according to the TDWG ontology
• MeasurementOrFactAtomised according to the ABCD schema

Since:

08-Nov-2007 13:06:24

Author:

m.doering

See Also:

Serialized Form

Field Summary

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

annotations, markers

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

CLOB_LENGTH, uuid

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DescriptionElementBase() Class constructor: creates a new empty description element instance.
protected	DescriptionElementBase(Feature feature) Class constructor: creates a new description element instance with the given feature that is described or measured.

Method Summary

Modifier and Type	Method and Description
DescriptionElementSource	addAggregationSource(ICdmTarget target) Adds a source which links to another CDM object as source.
DescriptionElementSource	addImportSource(java.lang.String id, java.lang.String idNamespace, Reference reference, java.lang.String microReference) Adds a source of type OriginalSourceType.Import to this object.
void	addMedia(Media media) Adds a media to the list of media this description element is based on.
void	addModifier(DefinedTerm modifier) Adds a modifier to the set of modifiers used to qualify the validity of this description element.
LanguageString	addModifyingText(LanguageString description) Deprecated. should follow the put semantic of maps, this method will be removed in v4.0 Use the putModifyingText method
LanguageString	addModifyingText(java.lang.String text, Language language) Deprecated. should follow the put semantic of maps, this method will be removed in v4.0 Use the putModifyingText method
DescriptionElementSource	addPrimaryTaxonomicSource(Reference reference) Adds a source of type OriginalSourceType.PrimaryTaxonomicSource to this object.
DescriptionElementSource	addPrimaryTaxonomicSource(Reference reference, java.lang.String microReference) Adds a source of type OriginalSourceType.PrimaryTaxonomicSource to this object.
void	addSource(DescriptionElementSource source) Adds a source to this object
DescriptionElementSource	addSource(OriginalSourceType type, Reference reference, java.lang.String microReference, java.lang.String originalInformation)
DescriptionElementSource	addSource(OriginalSourceType type, java.lang.String id, java.lang.String idNamespace, Reference reference, java.lang.String microReference) Adds a source that is newly created by its components.
DescriptionElementSource	addSource(OriginalSourceType type, java.lang.String idInSource, java.lang.String idNamespace, Reference reference, java.lang.String microReference, TaxonName nameUsedInSource, java.lang.String originalNameString) Adds a source to this description element.
void	addSources(java.util.Set<DescriptionElementSource> sources) Adds a set of original sources (citations) for this sourceable object
java.lang.Object	clone() Clones the description element.
DescriptionElementBase	clone(DescriptionBase description) Clones the description element. The new element is added to the description.
Feature	getFeature() Returns the feature this description element is for.
DescriptionBase	getInDescription() Returns the description that this DescriptionElement is part of.
java.util.List<Media>	getMedia() Returns the list of media (that is pictures, movies, recorded sounds ...) this description element is based on.
java.util.Set<DefinedTerm>	getModifiers() Returns the set of modifiers used to qualify the validity of this description element.
java.util.List<DefinedTerm>	getModifiers(TermVocabulary voc)
java.util.Map<Language,LanguageString>	getModifyingText() Returns the multilanguage text used to qualify the validity of this description element.
java.lang.Integer	getSortIndex()
java.util.Set<DescriptionElementSource>	getSources() Returns the set of original sources (citations) for this sourceable object
TimePeriod	getTimeperiod() The point in time, the time period or the season for which this description element is valid.
boolean	isCharacterData() Is this description item of a class type which is considered to represent character data? These classes are QuantitativeData and CategoricalData.
protected java.util.Map<TermVocabulary,java.util.List<DefinedTerm>>	makeModifierMap()
LanguageString	putModifyingText(LanguageString description) Adds a translated text in a particular language to the multilanguage text used to qualify the validity of this description element.
LanguageString	putModifyingText(Language language, java.lang.String text) Creates a language string based on the given text string and the given language and adds it to the multilanguage text used to qualify the validity of this description element.
void	removeMedia(Media media) Removes one element from the list of media this description element is based on.
void	removeModifier(DefinedTerm modifier) Removes one element from the set of modifiers used to qualify the validity of this description element.
LanguageString	removeModifyingText(Language language) Removes from the multilanguage text used to qualify the validity of this description element the one language string with the given language.
void	removeSource(DescriptionElementSource source) Removes a source from this object
void	setFeature(Feature feature)
protected void	setInDescription(DescriptionBase inDescription)
void	setSortIndex(java.lang.Integer sortIndex)
void	setTimeperiod(TimePeriod timeperiod)

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

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

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

cloneLanguageString, equals, getUpdated, getUpdatedBy, setUpdated, setUpdatedBy

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

addPropertyChangeListener, addPropertyChangeListener, addToSetWithChangeEvent, deproxy, deproxy, fireOnCreateEvent, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getCreated, getCreatedBy, getId, getUserFriendlyDescription, getUserFriendlyFieldName, getUserFriendlyTypeName, getUuid, hashCode, hasListeners, initListener, instanceToString, invokeSetMethod, invokeSetMethodWithNull, isBlank, isInstanceOf, isNotBlank, isPersited, removeFromSetWithChangeEvent, removePropertyChangeListener, removePropertyChangeListener, replaceInList, setCreated, setCreatedBy, setId, setNewEntityListener, setUuid, toString

Methods inherited from class java.lang.Object

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

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, isInstanceOf, isPersited, setCreated, setCreatedBy, setId, setUuid

Constructor Detail

DescriptionElementBase

protected DescriptionElementBase()

Class constructor: creates a new empty description element instance.

See Also:

DescriptionElementBase(Feature)

DescriptionElementBase

protected DescriptionElementBase(Feature feature)

Class constructor: creates a new description element instance with the given feature that is described or measured.

Parameters:

feature - the feature described or measured

See Also:

DescriptionElementBase()

Method Detail

getMedia

public java.util.List<Media> getMedia()

Returns the list of media (that is pictures, movies, recorded sounds ...) this description element is based on.

addMedia

public void addMedia(Media media)

Adds a media to the list of media this description element is based on.

Parameters:

media - the media to be added to this description element

See Also:

getMedia()

removeMedia

public void removeMedia(Media media)

Removes one element from the list of media this description element is based on.

Parameters:

media - the media which should be removed

See Also:

getMedia(), addMedia(Media)

getInDescription

public DescriptionBase getInDescription()

Returns the description that this DescriptionElement is part of.

Returns:

setInDescription

protected void setInDescription(DescriptionBase inDescription)

See Also:

#setInDescription()

getFeature

public Feature getFeature()

Returns the feature this description element is for. A feature is a property that can be described or measured but not the description or the measurement itself.

setFeature

public void setFeature(Feature feature)

See Also:

getFeature()

getTimeperiod

public TimePeriod getTimeperiod()

The point in time, the time period or the season for which this description element is valid. A season may be expressed by not filling the year part(s) of the time period.

setTimeperiod

public void setTimeperiod(TimePeriod timeperiod)

See Also:

getTimeperiod()

getModifiers

public java.util.Set<DefinedTerm> getModifiers()

Returns the set of modifiers used to qualify the validity of this description element. This is only metainformation.

Specified by:

getModifiers in interface IModifiable

addModifier

public void addModifier(DefinedTerm modifier)

Adds a modifier to the set of modifiers used to qualify the validity of this description element.

Specified by:

addModifier in interface IModifiable

Parameters:

modifier - the modifier to be added to this description element

See Also:

getModifiers()

removeModifier

public void removeModifier(DefinedTerm modifier)

Removes one element from the set of modifiers used to qualify the validity of this description element.

Specified by:

removeModifier in interface IModifiable

Parameters:

modifier - the modifier which should be removed

See Also:

getModifiers(), #addModifier(Modifier)

getModifyingText

public java.util.Map<Language,LanguageString> getModifyingText()

Returns the multilanguage text used to qualify the validity of this description element. The different language strings contained in the multilanguage text should all have the same meaning.
A multilanguage text does not belong to a controlled term vocabulary as a modifier does.

NOTE: the actual content of this description element is NOT stored in the modifying text. This is only metainformation (like "Some experts express doubt about this assertion").

addModifyingText

@Deprecated
public LanguageString addModifyingText(LanguageString description)

Deprecated. should follow the put semantic of maps, this method will be removed in v4.0 Use the putModifyingText method

Adds a translated text in a particular language to the multilanguage text used to qualify the validity of this description element.

Parameters:

description - the language string describing the validity in a particular language

See Also:

getModifyingText(), putModifyingText(Language, String)

putModifyingText

public LanguageString putModifyingText(LanguageString description)

Adds a translated text in a particular language to the multilanguage text used to qualify the validity of this description element.

Parameters:

description - the language string describing the validity in a particular language

See Also:

getModifyingText(), putModifyingText(Language, String)

addModifyingText

@Deprecated
public LanguageString addModifyingText(java.lang.String text,
                                                   Language language)

Deprecated. should follow the put semantic of maps, this method will be removed in v4.0 Use the putModifyingText method

Creates a language string based on the given text string and the given language and adds it to the multilanguage text used to qualify the validity of this description element.

Parameters:

text - the string describing the validity in a particular language

language - the language in which the text string is formulated

See Also:

getModifyingText(), putModifyingText(LanguageString)

putModifyingText

public LanguageString putModifyingText(Language language,
                                       java.lang.String text)

Creates a language string based on the given text string and the given language and adds it to the multilanguage text used to qualify the validity of this description element.

Parameters:

language - the language in which the text string is formulated

text - the string describing the validity in a particular language

See Also:

getModifyingText(), putModifyingText(LanguageString)

removeModifyingText

public LanguageString removeModifyingText(Language language)

Removes from the multilanguage text used to qualify the validity of this description element the one language string with the given language.

Parameters:

language - the language in which the language string to be removed has been formulated

See Also:

getModifyingText()

getSources

public java.util.Set<DescriptionElementSource> getSources()

Description copied from interface: ISourceable

Returns the set of original sources (citations) for this sourceable object

Specified by:

getSources in interface ISourceable<DescriptionElementSource>

Returns:

addSource

public void addSource(DescriptionElementSource source)

Description copied from interface: ISourceable

Adds a source to this object

Specified by:

addSource in interface ISourceable<DescriptionElementSource>

addSource

public DescriptionElementSource addSource(OriginalSourceType type,
                                          java.lang.String id,
                                          java.lang.String idNamespace,
                                          Reference reference,
                                          java.lang.String microReference)

Description copied from interface: ISourceable

Adds a source that is newly created by its components. If all components except for the type are null no source is added.

Specified by:

addSource in interface ISourceable<DescriptionElementSource>

Parameters:

type - the type of the source

idNamespace - the namespace for the id in the source

reference - the source as a reference

microReference - the details (e.g. page number) in the reference

addSources

public void addSources(java.util.Set<DescriptionElementSource> sources)

Description copied from interface: ISourceable

Adds a set of original sources (citations) for this sourceable object

Specified by:

addSources in interface ISourceable<DescriptionElementSource>

addImportSource

public DescriptionElementSource addImportSource(java.lang.String id,
                                                java.lang.String idNamespace,
                                                Reference reference,
                                                java.lang.String microReference)

Description copied from interface: ISourceable

Adds a source of type OriginalSourceType.Import to this object.

Specified by:

addImportSource in interface ISourceable<DescriptionElementSource>

idNamespace - the namespace for the id in the source

reference - the source as a reference

microReference - the details (e.g. page number) in the reference

addPrimaryTaxonomicSource

public DescriptionElementSource addPrimaryTaxonomicSource(Reference reference,
                                                          java.lang.String microReference)

Description copied from interface: ISourceable

Adds a source of type OriginalSourceType.PrimaryTaxonomicSource to this object.

Specified by:

addPrimaryTaxonomicSource in interface ISourceable<DescriptionElementSource>

Parameters:

reference - the source as a reference

microReference - the details (e.g. page number) in the reference

addPrimaryTaxonomicSource

public DescriptionElementSource addPrimaryTaxonomicSource(Reference reference)

Description copied from interface: ISourceable

Adds a source of type OriginalSourceType.PrimaryTaxonomicSource to this object.

Specified by:

addPrimaryTaxonomicSource in interface ISourceable<DescriptionElementSource>

Parameters:

reference - the source as a reference

addSource

public DescriptionElementSource addSource(OriginalSourceType type,
                                          Reference reference,
                                          java.lang.String microReference,
                                          java.lang.String originalInformation)

Specified by:

addSource in interface ISourceable<DescriptionElementSource>

Returns:

the added source

addSource

public DescriptionElementSource addSource(OriginalSourceType type,
                                          java.lang.String idInSource,
                                          java.lang.String idNamespace,
                                          Reference reference,
                                          java.lang.String microReference,
                                          TaxonName nameUsedInSource,
                                          java.lang.String originalNameString)

Adds a source to this description element.

Parameters:

type - the type of the source

idInSource - the id used in the source

idNamespace - the namespace for the id in the source

reference - the source as a reference

microReference - the details (e.g. page number) in the reference

nameUsedInSource - the taxon name used in the source

originalNameString - the name as text used in the source

addAggregationSource

public DescriptionElementSource addAggregationSource(ICdmTarget target)

Description copied from interface: ISourceable

Adds a source which links to another CDM object as source.

Specified by:

addAggregationSource in interface ISourceable<DescriptionElementSource>

Parameters:

target - the target CDM source

Returns:

the aggregation source

removeSource

public void removeSource(DescriptionElementSource source)

Description copied from interface: ISourceable

Removes a source from this object

Specified by:

removeSource in interface ISourceable<DescriptionElementSource>

getSortIndex

public java.lang.Integer getSortIndex()

setSortIndex

public void setSortIndex(java.lang.Integer sortIndex)

makeModifierMap

protected java.util.Map<TermVocabulary,java.util.List<DefinedTerm>> makeModifierMap()

getModifiers

public java.util.List<DefinedTerm> getModifiers(TermVocabulary voc)

isCharacterData

public boolean isCharacterData()

Is this description item of a class type which is considered to represent character data? These classes are QuantitativeData and CategoricalData. To be overridden by these classes.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clones the description element. The element is not added to the same description as the original element (inDescription is set to null).

Overrides:

clone in class AnnotatableEntity

Throws:

java.lang.CloneNotSupportedException

See Also:

AnnotatableEntity.clone()

clone

public DescriptionElementBase clone(DescriptionBase description)
                             throws java.lang.CloneNotSupportedException

Clones the description element.
The new element is added to the description.

Throws:

java.lang.CloneNotSupportedException

See Also:

AnnotatableEntity.clone()