eu.etaxonomy.cdm.model.taxon
Class TaxonBase<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.taxon.TaxonBase<S>

All Implemented Interfaces:

IAnnotatableEntity, ICdmBase, IIdentifiableEntity, ISourceable<IdentifiableSource>, IVersionableEntity, Serializable, Cloneable

Direct Known Subclasses:

Synonym, Taxon

@TaxonNameCannotBeAcceptedAndSynonym(groups=Level3.class)
public abstract class TaxonBase<S extends IIdentifiableEntityCacheStrategy>
extends IdentifiableEntity<S>
implements Cloneable

The upmost (abstract) class for the use of a taxon name in a reference or within a taxonomic view/treatment either as a taxon ("accepted" respectively "correct" name) or as a (junior) synonym. Within a taxonomic view/treatment or a reference a taxon name can be used only in one of both described meanings. The reference using the taxon name is generally cited with "sec." (secundum, sensu). For instance: "Juncus longirostris Kuvaev sec. Kirschner, J. et al. 2002".

This class corresponds to:

• TaxonConcept according to the TDWG ontology
• TaxonConcept according to the TCS

Version:

1.0

Author:

m.doering

See Also:

Serialized Form

Field Summary

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	TaxonBase() Class constructor: creates a new empty (abstract) taxon.
protected	TaxonBase(TaxonNameBase taxonNameBase, Reference sec) Class constructor: creates a new (abstract) taxon with the taxon name used and the reference using it.

Method Summary

Object	clone() Clones this taxon.
String	getAppendedPhrase() An appended phrase is a phrase that is added to the taxon name 's title cache to be used just in this taxon.
HomotypicalGroup	getHomotypicGroup() Returns the homotypical group of the taxon name used in this (abstract) taxon.
TaxonNameBase	getName() Returns the taxon name used in this (abstract) taxon.
Reference	getSec() Returns the reference of this (abstract) taxon.
boolean	isDoubtful() Returns the boolean value indicating whether the assignment of this (abstract) taxon to the Taxon or to the Synonym class is definitive (false) or not (true).
boolean	isUseNameCache()
void	setAppendedPhrase(String appendedPhrase)
void	setDoubtful(boolean doubtful)
void	setName(TaxonNameBase name)
void	setSec(Reference sec)
void	setUseNameCache(boolean useNameCache)

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

addCredit, addCredit, addExtension, addExtension, addRights, addSource, addSource, compareTo, generateTitle, getCacheStrategy, getCredits, getCredits, getData, getExtensions, getExtensions, getExtensions, getLsid, getRights, getSources, getTitleCache, getTruncatedCache, initListener, isProtectedTitleCache, 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, 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

TaxonBase

protected TaxonBase()

Class constructor: creates a new empty (abstract) taxon.

See Also:

TaxonBase(TaxonNameBase, Reference)

TaxonBase

protected TaxonBase(TaxonNameBase taxonNameBase,
                    Reference sec)

Class constructor: creates a new (abstract) taxon with the taxon name used and the reference using it.

Parameters:

taxonNameBase - the taxon name used

sec - the reference using the taxon name

See Also:

TaxonBase()

Method Detail

getName

public TaxonNameBase getName()

Returns the taxon name used in this (abstract) taxon.

setName

public void setName(TaxonNameBase name)

getHomotypicGroup

public HomotypicalGroup getHomotypicGroup()

Returns the homotypical group of the taxon name used in this (abstract) taxon.

isDoubtful

public boolean isDoubtful()

Returns the boolean value indicating whether the assignment of this (abstract) taxon to the Taxon or to the Synonym class is definitive (false) or not (true). If this flag is set the use of this (abstract) taxon as an "accepted/correct" name or as a (junior) "synonym" might still change in the course of taxonomical working process.

setDoubtful

public void setDoubtful(boolean doubtful)

See Also:

isDoubtful()

getSec

public Reference getSec()

Returns the reference of this (abstract) taxon. This is the reference or the treatment using the taxon name in this (abstract) taxon.

setSec

public void setSec(Reference sec)

See Also:

getSec()

getAppendedPhrase

public String getAppendedPhrase()

An appended phrase is a phrase that is added to the taxon name 's title cache to be used just in this taxon. E.g. the phrase "sensu latu" may be added to the name to describe this taxon more precisely. If isUseNameCache()

Returns:

the appendedPhrase

setAppendedPhrase

public void setAppendedPhrase(String appendedPhrase)

Parameters:

appendedPhrase - the appendedPhrase to set

isUseNameCache

public boolean isUseNameCache()

Returns:

the useNameCache

setUseNameCache

public void setUseNameCache(boolean useNameCache)

Parameters:

useNameCache - the useNameCache to set

clone

public Object clone()

Clones this taxon. This is a shortcut that enables to create a new instance with empty taxon name and sec reference.

Overrides:

clone in class IdentifiableEntity<S extends IIdentifiableEntityCacheStrategy>

See Also:

eu.etaxonomy.cdm.model.media.IdentifiableEntity#clone(), Object.clone()