eu.etaxonomy.cdm.model.name
Class BotanicalName

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.name.TaxonNameBase<T,INonViralNameCacheStrategy>
                      eu.etaxonomy.cdm.model.name.NonViralName<BotanicalName>
                          eu.etaxonomy.cdm.model.name.BotanicalName

All Implemented Interfaces:

IAnnotatableEntity, ICdmBase, IIdentifiableEntity, IParsable, IReferencedEntity, IRelated, ISourceable<IdentifiableSource>, IVersionableEntity, IMatchable, Serializable, Cloneable

Direct Known Subclasses:

CultivarPlantName

@Entity
@Indexed(index="eu.etaxonomy.cdm.model.name.TaxonNameBase")
@Configurable
public class BotanicalName
extends NonViralName<BotanicalName>
implements Cloneable

The taxon name class for plants and fungi.

This class corresponds to: NameBotanical according to the ABCD schema.

Version:

1.0

Author:

m.doering

See Also:

Serialized Form

Field Summary

Fields inherited from class eu.etaxonomy.cdm.model.name.NonViralName

protectedAuthorshipCache, protectedNameCache

Fields inherited from class eu.etaxonomy.cdm.model.name.TaxonNameBase

fullTitleCache

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	BotanicalName() Class constructor: creates a new botanical taxon name instance only containing the default cache strategy.
protected	BotanicalName(Rank rank, HomotypicalGroup homotypicalGroup) Class constructor: creates a new botanical taxon name instance only containing its rank, its homotypical group and the default cache strategy.
protected	BotanicalName(Rank rank, String genusOrUninomial, String infraGenericEpithet, String specificEpithet, String infraSpecificEpithet, TeamOrPersonBase combinationAuthorTeam, INomenclaturalReference nomenclaturalReference, String nomenclMicroRef, HomotypicalGroup homotypicalGroup) Class constructor: creates a new botanical taxon name instance containing its rank, its homotypical group, its scientific name components, its author(team), its nomenclatural reference and the default cache strategy.

Method Summary

Object	clone() Clones this botanical name.
protected Map<String,Field>	getAllFields()
NomenclaturalCode	getNomenclaturalCode() Returns the nomenclatural code that governs the construction of this botanical taxon name, that is the International Code of Botanical Nomenclature.
boolean	isAnamorphic() Returns the boolean value of the flag indicating whether the specimen type of this botanical taxon name for a fungus is asexual (true) or not (false).
boolean	isAutonym() Checks if this name is an autonym. An autonym is a taxon name that has equal specific and infra specific epithets. {@link http://ibot.sav.sk/icbn/frameset/0010Ch2Sec1a006.htm#6.8.
static BotanicalName	NewInstance(Rank rank) Creates a new botanical taxon name instance only containing its rank and the default cache strategy.
static BotanicalName	NewInstance(Rank rank, HomotypicalGroup homotypicalGroup) Creates a new botanical taxon name instance only containing its rank, its homotypical group and the default cache strategy.
static BotanicalName	NewInstance(Rank rank, String genusOrUninomial, String infraGenericEpithet, String specificEpithet, String infraSpecificEpithet, TeamOrPersonBase combinationAuthorTeam, INomenclaturalReference nomenclaturalReference, String nomenclMicroRef, HomotypicalGroup homotypicalGroup) Creates a new botanical taxon name instance containing its rank, its homotypical group, its scientific name components, its author(team), its nomenclatural reference and the default cache strategy.
static BotanicalName	PARSED_NAME(String fullNameString) Returns a botanical taxon name based on parsing a string representing all elements (according to the ICBN) of a botanical taxon name (where the scientific name is an uninomial) including authorship but without nomenclatural reference.
static BotanicalName	PARSED_NAME(String fullNameString, Rank rank) Returns a botanical taxon name based on parsing a string representing all elements (according to the ICBN) of a botanical taxon name including authorship but without nomenclatural reference.
static BotanicalName	PARSED_REFERENCE(String fullNameAndReferenceString) Returns a botanical taxon name based on parsing a string representing all elements (according to the ICBN) of a botanical taxon name (where the scientific name is an uninomial) including authorship and nomenclatural reference.
static BotanicalName	PARSED_REFERENCE(String fullNameAndReferenceString, Rank rank) Returns a botanical taxon name based on parsing a string representing all elements (according to the ICBN) of a botanical taxon name including authorship and nomenclatural reference.
void	setAnamorphic(boolean anamorphic)

Methods inherited from class eu.etaxonomy.cdm.model.name.NonViralName

addHybridChild, addHybridParent, addHybridRelationship, addRelationship, computeBasionymAuthorNomenclaturalTitle, computeCombinationAuthorNomenclaturalTitle, computeExBasionymAuthorNomenclaturalTitle, computeExCombinationAuthorNomenclaturalTitle, generateAuthorship, generateFullTitle, generateNameCache, getAuthorshipCache, getBasionymAuthorTeam, getChildRelationships, getCombinationAuthorTeam, getExBasionymAuthorTeam, getExCombinationAuthorTeam, getFullTitleCache, getGenusOrUninomial, getHybridChildRelations, getHybridParentRelations, getInfraGenericEpithet, getInfraSpecificEpithet, getNameCache, getOrderedChildRelationships, getParentRelationships, getSpecificEpithet, getTitleCache, hasAuthors, initListener, isBinomHybrid, isCodeCompliant, isHybridFormula, isMonomHybrid, isProtectedAuthorshipCache, isProtectedNameCache, isTrinomHybrid, removeHybridChild, removeHybridParent, removeHybridRelationship, setAuthorshipCache, setAuthorshipCache, setBasionymAuthorTeam, setBinomHybrid, setCombinationAuthorTeam, setExBasionymAuthorTeam, setExCombinationAuthorTeam, setGenusOrUninomial, setHybridFormula, setInfraGenericEpithet, setInfraSpecificEpithet, setMonomHybrid, setNameCache, setNameCache, setProtectedAuthorshipCache, setProtectedNameCache, setSpecificEpithet, setTitleCache, setTrinomHybrid

Methods inherited from class eu.etaxonomy.cdm.model.name.TaxonNameBase

addBasionym, addBasionym, addDescription, addNameRelationship, addNameTypeDesignation, addNameTypeDesignation, addParsingProblem, addParsingProblems, addRelationshipFromName, addRelationshipFromName, addRelationshipToName, addRelationshipToName, addReplacedSynonym, addSpecimenTypeDesignation, addStatus, addTaxonBase, addTypeDesignation, getAppendedPhrase, getBasionym, getBasionyms, getCitation, getCitationString, getDescriptions, getHomotypicalGroup, getNameRelations, getNameTypeDesignations, getNomenclaturalMicroReference, getNomenclaturalReference, getParsingProblem, getParsingProblems, getProblemEnds, getProblemStarts, getRank, getReferenceYear, getRelationsFromThisName, getRelationsToThisName, getSpecimenTypeDesignations, getSpecimenTypeDesignationsOfHomotypicalGroup, getStatus, getSynonyms, getTaggedName, getTaxa, getTaxonBases, getTypeDesignations, hasProblem, hasProblem, isBasionymFor, isGenus, isGroupsBasionym, isHomotypic, isInfraGeneric, isInfraSpecific, isOriginalCombination, isProtectedFullTitleCache, isSpecies, isSupraGeneric, isSupraSpecific, makeGroupsBasionym, mergeHomotypicGroups, removeAsGroupsBasionym, removeBasionyms, removeDescription, removeNameRelationship, removeParsingProblem, removeRelationToTaxonName, removeStatus, removeTaxonBase, removeTypeDesignation, setAppendedPhrase, setAsGroupsBasionym, setFullTitleCache, setFullTitleCache, setHomotypicalGroup, setNomenclaturalMicroReference, setNomenclaturalReference, setParsingProblem, setProblemEnds, setProblemStarts, setProtectedFullTitleCache, setRank

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, getTruncatedCache, isProtectedTitleCache, regenerateTitleCache, removeCredit, removeCredit, removeExtension, removeRights, removeSource, setCacheStrategy, setLsid, setProtectedTitleCache, 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.IRelated

getUuid

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

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

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

Constructor Detail

BotanicalName

protected BotanicalName()

Class constructor: creates a new botanical taxon name instance only containing the default cache strategy.

See Also:

BotanicalName(Rank, HomotypicalGroup), BotanicalName(Rank, String, String, String, String, TeamOrPersonBase, INomenclaturalReference, String, HomotypicalGroup), BotanicNameDefaultCacheStrategy

BotanicalName

protected BotanicalName(Rank rank,
                        HomotypicalGroup homotypicalGroup)

Class constructor: creates a new botanical taxon name instance only containing its rank, its homotypical group and the default cache strategy. The new botanical taxon name instance will be also added to the set of botanical taxon names belonging to this homotypical group.

Parameters:

rank - the rank to be assigned to this botanical taxon name

homotypicalGroup - the homotypical group to which this botanical taxon name belongs

See Also:

BotanicalName(), #BotanicalName(Rank, String, String, String, TeamOrPersonBase, INomenclaturalReference, String, HomotypicalGroup), BotanicNameDefaultCacheStrategy

BotanicalName

protected BotanicalName(Rank rank,
                        String genusOrUninomial,
                        String infraGenericEpithet,
                        String specificEpithet,
                        String infraSpecificEpithet,
                        TeamOrPersonBase combinationAuthorTeam,
                        INomenclaturalReference nomenclaturalReference,
                        String nomenclMicroRef,
                        HomotypicalGroup homotypicalGroup)

Class constructor: creates a new botanical taxon name instance containing its rank, its homotypical group, its scientific name components, its author(team), its nomenclatural reference and the default cache strategy. The new botanical taxon name instance will be also added to the set of botanical taxon names belonging to this homotypical group.

Parameters:

rank - the rank to be assigned to this botanical taxon name

genusOrUninomial - the string for this botanical taxon name if its rank is genus or higher or for the genus part if its rank is lower than genus

infraGenericEpithet - the string for the first epithet of this botanical taxon name if its rank is lower than genus and higher than species aggregate

specificEpithet - the string for the first epithet of this botanical taxon name if its rank is species aggregate or lower

infraSpecificEpithet - the string for the second epithet of this botanical taxon name if its rank is lower than species

combinationAuthorTeam - the author or the team who published this botanical taxon name

nomenclaturalReference - the nomenclatural reference where this botanical taxon name was published

nomenclMicroRef - the string with the details for precise location within the nomenclatural reference

homotypicalGroup - the homotypical group to which this botanical taxon name belongs

See Also:

BotanicalName(), BotanicalName(Rank, HomotypicalGroup), NewInstance(Rank, String, String, String, String, TeamOrPersonBase, INomenclaturalReference, String, HomotypicalGroup), BotanicNameDefaultCacheStrategy, INonViralNameCacheStrategy, IIdentifiableEntityCacheStrategy

Method Detail

NewInstance

public static BotanicalName NewInstance(Rank rank)

Creates a new botanical taxon name instance only containing its rank and the default cache strategy.

Parameters:

rank - the rank to be assigned to this botanical taxon name

See Also:

BotanicalName(Rank, HomotypicalGroup), NewInstance(Rank, HomotypicalGroup), NewInstance(Rank, String, String, String, String, TeamOrPersonBase, INomenclaturalReference, String, HomotypicalGroup), BotanicNameDefaultCacheStrategy

NewInstance

public static BotanicalName NewInstance(Rank rank,
                                        HomotypicalGroup homotypicalGroup)

Creates a new botanical taxon name instance only containing its rank, its homotypical group and the default cache strategy. The new botanical taxon name instance will be also added to the set of botanical taxon names belonging to this homotypical group.

Parameters:

rank - the rank to be assigned to this botanical taxon name

homotypicalGroup - the homotypical group to which this botanical taxon name belongs

See Also:

NewInstance(Rank), NewInstance(Rank, String, String, String, String, TeamOrPersonBase, INomenclaturalReference, String, HomotypicalGroup), BotanicalName(Rank, HomotypicalGroup), BotanicNameDefaultCacheStrategy

NewInstance

public static BotanicalName NewInstance(Rank rank,
                                        String genusOrUninomial,
                                        String infraGenericEpithet,
                                        String specificEpithet,
                                        String infraSpecificEpithet,
                                        TeamOrPersonBase combinationAuthorTeam,
                                        INomenclaturalReference nomenclaturalReference,
                                        String nomenclMicroRef,
                                        HomotypicalGroup homotypicalGroup)

Creates a new botanical taxon name instance containing its rank, its homotypical group, its scientific name components, its author(team), its nomenclatural reference and the default cache strategy. The new botanical taxon name instance will be also added to the set of botanical taxon names belonging to this homotypical group.

Parameters:

rank - the rank to be assigned to this botanical taxon name

genusOrUninomial - the string for this botanical taxon name if its rank is genus or higher or for the genus part if its rank is lower than genus

infraGenericEpithet - the string for the first epithet of this botanical taxon name if its rank is lower than genus and higher than species aggregate

specificEpithet - the string for the first epithet of this botanical taxon name if its rank is species aggregate or lower

infraSpecificEpithet - the string for the second epithet of this botanical taxon name if its rank is lower than species

combinationAuthorTeam - the author or the team who published this botanical taxon name

nomenclaturalReference - the nomenclatural reference where this botanical taxon name was published

nomenclMicroRef - the string with the details for precise location within the nomenclatural reference

homotypicalGroup - the homotypical group to which this botanical taxon name belongs

See Also:

NewInstance(Rank), NewInstance(Rank, HomotypicalGroup), ZoologicalName.ZoologicalName(Rank, String, String, String, String, TeamOrPersonBase, INomenclaturalReference, String, HomotypicalGroup), BotanicNameDefaultCacheStrategy

PARSED_NAME

public static BotanicalName PARSED_NAME(String fullNameString)

Returns a botanical taxon name based on parsing a string representing all elements (according to the ICBN) of a botanical taxon name (where the scientific name is an uninomial) including authorship but without nomenclatural reference. If the rank is not "Genus" it should be set afterwards with the setRank methode.

Parameters:

fullNameString - the string to be parsed

Returns:

the new botanical taxon name

PARSED_NAME

public static BotanicalName PARSED_NAME(String fullNameString,
                                        Rank rank)

Returns a botanical taxon name based on parsing a string representing all elements (according to the ICBN) of a botanical taxon name including authorship but without nomenclatural reference. The parsing result depends on the given rank of the botanical taxon name to be created.

Parameters:

fullNameString - the string to be parsed

rank - the rank of the taxon name

Returns:

the new botanical taxon name

PARSED_REFERENCE

public static BotanicalName PARSED_REFERENCE(String fullNameAndReferenceString)

Returns a botanical taxon name based on parsing a string representing all elements (according to the ICBN) of a botanical taxon name (where the scientific name is an uninomial) including authorship and nomenclatural reference. Eventually a new nomenclatural reference instance will also be created. If the rank is not "Genus" it should be set afterwards with the setRank methode.

Parameters:

fullNameAndReferenceString - the string to be parsed

Returns:

the new botanical taxon name

PARSED_REFERENCE

public static BotanicalName PARSED_REFERENCE(String fullNameAndReferenceString,
                                             Rank rank)

Returns a botanical taxon name based on parsing a string representing all elements (according to the ICBN) of a botanical taxon name including authorship and nomenclatural reference. The parsing result depends on the given rank of the botanical taxon name to be created. Eventually a new nomenclatural reference instance will also be created.

Parameters:

fullNameAndReferenceString - the string to be parsed

rank - the rank of the taxon name

Returns:

the new botanical taxon name

getAllFields

protected Map<String,Field> getAllFields()

Overrides:

getAllFields in class NonViralName<BotanicalName>

isAnamorphic

public boolean isAnamorphic()

Returns the boolean value of the flag indicating whether the specimen type of this botanical taxon name for a fungus is asexual (true) or not (false). This applies only in case of fungi. The Article 59 of the ICBN permits mycologists to give asexually reproducing fungi (anamorphs) separate names from their sexual states (teleomorphs).

Returns:

the boolean value of the isAnamorphic flag

setAnamorphic

public void setAnamorphic(boolean anamorphic)

See Also:

isAnamorphic()

getNomenclaturalCode

public NomenclaturalCode getNomenclaturalCode()

Returns the nomenclatural code that governs the construction of this botanical taxon name, that is the International Code of Botanical Nomenclature. This method overrides the getNomeclaturalCode method from NonViralName.

Overrides:

getNomenclaturalCode in class NonViralName<BotanicalName>

Returns:

the nomenclatural code for plants

See Also:

NonViralName.isCodeCompliant(), TaxonNameBase#getHasProblem()

isAutonym

public boolean isAutonym()

Checks if this name is an autonym.
An autonym is a taxon name that has equal specific and infra specific epithets.
Vienna Code §6.8

Overrides:

isAutonym in class NonViralName<BotanicalName>

Returns:

true, if name has Rank, Rank is below species and species epithet equals infraSpeciesEpithtet, else false

clone

public Object clone()

Clones this botanical name. This is a shortcut that enables to create a new instance that differs only slightly from this botanical name by modifying only some of the attributes.

Overrides:

clone in class NonViralName<BotanicalName>

See Also:

NonViralName.clone(), Object.clone()