@Entity @Indexed(index="eu.etaxonomy.cdm.model.description.DescriptionElementBase") public class CommonTaxonName extends DescriptionElementBase implements java.lang.Cloneable
taxa
.
Only taxon descriptions
may contain common names.
Common names vary not only according to the language
but also sometimes
according to geospatial areas
. Furthermore there might be several
distinct common names in one language and in the same geospatial area to
designate the same taxon. Therefore using a multilanguage text
would not have been adequate.annotations, markers
CLOB_LENGTH, uuid
Modifier | Constructor and Description |
---|---|
protected |
CommonTaxonName()
Class constructor: creates a new empty common name instance.
|
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
Clones this common name.
|
NamedArea |
getArea()
The area where the name is used
|
Language |
getLanguage()
Returns the
language used for this common name. |
java.lang.String |
getName()
Returns the name string of this common name.
|
static CommonTaxonName |
NewInstance(java.lang.String name,
Language language)
Creates a common name instance with the given name string and the given
language . |
static CommonTaxonName |
NewInstance(java.lang.String name,
Language language,
NamedArea area)
Creates a common name instance with the given name string and the given
language . |
void |
setArea(NamedArea area) |
void |
setFeature(Feature feature)
Deprecated.
Deprecated because
feature should always be COMMON_NAME
for all common name instances. |
void |
setLanguage(Language language) |
void |
setName(java.lang.String name) |
java.lang.String |
toString()
Overrides
Object.toString() . |
addAggregationSource, addImportSource, addMedia, addModifier, addModifyingText, addModifyingText, addPrimaryTaxonomicSource, addPrimaryTaxonomicSource, addSource, addSource, addSource, addSource, addSources, clone, getFeature, getInDescription, getMedia, getModifiers, getModifiers, getModifyingText, getSortIndex, getSources, getTimeperiod, isCharacterData, makeModifierMap, putModifyingText, putModifyingText, removeMedia, removeModifier, removeModifyingText, removeSource, setInDescription, setSortIndex, setTimeperiod
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, initListener, instanceToString, invokeSetMethod, invokeSetMethodWithNull, isBlank, isInstanceOf, isNotBlank, isPersited, removeFromSetWithChangeEvent, removePropertyChangeListener, removePropertyChangeListener, replaceInList, setCreated, setCreatedBy, setId, setNewEntityListener, setUuid
finalize, getClass, notify, notifyAll, wait, wait, wait
getUpdated, getUpdatedBy, setUpdated, setUpdatedBy
getCreated, getCreatedBy, getId, getUuid, isInstanceOf, isPersited, setCreated, setCreatedBy, setId, setUuid
protected CommonTaxonName()
feature
is set to COMMON_NAME
.public static CommonTaxonName NewInstance(java.lang.String name, Language language)
language
. The corresponding feature
is set to
COMMON_NAME
.name
- the name stringlanguage
- the language of the name stringpublic static CommonTaxonName NewInstance(java.lang.String name, Language language, NamedArea area)
language
. The corresponding feature
is set to
COMMON_NAME
.name
- the name stringlanguage
- the language of the name stringarea
- the area where this common name is used@Deprecated public void setFeature(Feature feature)
feature
should always be COMMON_NAME
for all common name instances.setFeature
in class DescriptionElementBase
DescriptionElementBase.getFeature()
public void setLanguage(Language language)
getLanguage()
public java.lang.String getName()
public void setName(java.lang.String name)
getName()
public NamedArea getArea()
public java.lang.Object clone()
clone
in class DescriptionElementBase
DescriptionElementBase.clone()
,
Object.clone()
public java.lang.String toString()
CdmBase
Object.toString()
.
This returns an String that identifies the object well without being necessarily unique. Internally the method is delegating the
call to {link CdmBase.instanceToString()
.Note: If overriding this method's javadoc always copy or link the above requirement. If not overwritten by a subclass method returns the class, id and uuid as a string for any CDM object.
For example: Taxon#13<b5938a98-c1de-4dda-b040-d5cc5bfb3bc0>
Copyright © 2007-2020 EDIT. All Rights Reserved.