TaxonNameBase (CDM Library 4.7.0-SNAPSHOT API)

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,S>

All Implemented Interfaces:

IAnnotatableEntity, ICdmBase, IIdentifiableEntity, IIntextReferenceTarget, IParsable, IRelated, ISelfDescriptive, ISourceable<IdentifiableSource>, IVersionableEntity, IBacterialName, IBotanicalName, ICultivarPlantName, INonViralName, ITaxonNameBase, IViralName, IZoologicalName, IMatchable, Serializable, Cloneable

Direct Known Subclasses:

NonViralName, ViralName
```
@Entity
 @NameMustFollowCode
public abstract class TaxonNameBase<T extends TaxonNameBase<?,?>,S extends INameCacheStrategy>
extends IdentifiableEntity<S>
implements ITaxonNameBase, INonViralName, IViralName, IBacterialName, IZoologicalName, IBotanicalName, ICultivarPlantName, IParsable, IRelated, IMatchable, IIntextReferenceTarget, Cloneable
```
The upmost (abstract) class for scientific taxon names regardless of any particular nomenclature code. The scientific taxon name does not depend on the use made of it in a publication or a treatment (taxon concept respectively potential taxon) as an "accepted" respectively "correct" (taxon) name or as a synonym.
This class corresponds partially to:
- TaxonName according to the TDWG ontology
- ScientificName and CanonicalName according to the TCS
- ScientificName according to the ABCD schema
Author:

m.doering

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected String fullTitleCache

protected boolean protectedAuthorshipCache

protected boolean protectedNameCache
- 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

Fields
Modifier and Type	Field and Description
`protected String`	`fullTitleCache`
`protected boolean`	`protectedAuthorshipCache`
`protected boolean`	`protectedNameCache`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`TaxonNameBase()` Class constructor: creates a new empty taxon name.
`protected`	`TaxonNameBase(HomotypicalGroup homotypicalGroup)` Class constructor: creates a new taxon name instance only containing its `homotypical group`.
`protected`	`TaxonNameBase(Rank rank)` Class constructor: creates a new taxon name only containing its `rank`.
`protected`	`TaxonNameBase(Rank rank, HomotypicalGroup homotypicalGroup)` Class constructor: creates a new taxon name instance only containing its `rank` and its `homotypical group` and the `default cache strategy`.
`protected`	`TaxonNameBase(Rank rank, String genusOrUninomial, String infraGenericEpithet, String specificEpithet, String infraSpecificEpithet, TeamOrPersonBase combinationAuthorship, INomenclaturalReference nomenclaturalReference, String nomenclMicroRef, HomotypicalGroup homotypicalGroup)` Class constructor: creates a new non viral 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

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addBasionym(TaxonNameBase basionym)` Assigns a taxon name as `basionym` of this taxon name.
`NameRelationship`	`addBasionym(TaxonNameBase basionym, Reference citation, String microcitation, String ruleConsidered)` Assigns a taxon name as `basionym` of this taxon name and keeps the nomenclatural rule considered for it.
`void`	`addDescription(TaxonNameDescription description)` Adds a new `taxon name description` to the set of taxon name descriptions assigned to this taxon name.
`HybridRelationship`	`addHybridChild(INonViralName childName, HybridRelationshipType type, String ruleConsidered)` Creates a new `hybrid relationship` to this botanical name.
`HybridRelationship`	`addHybridParent(INonViralName parentName, HybridRelationshipType type, String ruleConsidered)` Creates a new `hybrid relationship` to this botanical name.
`protected void`	`addHybridRelationship(HybridRelationship rel)` Adds the given `hybrid relationship` to the set of `hybrid relationships` of both non-viral names involved in this hybrid relationship.
`protected void`	`addNameRelationship(NameRelationship rel)` Adds an existing `name relationship` either to the set of `relations to this taxon name` or to the set of `relations from this taxon name`.
`NameTypeDesignation`	`addNameTypeDesignation(TaxonNameBase typeSpecies, Reference citation, String citationMicroReference, String originalNameString, NameTypeDesignationStatus status, boolean addToAllHomotypicNames)` Creates and adds a new `name type designation` to this taxon name's set of type designations.
`NameTypeDesignation`	`addNameTypeDesignation(TaxonNameBase typeSpecies, Reference citation, String citationMicroReference, String originalNameString, NameTypeDesignationStatus status, boolean isRejectedType, boolean isConservedType, boolean isNotDesignated, boolean addToAllHomotypicNames)` Creates and adds a new `name type designation` to this taxon name's set of type designations.
`void`	`addParsingProblem(ParserProblem problem)` Adds a parsing problem to the list of parsing problems
`void`	`addParsingProblems(int problems)`
`void`	`addRelationship(RelationshipBase relation)` Deprecated. to be used by RelationshipBase only
`NameRelationship`	`addRelationshipFromName(TaxonNameBase fromName, NameRelationshipType type, Reference citation, String microCitation, String ruleConsidered)` Creates a new `name relationship` from another taxon name to this taxon name and adds it both to the set of `relations to this taxon name` and to the set of `relations from the other taxon name`.
`NameRelationship`	`addRelationshipFromName(TaxonNameBase fromName, NameRelationshipType type, String ruleConsidered)` Creates a new `name relationship` from another taxon name to this taxon name and adds it both to the set of `relations to this taxon name` and to the set of `relations from the other taxon name`.
`NameRelationship`	`addRelationshipToName(TaxonNameBase toName, NameRelationshipType type, Reference citation, String microCitation, String ruleConsidered)` Creates a new `name relationship` from this taxon name to another taxon name and adds it both to the set of `relations from this taxon name` and to the set of `relations to the other taxon name`.
`void`	`addRelationshipToName(TaxonNameBase toName, NameRelationshipType type, String ruleConsidered)` Creates a new `name relationship` from this taxon name to another taxon name and adds it both to the set of `relations from this taxon name` and to the set of `relations to the other taxon name`.
`void`	`addReplacedSynonym(TaxonNameBase replacedSynonym, Reference citation, String microcitation, String ruleConsidered)` Assigns a taxon name as `replaced synonym` of this taxon name and keeps the nomenclatural rule considered for it.
`SpecimenTypeDesignation`	`addSpecimenTypeDesignation(DerivedUnit typeSpecimen, SpecimenTypeDesignationStatus status, Reference citation, String citationMicroReference, String originalNameString, boolean isNotDesignated, boolean addToAllHomotypicNames)` Creates and adds a new `specimen type designation` to this taxon name's set of type designations.
`void`	`addStatus(NomenclaturalStatus nomStatus)` Adds a new `nomenclatural status` to this taxon name's set of nomenclatural status.
`NomenclaturalStatus`	`addStatus(NomenclaturalStatusType statusType, Reference citation, String microCitation)`
`void`	`addTaxonBase(TaxonBase taxonBase)` Adds a new `taxon base` to the set of taxon bases using this taxon name.
`boolean`	`addTypeDesignation(TypeDesignationBase typeDesignation, boolean addToAllNames)` Adds a `type designation` to `this` taxon name's set of type designations
`static TaxonNameBase`	`castAndDeproxy(ITaxonNameBase interfacedName)` Method to cast a interfaced name to a concrete name.
`static Set<TaxonNameBase>`	`castAndDeproxy(Set<ITaxonNameBase> naminterfacedNames)` Method to cast a set of interfaced names to concrete namex.
`Object`	`clone()` Clones this taxon name.
`int`	`compareToName(TaxonNameBase<?,?> otherName)` This method compares 2 taxon names on it's name titles and caches.
`String`	`computeBasionymAuthorNomenclaturalTitle()` Shortcut.
`String`	`computeCombinationAuthorNomenclaturalTitle()` Shortcut.
`String`	`computeExBasionymAuthorNomenclaturalTitle()` Shortcut.
`String`	`computeExCombinationAuthorNomenclaturalTitle()` Shortcut.
`String`	`generateAuthorship()` Generates and returns a concatenated and formated authorteams string including basionym and combination authors of this non viral taxon name according to the strategy defined in `INonViralNameCacheStrategy`.
`String`	`generateFullTitle()`
`protected String`	`generateNameCache()` Generates the composed name string of this non viral taxon name without author strings or year according to the strategy defined in `INonViralNameCacheStrategy`.
`String`	`getAcronym()` Returns the accepted acronym (an assigned abbreviation) string for this viral taxon name.
`protected Map<String,Field>`	`getAllFields()`
`String`	`getAppendedPhrase()` Returns the appended phrase string assigned to this taxon name.
`String`	`getAuthorshipCache()` Returns the concatenated and formated authorteams string including basionym and combination authors of this non viral taxon name.
`TaxonNameBase`	`getBasionym()` Returns the taxon name which is the `basionym` of this taxon name.
`TeamOrPersonBase<?>`	`getBasionymAuthorship()` Returns the `author (team)` that published the original combination on which this non viral taxon name is nomenclaturally based.
`Set<TaxonNameBase>`	`getBasionyms()` Returns the set of taxon names which are the `basionyms` of this taxon name.
`String`	`getBreed()` Returns the breed name string for this animal (zoological taxon name).
`String`	`getCitationString()` Returns the complete string containing the `nomenclatural reference citation` and the `details` assigned to this taxon name.
`TeamOrPersonBase<?>`	`getCombinationAuthorship()` Returns the `author (team)` that published this non viral taxon name.
`String`	`getCultivarName()` Returns the characteristical cultivar name part string assigned to this cultivar taxon name.
`Set<TaxonNameDescription>`	`getDescriptions()` Returns the set of `taxon name descriptions` assigned to this taxon name.
`TeamOrPersonBase<?>`	`getExBasionymAuthorship()` Returns the `author (team)` that contributed to the publication of the original combination this non viral taxon name is based on.
`TeamOrPersonBase<?>`	`getExCombinationAuthorship()` Returns the `author (team)` that contributed to the publication of this non viral taxon name as generally stated by the `combination author (team)` itself. An ex-author(-team) is an author(-team) to whom a taxon name was ascribed although it is not the author(-team) of a valid publication (for instance without the validating description or diagnosis in case of a name for a new taxon).
`String`	`getFullTitleCache()`
`String`	`getGenusOrUninomial()` Returns either the scientific name string (without authorship) for this non viral taxon name if its rank is genus or higher (monomial) or the string for the genus part of it if its `rank` is lower than genus (bi- or trinomial).
`HomotypicalGroup`	`getHomotypicalGroup()` Returns the `homotypical group` to which this taxon name belongs.
`Set<HybridRelationship>`	`getHybridChildRelations()` Returns the set of all `hybrid relationships` in which this taxon name is involved as a `child`.
`Set<HybridRelationship>`	`getHybridParentRelations()` Returns the set of all `hybrid relationships` in which this taxon name is involved as a `parent`.
`String`	`getInfraGenericEpithet()` Returns the genus subdivision epithet string (infrageneric part) for this non viral taxon name if its `rank` is infrageneric (lower than genus and higher than species aggregate: binomial).
`String`	`getInfraSpecificEpithet()` Returns the species subdivision epithet string (infraspecific part) for this non viral taxon name if its `rank` is infraspecific (lower than species: trinomial).
`String`	`getLastNamePart()` Defines the last part of the name.
`String`	`getNameApprobation()` Returns the string representing the reason for the approbation of this bacterial taxon name.
`String`	`getNameCache()` Returns or generates the nameCache (scientific name without author strings and year) string for this non viral taxon name.
`Set<NameRelationship>`	`getNameRelations()` Returns the set of all `name relationships` in which this taxon name is involved.
`Set<NameTypeDesignation>`	`getNameTypeDesignations()` Returns the set of `name type designations` assigned to this taxon name the rank of which must be above "species".
`NomenclaturalCode`	`getNomenclaturalCode()` Returns null as the `nomenclatural code` that governs the construction of this taxon name since there is no specific nomenclatural code defined.
`String`	`getNomenclaturalMicroReference()` Returns the details string of the `nomenclatural reference` assigned to this taxon name.
`INomenclaturalReference`	`getNomenclaturalReference()` Returns the `nomenclatural reference` of this taxon name.
`List<HybridRelationship>`	`getOrderedChildRelationships()` Returns the hybrid child relationships ordered by relationship type, or if equal by title cache of the related names.
`Integer`	`getOriginalPublicationYear()` Returns the publication year (as an integer) of the original validly published species epithet for this zoological taxon name.
`int`	`getParsingProblem()` Returns an integer value indicating whether the used parser method was able to parse a string successfully into this object (`0`) or not (`!=0`).
`List<ParserProblem>`	`getParsingProblems()` Returns the parsing problems
`int`	`getProblemEnds()` Returns the integer value of the position where a parsing problem ends.
`int`	`getProblemStarts()` Returns the integer value of the position where a parsing problem starts.
`Integer`	`getPublicationYear()` Returns the publication year (as an integer) for this zoological taxon name.
`Rank`	`getRank()` Returns the taxonomic `rank` of this taxon name.
`String`	`getReferenceYear()` Returns the string containing the publication date (generally only year) of the `nomenclatural reference` for this taxon name, null if there is no nomenclatural reference.
`Set<NameRelationship>`	`getRelationsFromThisName()` Returns the set of all `name relationships` in which this taxon name is involved as a source ("from"-side).
`Set<NameRelationship>`	`getRelationsToThisName()` Returns the set of all `name relationships` in which this taxon name is involved as a target ("to"-side).
`Set<TaxonNameBase>`	`getReplacedSynonyms()` Returns the set of taxon names which are the `replaced synonyms` of this taxon name.
`String`	`getSpecificEpithet()` Returns the species epithet string for this non viral taxon name if its `rank` is species aggregate or lower (bi- or trinomial).
`Set<SpecimenTypeDesignation>`	`getSpecimenTypeDesignations()` Returns the set of `specimen type designations` that typify this taxon name.
`Set<SpecimenTypeDesignation>`	`getSpecimenTypeDesignationsOfHomotypicalGroup()` Returns the set of `specimen type designations` assigned to this taxon name.
`Set<NomenclaturalStatus>`	`getStatus()` Returns the set of `nomenclatural status` assigned to this taxon name according to its corresponding nomenclature code.
`String`	`getSubGenusAuthorship()` Returns the string containing the authorship with the year and details of the reference in which the subgenus included in the scientific name of this bacterial taxon name was published.
`Set<Synonym>`	`getSynonyms()` Returns the set of `(junior) synonyms` (according to any reference) that are based on this taxon name.
`List<TaggedText>`	`getTaggedName()`
`Set<Taxon>`	`getTaxa()` Returns the set of `taxa` ("accepted/correct" names according to any reference) that are based on this taxon name.
`Set<TaxonBase>`	`getTaxonBases()` Returns the set of `taxon bases` that refer to this taxon name.
`String`	`getTitleCache()`
`Set<TypeDesignationBase>`	`getTypeDesignations()` Returns the set of `type designations` assigned to this taxon name.
`boolean`	`hasAuthors()` Tests if the given name has any authors.
`boolean`	`hasProblem()` Returns true if any parsing problem (warning or error) exists.
`boolean`	`hasProblem(ParserProblem problem)` Returns true, if the specified problem exists.
`void`	`initListener()` This method was initially added to `CdmBase` to fix #5161.
`boolean`	`isAutonym()` Needs to be implemented by those classes that handle autonyms (e.g.
`boolean`	`isBasionymFor(TaxonNameBase newCombinationName)` Checks whether a basionym relationship exists between fromName and toName.
`boolean`	`isBinomHybrid()` Returns the boolean value of the flag indicating whether this botanical taxon name is the name of an interspecific hybrid (true) or not (false).
`boolean`	`isGenus()` Returns the boolean value indicating whether the taxonomic `rank` of this taxon name is the genus rank (true) or not (false).
`boolean`	`isGroupsBasionym()` Checks whether name is a basionym for ALL names in its homotypical group.
`boolean`	`isHomotypic(TaxonNameBase homoTypicName)` Returns the boolean value indicating whether a given taxon name belongs to the same `homotypical group` as this taxon name (true) or not (false).
`boolean`	`isHybrid()` Computes if this name is a hybrid (hybrid name or hybrid formula).
`boolean`	`isHybridFormula()` Returns the boolean value of the flag indicating whether the name of this botanical taxon name is a hybrid formula (true) or not (false).
`boolean`	`isHybridName()` Computes if this name is a hybrid name.
`boolean`	`isInfraGeneric()` Returns the boolean value indicating whether the taxonomic `rank` of this taxon name is higher than the species rank and lower than the genus rank (true) or not (false).
`boolean`	`isInfraSpecific()` Returns the boolean value indicating whether the taxonomic `rank` of this taxon name is lower than the species rank (true) or not (false).
`boolean`	`isMonomHybrid()` Returns the boolean value of the flag indicating whether this botanical taxon name is the name of an intergeneric hybrid (true) or not (false).
`boolean`	`isOriginalCombination()` Indicates whether this taxon name is a `basionym` or a `replaced synonym` of any other taxon name.
`boolean`	`isProtectedAuthorshipCache()` Returns the boolean value of the flag intended to protect (true) or not (false) the `authorshipCache` (complete authorship string) of this non viral taxon name.
`boolean`	`isProtectedFullTitleCache()`
`boolean`	`isProtectedNameCache()` Returns the boolean value of the flag intended to protect (true) or not (false) the `nameCache` (scientific name without author strings and year) string of this non viral taxon name.
`boolean`	`isReplacedSynonym()` Indicates this taxon name is a `replaced synonym` of any other taxon name.
`boolean`	`isSpecies()` Returns the boolean value indicating whether the taxonomic `rank` of this taxon name is the species rank (true) or not (false).
`boolean`	`isSpeciesAggregate()` Returns true if this name's rank indicates a rank that aggregates species like species aggregates or species groups, false otherwise.
`boolean`	`isSupraGeneric()` Returns the boolean value indicating whether the taxonomic `rank` of this taxon name is higher than the genus rank (true) or not (false).
`boolean`	`isSupraSpecific()` Returns the boolean value indicating whether the taxonomic `rank` of this taxon name is higher than the species rank (true) or not (false).
`boolean`	`isTrinomHybrid()` Returns the boolean value of the flag indicating whether this botanical taxon name is the name of an infraspecific hybrid (true) or not (false).
`void`	`makeGroupsBasionym()` Creates a basionym relationship to all other names in this names homotypical group.
`void`	`mergeHomotypicGroups(TaxonNameBase name)`
`void`	`removeAsGroupsBasionym()` Removes basionym relationship between this name and each name in its homotypic group.
`void`	`removeBasionyms()` Removes the `basionym` `relationship` from the set of `name relationships to` this taxon name.
`void`	`removeDescription(TaxonNameDescription description)` Removes one element from the set of `taxon name descriptions` assigned to this taxon name.
`void`	`removeHybridChild(INonViralName child)`
`void`	`removeHybridParent(INonViralName parent)`
`void`	`removeHybridRelationship(HybridRelationship hybridRelation)` Removes one `hybrid relationship` from the set of `hybrid relationships` in which this botanical taxon name is involved.
`void`	`removeNameRelationship(NameRelationship nameRelation)` Removes one `name relationship` from one of both sets of `name relationships` in which this taxon name is involved.
`void`	`removeParsingProblem(ParserProblem problem)` Removes a parsing problem from the list of parsing problems.
`void`	`removeRelationToTaxonName(TaxonNameBase toTaxonName)`
`void`	`removeStatus(NomenclaturalStatus nomStatus)` Removes one element from the set of nomenclatural status of this taxon name.
`void`	`removeTaxonBase(TaxonBase taxonBase)` Removes one element from the set of `taxon bases` that refer to this taxon name.
`void`	`removeTypeDesignation(TypeDesignationBase typeDesignation)` Removes one element from the set of `type designations` assigned to this taxon name.
`void`	`setAcronym(String acronym)`
`void`	`setAppendedPhrase(String appendedPhrase)`
`void`	`setAsGroupsBasionym()` Creates a basionym relationship between this name and each name in its homotypic group.
`void`	`setAuthorshipCache(String authorshipCache)` Assigns an authorshipCache string to this non viral taxon name.
`void`	`setAuthorshipCache(String authorshipCache, boolean protectedAuthorshipCache)` Assigns an authorshipCache string to this non viral taxon name.
`void`	`setBasionymAuthorship(TeamOrPersonBase<?> basionymAuthorship)`
`void`	`setBinomHybrid(boolean binomHybrid)`
`void`	`setBreed(String breed)`
`void`	`setCombinationAuthorship(TeamOrPersonBase<?> combinationAuthorship)`
`void`	`setCultivarName(String cultivarName)`
`void`	`setExBasionymAuthorship(TeamOrPersonBase<?> exBasionymAuthorship)`
`void`	`setExCombinationAuthorship(TeamOrPersonBase<?> exCombinationAuthorship)`
`void`	`setFullTitleCache(String fullTitleCache)`
`void`	`setFullTitleCache(String fullTitleCache, boolean protectCache)`
`void`	`setGenusOrUninomial(String genusOrUninomial)`
`void`	`setHomotypicalGroup(HomotypicalGroup homotypicalGroup)`
`void`	`setHybridFormula(boolean hybridFormula)`
`void`	`setInfraGenericEpithet(String infraGenericEpithet)`
`void`	`setInfraSpecificEpithet(String infraSpecificEpithet)`
`void`	`setMonomHybrid(boolean monomHybrid)`
`void`	`setNameApprobation(String nameApprobation)`
`void`	`setNameCache(String nameCache)` Assigns a nameCache string to this non viral taxon name and protects it from being overwritten.
`void`	`setNameCache(String nameCache, boolean protectedNameCache)` Assigns a nameCache string to this non viral taxon name and protects it from being overwritten.
`void`	`setNomenclaturalMicroReference(String nomenclaturalMicroReference)`
`void`	`setNomenclaturalReference(INomenclaturalReference nomenclaturalReference)` Assigns a `nomenclatural reference` to this taxon name.
`void`	`setOriginalPublicationYear(Integer originalPublicationYear)`
`void`	`setParsingProblem(int parsingProblem)`
`void`	`setProblemEnds(int end)`
`void`	`setProblemStarts(int start)`
`void`	`setProtectedAuthorshipCache(boolean protectedAuthorshipCache)`
`void`	`setProtectedFullTitleCache(boolean protectedFullTitleCache)`
`void`	`setProtectedNameCache(boolean protectedNameCache)`
`void`	`setPublicationYear(Integer publicationYear)`
`void`	`setRank(Rank rank)`
`void`	`setSpecificEpithet(String specificEpithet)`
`void`	`setSubGenusAuthorship(String subGenusAuthorship)`
`void`	`setTitleCache(String titleCache, boolean protectCache)` Sets the title cache. NOTE: In most cases the `protectCache` argument should be set to `true`.
`void`	`setTrinomHybrid(boolean trinomHybrid)`

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
cloneLanguageString, equals, getUpdated, getUpdatedBy, setUpdated, setUpdatedBy

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface eu.etaxonomy.cdm.model.common.IIdentifiableEntity
addCredit, addCredit, addExtension, addExtension, addIdentifier, addIdentifier, addIdentifier, addRights, generateTitle, getCredits, getCredits, getData, getExtensions, getIdentifiers, getLsid, getRights, isProtectedTitleCache, removeCredit, removeCredit, removeExtension, removeIdentifier, removeIdentifier, removeRights, removeSources, replaceCredit, replaceIdentifier, setLsid, setProtectedTitleCache, setTitleCache, toString

Methods inherited from interface eu.etaxonomy.cdm.model.common.ISourceable
addImportSource, addPrimaryTaxonomicSource, addPrimaryTaxonomicSource, addSource, addSource, addSources, getSources, removeSource

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.IRelated
getUuid

- Field Detail
  - fullTitleCache
```
@NotEmpty(groups=Level2.class)
protected String fullTitleCache
```
  - protectedNameCache
```
protected boolean protectedNameCache
```
  - protectedAuthorshipCache
```
protected boolean protectedAuthorshipCache
```
- Constructor Detail
  - TaxonNameBase
```
protected TaxonNameBase()
```
    Class constructor: creates a new empty taxon name.
    
    See Also:
    
    TaxonNameBase(Rank), TaxonNameBase(HomotypicalGroup), TaxonNameBase(Rank, HomotypicalGroup)
  - TaxonNameBase
```
protected TaxonNameBase(Rank rank)
```
    Class constructor: creates a new taxon name only containing its rank.
    
    Parameters:
    
    rank - the rank to be assigned to this taxon name
    
    See Also:
    
    TaxonNameBase(), TaxonNameBase(HomotypicalGroup), TaxonNameBase(Rank, HomotypicalGroup)
  - TaxonNameBase
```
protected TaxonNameBase(HomotypicalGroup homotypicalGroup)
```
    Class constructor: creates a new taxon name instance only containing its homotypical group. The new taxon name will be also added to the set of taxon names belonging to this homotypical group.
    
    Parameters:
    
    homotypicalGroup - the homotypical group to which this taxon name belongs
    
    See Also:
    
    TaxonNameBase(), TaxonNameBase(Rank), TaxonNameBase(Rank, HomotypicalGroup)
  - TaxonNameBase
```
protected TaxonNameBase(Rank rank,
                        HomotypicalGroup homotypicalGroup)
```
    Class constructor: creates a new taxon name instance only containing its rank and its homotypical group and the default cache strategy. The new taxon name will be also added to the set of taxon names belonging to this homotypical group.
    
    Parameters:
    
    rank - the rank to be assigned to this taxon name
    
    homotypicalGroup - the homotypical group to which this taxon name belongs
    
    See Also:
    
    TaxonNameBase(), TaxonNameBase(Rank), TaxonNameBase(HomotypicalGroup)
  - TaxonNameBase
```
protected TaxonNameBase(Rank rank,
                        String genusOrUninomial,
                        String infraGenericEpithet,
                        String specificEpithet,
                        String infraSpecificEpithet,
                        TeamOrPersonBase combinationAuthorship,
                        INomenclaturalReference nomenclaturalReference,
                        String nomenclMicroRef,
                        HomotypicalGroup homotypicalGroup)
```
    Class constructor: creates a new non viral 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 non viral taxon name instance will be also added to the set of non viral taxon names belonging to this homotypical group.
    
    Parameters:
    
    rank - the rank to be assigned to this non viral taxon name
    
    genusOrUninomial - the string for this non viral 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 non viral taxon name if its rank is lower than genus and higher than species aggregate
    
    specificEpithet - the string for the first epithet of this non viral taxon name if its rank is species aggregate or lower
    
    infraSpecificEpithet - the string for the second epithet of this non viral taxon name if its rank is lower than species
    
    combinationAuthorship - the author or the team who published this non viral taxon name
    
    nomenclaturalReference - the nomenclatural reference where this non viral taxon name was published
    
    nomenclMicroRef - the string with the details for precise location within the nomenclatural reference
    
    homotypicalGroup - the homotypical group to which this non viral taxon name belongs
    
    See Also:
    
    #NonViralName(), #NonViralName(Rank, HomotypicalGroup), #NewInstance(Rank, HomotypicalGroup), INonViralNameCacheStrategy, INameCacheStrategy, IIdentifiableEntityCacheStrategy
- Method Detail
  - initListener
```
public void initListener()
```
    Description copied from class: CdmBase
    
    This method was initially added to CdmBase to fix #5161. It can be overridden by subclasses such as IdentifiableEntity to explicitly initialize listeners. This is needed e.g. after de-serialization as listeners are not serialized due to the @Transient annotation. However, it can be generally used for other use-cases as well
    
    Overrides:
    
    initListener in class IdentifiableEntity<S extends INameCacheStrategy>
  - getAllFields
```
protected Map<String,Field> getAllFields()
```
  - isProtectedNameCache
```
public boolean isProtectedNameCache()
```
    Returns the boolean value of the flag intended to protect (true) or not (false) the nameCache (scientific name without author strings and year) string of this non viral taxon name.
    
    Specified by:
    
    isProtectedNameCache in interface INonViralName
    
    Returns:
    
    the boolean value of the protectedNameCache flag
    
    See Also:
    
    getNameCache()
  - setProtectedNameCache
```
public void setProtectedNameCache(boolean protectedNameCache)
```
    Specified by:
    
    setProtectedNameCache in interface INonViralName
    
    See Also:
    
    isProtectedNameCache()
  - getGenusOrUninomial
```
public String getGenusOrUninomial()
```
    Returns either the scientific name string (without authorship) for this non viral taxon name if its rank is genus or higher (monomial) or the string for the genus part of it if its rank is lower than genus (bi- or trinomial). Genus or uninomial strings begin with an upper case letter.
    
    Specified by:
    
    getGenusOrUninomial in interface INonViralName
    
    Returns:
    
    the string containing the suprageneric name, the genus name or the genus part of this non viral taxon name
    
    See Also:
    
    getNameCache()
  - setGenusOrUninomial
```
public void setGenusOrUninomial(String genusOrUninomial)
```
    Specified by:
    
    setGenusOrUninomial in interface INonViralName
    
    See Also:
    
    getGenusOrUninomial()
  - getInfraGenericEpithet
```
public String getInfraGenericEpithet()
```
    Returns the genus subdivision epithet string (infrageneric part) for this non viral taxon name if its rank is infrageneric (lower than genus and higher than species aggregate: binomial). Genus subdivision epithet strings begin with an upper case letter.
    
    Specified by:
    
    getInfraGenericEpithet in interface INonViralName
    
    Returns:
    
    the string containing the infrageneric part of this non viral taxon name
    
    See Also:
    
    getNameCache()
  - setInfraGenericEpithet
```
public void setInfraGenericEpithet(String infraGenericEpithet)
```
    Specified by:
    
    setInfraGenericEpithet in interface INonViralName
    
    See Also:
    
    getInfraGenericEpithet()
  - getSpecificEpithet
```
public String getSpecificEpithet()
```
    Returns the species epithet string for this non viral taxon name if its rank is species aggregate or lower (bi- or trinomial). Species epithet strings begin with a lower case letter.
    
    Specified by:
    
    getSpecificEpithet in interface INonViralName
    
    Returns:
    
    the string containing the species epithet of this non viral taxon name
    
    See Also:
    
    getNameCache()
  - setSpecificEpithet
```
public void setSpecificEpithet(String specificEpithet)
```
    Specified by:
    
    setSpecificEpithet in interface INonViralName
    
    See Also:
    
    getSpecificEpithet()
  - getInfraSpecificEpithet
```
public String getInfraSpecificEpithet()
```
    Returns the species subdivision epithet string (infraspecific part) for this non viral taxon name if its rank is infraspecific (lower than species: trinomial). Species subdivision epithet strings begin with a lower case letter.
    
    Specified by:
    
    getInfraSpecificEpithet in interface INonViralName
    
    Returns:
    
    the string containing the infraspecific part of this non viral taxon name
    
    See Also:
    
    getNameCache()
  - setInfraSpecificEpithet
```
public void setInfraSpecificEpithet(String infraSpecificEpithet)
```
    Specified by:
    
    setInfraSpecificEpithet in interface INonViralName
    
    See Also:
    
    getInfraSpecificEpithet()
  - getCombinationAuthorship
```
public TeamOrPersonBase<?> getCombinationAuthorship()
```
    Returns the author (team) that published this non viral taxon name.
    
    Specified by:
    
    getCombinationAuthorship in interface INonViralName
    
    Returns:
    
    the nomenclatural author (team) of this non viral taxon name
    
    See Also:
    
    INomenclaturalAuthor, TeamOrPersonBase.getNomenclaturalTitle()
  - setCombinationAuthorship
```
public void setCombinationAuthorship(TeamOrPersonBase<?> combinationAuthorship)
```
    Specified by:
    
    setCombinationAuthorship in interface INonViralName
    
    See Also:
    
    getCombinationAuthorship()
  - getExCombinationAuthorship
```
public TeamOrPersonBase<?> getExCombinationAuthorship()
```
    Returns the author (team) that contributed to the publication of this non viral taxon name as generally stated by the combination author (team) itself.
    An ex-author(-team) is an author(-team) to whom a taxon name was ascribed although it is not the author(-team) of a valid publication (for instance without the validating description or diagnosis in case of a name for a new taxon). The name of this ascribed authorship, followed by "ex", may be inserted before the name(s) of the publishing author(s) of the validly published name:
    Lilium tianschanicum was described by Grubov (1977) as a new species and its name was ascribed to Ivanova; since there is no indication that Ivanova provided the validating description, the name may be cited as Lilium tianschanicum N. A. Ivanova ex Grubov or Lilium tianschanicum Grubov.
    The presence of an author (team) of this non viral taxon name is a condition for the existence of an ex author (team) for this same name.
    
    Specified by:
    
    getExCombinationAuthorship in interface INonViralName
    
    Returns:
    
    the nomenclatural ex author (team) of this non viral taxon name
    
    See Also:
    
    getCombinationAuthorship(), INomenclaturalAuthor, TeamOrPersonBase.getNomenclaturalTitle()
  - setExCombinationAuthorship
```
public void setExCombinationAuthorship(TeamOrPersonBase<?> exCombinationAuthorship)
```
    Specified by:
    
    setExCombinationAuthorship in interface INonViralName
    
    See Also:
    
    getExCombinationAuthorship()
  - getBasionymAuthorship
```
public TeamOrPersonBase<?> getBasionymAuthorship()
```
    Returns the author (team) that published the original combination on which this non viral taxon name is nomenclaturally based. Such an author (team) can only exist if this non viral taxon name is a new combination due to a taxonomical revision.
    
    Specified by:
    
    getBasionymAuthorship in interface INonViralName
    
    Returns:
    
    the nomenclatural basionym author (team) of this non viral taxon name
    
    See Also:
    
    getCombinationAuthorship(), INomenclaturalAuthor, TeamOrPersonBase.getNomenclaturalTitle()
  - setBasionymAuthorship
```
public void setBasionymAuthorship(TeamOrPersonBase<?> basionymAuthorship)
```
    Specified by:
    
    setBasionymAuthorship in interface INonViralName
    
    See Also:
    
    getBasionymAuthorship()
  - getExBasionymAuthorship
```
public TeamOrPersonBase<?> getExBasionymAuthorship()
```
    Returns the author (team) that contributed to the publication of the original combination this non viral taxon name is based on. This should have been generally stated by the basionym author (team) itself. The presence of a basionym author (team) of this non viral taxon name is a condition for the existence of an ex basionym author (team) for this same name.
    
    Specified by:
    
    getExBasionymAuthorship in interface INonViralName
    
    Returns:
    
    the nomenclatural ex basionym author (team) of this non viral taxon name
    
    See Also:
    
    getBasionymAuthorship(), getExCombinationAuthorship(), getCombinationAuthorship(), INomenclaturalAuthor, TeamOrPersonBase.getNomenclaturalTitle()
  - setExBasionymAuthorship
```
public void setExBasionymAuthorship(TeamOrPersonBase<?> exBasionymAuthorship)
```
    Specified by:
    
    setExBasionymAuthorship in interface INonViralName
    
    See Also:
    
    getExBasionymAuthorship()
  - isProtectedAuthorshipCache
```
public boolean isProtectedAuthorshipCache()
```
    Returns the boolean value of the flag intended to protect (true) or not (false) the authorshipCache (complete authorship string) of this non viral taxon name.
    
    Specified by:
    
    isProtectedAuthorshipCache in interface INonViralName
    
    Returns:
    
    the boolean value of the protectedAuthorshipCache flag
    
    See Also:
    
    getAuthorshipCache()
  - setProtectedAuthorshipCache
```
public void setProtectedAuthorshipCache(boolean protectedAuthorshipCache)
```
    Specified by:
    
    setProtectedAuthorshipCache in interface INonViralName
    
    See Also:
    
    isProtectedAuthorshipCache(), getAuthorshipCache()
  - getHybridParentRelations
```
public Set<HybridRelationship> getHybridParentRelations()
```
    Returns the set of all hybrid relationships in which this taxon name is involved as a parent.
    
    Specified by:
    
    getHybridParentRelations in interface INonViralName
    
    See Also:
    
    #getHybridRelationships(), #getChildRelationships(), HybridRelationshipType
  - getHybridChildRelations
```
public Set<HybridRelationship> getHybridChildRelations()
```
    Returns the set of all hybrid relationships in which this taxon name is involved as a child.
    
    Specified by:
    
    getHybridChildRelations in interface INonViralName
    
    See Also:
    
    #getHybridRelationships(), #getParentRelationships(), HybridRelationshipType
  - isProtectedFullTitleCache
```
public boolean isProtectedFullTitleCache()
```
    Specified by:
    
    isProtectedFullTitleCache in interface ITaxonNameBase
  - setProtectedFullTitleCache
```
public void setProtectedFullTitleCache(boolean protectedFullTitleCache)
```
    Specified by:
    
    setProtectedFullTitleCache in interface ITaxonNameBase
  - isHybridFormula
```
public boolean isHybridFormula()
```
    Returns the boolean value of the flag indicating whether the name of this botanical taxon name is a hybrid formula (true) or not (false). A hybrid named by a hybrid formula (composed with its parent names by placing the multiplication sign between them) does not have an own published name and therefore has neither an autorship nor other name components. If this flag is set no other hybrid flags may be set.
    
    Specified by:
    
    isHybridFormula in interface INonViralName
    
    Returns:
    
    the boolean value of the isHybridFormula flag
    
    See Also:
    
    isMonomHybrid(), isBinomHybrid(), isTrinomHybrid()
  - setHybridFormula
```
public void setHybridFormula(boolean hybridFormula)
```
    Specified by:
    
    setHybridFormula in interface INonViralName
    
    See Also:
    
    isHybridFormula()
  - isMonomHybrid
```
public boolean isMonomHybrid()
```
    Returns the boolean value of the flag indicating whether this botanical taxon name is the name of an intergeneric hybrid (true) or not (false). In this case the multiplication sign is placed before the scientific name. If this flag is set no other hybrid flags may be set.
    
    Specified by:
    
    isMonomHybrid in interface INonViralName
    
    Returns:
    
    the boolean value of the isMonomHybrid flag
    
    See Also:
    
    isHybridFormula(), isBinomHybrid(), isTrinomHybrid()
  - setMonomHybrid
```
public void setMonomHybrid(boolean monomHybrid)
```
    Specified by:
    
    setMonomHybrid in interface INonViralName
    
    See Also:
    
    isMonomHybrid(), isBinomHybrid(), isTrinomHybrid()
  - isBinomHybrid
```
public boolean isBinomHybrid()
```
    Returns the boolean value of the flag indicating whether this botanical taxon name is the name of an interspecific hybrid (true) or not (false). In this case the multiplication sign is placed before the species epithet. If this flag is set no other hybrid flags may be set.
    
    Specified by:
    
    isBinomHybrid in interface INonViralName
    
    Returns:
    
    the boolean value of the isBinomHybrid flag
    
    See Also:
    
    isHybridFormula(), isMonomHybrid(), isTrinomHybrid()
  - setBinomHybrid
```
public void setBinomHybrid(boolean binomHybrid)
```
    Specified by:
    
    setBinomHybrid in interface INonViralName
    
    See Also:
    
    isBinomHybrid(), isMonomHybrid(), isTrinomHybrid()
  - isTrinomHybrid
```
public boolean isTrinomHybrid()
```
    Returns the boolean value of the flag indicating whether this botanical taxon name is the name of an infraspecific hybrid (true) or not (false). In this case the term "notho-" (optionally abbreviated "n-") is used as a prefix to the term denoting the infraspecific rank of this botanical taxon name. If this flag is set no other hybrid flags may be set.
    
    Specified by:
    
    isTrinomHybrid in interface INonViralName
    
    Returns:
    
    the boolean value of the isTrinomHybrid flag
    
    See Also:
    
    isHybridFormula(), isMonomHybrid(), isBinomHybrid()
  - setTrinomHybrid
```
public void setTrinomHybrid(boolean trinomHybrid)
```
    Specified by:
    
    setTrinomHybrid in interface INonViralName
    
    See Also:
    
    isTrinomHybrid(), isBinomHybrid(), isMonomHybrid()
  - getAcronym
```
public String getAcronym()
```
    Returns the accepted acronym (an assigned abbreviation) string for this viral taxon name. For instance PCV stays for Peanut Clump Virus.
    
    Specified by:
    
    getAcronym in interface IViralName
    
    Returns:
    
    the string containing the accepted acronym of this viral taxon name
  - setAcronym
```
public void setAcronym(String acronym)
```
    Specified by:
    
    setAcronym in interface IViralName
    
    See Also:
    
    getAcronym()
  - getSubGenusAuthorship
```
public String getSubGenusAuthorship()
```
    Returns the string containing the authorship with the year and details of the reference in which the subgenus included in the scientific name of this bacterial taxon name was published. For instance if the bacterial taxon name is 'Bacillus (subgen. Aerobacillus Donker 1926, 128) polymyxa' the subgenus authorship string is 'Donker 1926, 128'.
    
    Specified by:
    
    getSubGenusAuthorship in interface IBacterialName
    
    Returns:
    
    the string containing the complete subgenus' authorship included in this bacterial taxon name
  - setSubGenusAuthorship
```
public void setSubGenusAuthorship(String subGenusAuthorship)
```
    Specified by:
    
    setSubGenusAuthorship in interface IBacterialName
    
    See Also:
    
    getSubGenusAuthorship()
  - getNameApprobation
```
public String getNameApprobation()
```
    Returns the string representing the reason for the approbation of this bacterial taxon name. Bacterial taxon names are valid or approved according to:
    - the approved list, c.f.r. IJSB 1980 (AL)
    - the validation list, in IJSB after 1980 (VL)
    or
    - are validly published as paper in IJSB after 1980 (VP).
    IJSB is the acronym for International Journal of Systematic Bacteriology.
    Specified by:
    
    getNameApprobation in interface IBacterialName
    
    Returns:
    
    the string with the source of the approbation for this bacterial taxon name
  - setNameApprobation
```
public void setNameApprobation(String nameApprobation)
```
    Specified by:
    
    setNameApprobation in interface IBacterialName
    
    See Also:
    
    getNameApprobation()
  - getBreed
```
public String getBreed()
```
    Returns the breed name string for this animal (zoological taxon name).
    
    Specified by:
    
    getBreed in interface IZoologicalName
    
    Returns:
    
    the string containing the breed name for this zoological taxon name
  - setBreed
```
public void setBreed(String breed)
```
    Specified by:
    
    setBreed in interface IZoologicalName
    
    See Also:
    
    getBreed()
  - getPublicationYear
```
public Integer getPublicationYear()
```
    Returns the publication year (as an integer) for this zoological taxon name. If the publicationYear attribute is null and a nomenclatural reference exists the year could be computed from the nomenclatural reference.
    
    Specified by:
    
    getPublicationYear in interface IZoologicalName
    
    Returns:
    
    the integer representing the publication year for this zoological taxon name
    
    See Also:
    
    getOriginalPublicationYear()
  - setPublicationYear
```
public void setPublicationYear(Integer publicationYear)
```
    Specified by:
    
    setPublicationYear in interface IZoologicalName
    
    See Also:
    
    getPublicationYear()
  - getOriginalPublicationYear
```
public Integer getOriginalPublicationYear()
```
    Returns the publication year (as an integer) of the original validly published species epithet for this zoological taxon name. This only applies for zoological taxon names that are no original combinations. If the originalPublicationYear attribute is null the year could be taken from the publication year of the corresponding original name (basionym) or from the nomenclatural reference of the basionym if it exists.
    
    Specified by:
    
    getOriginalPublicationYear in interface IZoologicalName
    
    Returns:
    
    the integer representing the publication year of the original species epithet corresponding to this zoological taxon name
    
    See Also:
    
    getPublicationYear()
  - setOriginalPublicationYear
```
public void setOriginalPublicationYear(Integer originalPublicationYear)
```
    Specified by:
    
    setOriginalPublicationYear in interface IZoologicalName
    
    See Also:
    
    getOriginalPublicationYear()
  - getCultivarName
```
public String getCultivarName()
```
    Returns the characteristical cultivar name part string assigned to this cultivar taxon name. In the scientific name "Clematis alpina 'Ruby'" for instance this characteristical string is "Ruby". This part of the name is governed by the International Code for the Nomenclature of Cultivated Plants and the string should include neither quotes nor + signs (these elements of the name cache string will be generated by the default cache strategy).
    
    Specified by:
    
    getCultivarName in interface ICultivarPlantName
  - setCultivarName
```
public void setCultivarName(String cultivarName)
```
    Specified by:
    
    setCultivarName in interface ICultivarPlantName
    
    See Also:
    
    getCultivarName()
  - addHybridRelationship
```
protected void addHybridRelationship(HybridRelationship rel)
```
    Adds the given hybrid relationship to the set of hybrid relationships of both non-viral names involved in this hybrid relationship. One of both non-viral names must be this non-viral name otherwise no addition will be carried out. The child non viral taxon name must be a hybrid, which means that one of its four hybrid flags must be set.
    
    Parameters:
    
    relationship - the hybrid relationship to be added
    
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    isHybridFormula(), isMonomHybrid(), isBinomHybrid(), isTrinomHybrid(), #getHybridRelationships(), #getParentRelationships(), #getChildRelationships(), addRelationship(RelationshipBase)
  - removeHybridRelationship
```
public void removeHybridRelationship(HybridRelationship hybridRelation)
```
    Removes one hybrid relationship from the set of hybrid relationships in which this botanical taxon name is involved. The hybrid relationship will also be removed from the set belonging to the second botanical taxon name involved.
    
    Specified by:
    
    removeHybridRelationship in interface INonViralName
    
    Parameters:
    
    relationship - the hybrid relationship which should be deleted from the corresponding sets
    
    See Also:
    
    #getHybridRelationships()
  - generateFullTitle
```
public String generateFullTitle()
```
    Specified by:
    
    generateFullTitle in interface ITaxonNameBase
  - setFullTitleCache
```
public void setFullTitleCache(String fullTitleCache)
```
    Specified by:
    
    setFullTitleCache in interface ITaxonNameBase
  - setFullTitleCache
```
public void setFullTitleCache(String fullTitleCache,
                              boolean protectCache)
```
    Specified by:
    
    setFullTitleCache in interface ITaxonNameBase
  - isAutonym
```
public boolean isAutonym()
```
    Needs to be implemented by those classes that handle autonyms (e.g. botanical names).
    
    Specified by:
    
    isAutonym in interface INonViralName
  - getTaggedName
```
public List<TaggedText> getTaggedName()
```
    Specified by:
    
    getTaggedName in interface ITaxonNameBase
  - getFullTitleCache
```
public String getFullTitleCache()
```
    Specified by:
    
    getFullTitleCache in interface ITaxonNameBase
  - getTitleCache
```
public String getTitleCache()
```
    Specified by:
    
    getTitleCache in interface IIdentifiableEntity
    
    Overrides:
    
    getTitleCache in class IdentifiableEntity<S extends INameCacheStrategy>
  - setTitleCache
```
public void setTitleCache(String titleCache,
                          boolean protectCache)
```
    Description copied from interface: IIdentifiableEntity
    
    Sets the title cache.
    NOTE: In most cases the protectCache argument should be set to true. See comments at IIdentifiableEntity.setTitleCache(String)
    
    Specified by:
    
    setTitleCache in interface IIdentifiableEntity
    
    Overrides:
    
    setTitleCache in class IdentifiableEntity<S extends INameCacheStrategy>
    
    Parameters:
    
    titleCache - the new title cache
    
    protectCache - the protect flag, should in most cases be set to true
  - getAuthorshipCache
```
public String getAuthorshipCache()
```
    Returns the concatenated and formated authorteams string including basionym and combination authors of this non viral taxon name. If the protectedAuthorshipCache flag is set this method returns the string stored in the the authorshipCache attribute, otherwise it generates the complete authorship string, returns it and stores it in the authorshipCache attribute.
    
    Specified by:
    
    getAuthorshipCache in interface INonViralName
    
    Returns:
    
    the string with the concatenated and formated authorteams for this non viral taxon name
    
    See Also:
    
    generateAuthorship()
  - setAuthorshipCache
```
public void setAuthorshipCache(String authorshipCache)
```
    Assigns an authorshipCache string to this non viral taxon name. Sets the isProtectedAuthorshipCache flag to true.
    
    Specified by:
    
    setAuthorshipCache in interface INonViralName
    
    Parameters:
    
    authorshipCache - the string which identifies the complete authorship of this non viral taxon name
    
    See Also:
    
    getAuthorshipCache()
  - setAuthorshipCache
```
public void setAuthorshipCache(String authorshipCache,
                               boolean protectedAuthorshipCache)
```
    Assigns an authorshipCache string to this non viral taxon name.
    
    Specified by:
    
    setAuthorshipCache in interface INonViralName
    
    Parameters:
    
    authorshipCache - the string which identifies the complete authorship of this non viral taxon name
    
    protectedAuthorshipCache - if true the isProtectedAuthorshipCache flag is set to true, otherwise the flag is set to false.
    
    See Also:
    
    getAuthorshipCache()
  - generateAuthorship
```
public String generateAuthorship()
```
    Generates and returns a concatenated and formated authorteams string including basionym and combination authors of this non viral taxon name according to the strategy defined in INonViralNameCacheStrategy.
    
    Specified by:
    
    generateAuthorship in interface INonViralName
    
    Returns:
    
    the string with the concatenated and formatted author teams for this taxon name
    
    See Also:
    
    eu.etaxonomy.cdm.strategy.cache.name.INonViralNameCacheStrategy#getAuthorshipCache(TaxonNameBase)
  - hasAuthors
```
public boolean hasAuthors()
```
    Tests if the given name has any authors.
    
    Specified by:
    
    hasAuthors in interface INonViralName
    
    Returns:
    
    false if no author ((ex)combination or (ex)basionym) exists, true otherwise
  - computeCombinationAuthorNomenclaturalTitle
```
public String computeCombinationAuthorNomenclaturalTitle()
```
    Shortcut. Returns the combination authors title cache. Returns null if no combination author exists.
    
    Specified by:
    
    computeCombinationAuthorNomenclaturalTitle in interface INonViralName
    
    Returns:
  - computeBasionymAuthorNomenclaturalTitle
```
public String computeBasionymAuthorNomenclaturalTitle()
```
    Shortcut. Returns the basionym authors title cache. Returns null if no basionym author exists.
    
    Specified by:
    
    computeBasionymAuthorNomenclaturalTitle in interface INonViralName
    
    Returns:
  - computeExCombinationAuthorNomenclaturalTitle
```
public String computeExCombinationAuthorNomenclaturalTitle()
```
    Shortcut. Returns the ex-combination authors title cache. Returns null if no ex-combination author exists.
    
    Specified by:
    
    computeExCombinationAuthorNomenclaturalTitle in interface INonViralName
    
    Returns:
  - computeExBasionymAuthorNomenclaturalTitle
```
public String computeExBasionymAuthorNomenclaturalTitle()
```
    Shortcut. Returns the ex-basionym authors title cache. Returns null if no exbasionym author exists.
    
    Specified by:
    
    computeExBasionymAuthorNomenclaturalTitle in interface INonViralName
    
    Returns:
  - getNameRelations
```
public Set<NameRelationship> getNameRelations()
```
    Returns the set of all name relationships in which this taxon name is involved. A taxon name can be both source in some name relationships or target in some others.
    
    Specified by:
    
    getNameRelations in interface ITaxonNameBase
    
    See Also:
    
    getRelationsToThisName(), getRelationsFromThisName(), addNameRelationship(NameRelationship), addRelationshipToName(TaxonNameBase, NameRelationshipType, String), addRelationshipFromName(TaxonNameBase, NameRelationshipType, String)
  - addRelationshipToName
```
public void addRelationshipToName(TaxonNameBase toName,
                                  NameRelationshipType type,
                                  String ruleConsidered)
```
    Creates a new name relationship from this taxon name to another taxon name and adds it both to the set of relations from this taxon name and to the set of relations to the other taxon name.
    
    Specified by:
    
    addRelationshipToName in interface ITaxonNameBase
    
    Parameters:
    
    toName - the taxon name of the target for this new name relationship
    
    type - the type of this new name relationship
    
    ruleConsidered - the string which specifies the rule on which this name relationship is based
    
    See Also:
    
    getRelationsToThisName(), getNameRelations(), addRelationshipFromName(TaxonNameBase, NameRelationshipType, String), addNameRelationship(NameRelationship)
  - addRelationshipToName
```
public NameRelationship addRelationshipToName(TaxonNameBase toName,
                                              NameRelationshipType type,
                                              Reference citation,
                                              String microCitation,
                                              String ruleConsidered)
```
    Creates a new name relationship from this taxon name to another taxon name and adds it both to the set of relations from this taxon name and to the set of relations to the other taxon name.
    
    Specified by:
    
    addRelationshipToName in interface ITaxonNameBase
    
    Parameters:
    
    toName - the taxon name of the target for this new name relationship
    
    type - the type of this new name relationship
    
    ruleConsidered - the string which specifies the rule on which this name relationship is based
    
    Returns:
    
    See Also:
    
    getRelationsToThisName(), getNameRelations(), addRelationshipFromName(TaxonNameBase, NameRelationshipType, String), addNameRelationship(NameRelationship)
  - addRelationshipFromName
```
public NameRelationship addRelationshipFromName(TaxonNameBase fromName,
                                                NameRelationshipType type,
                                                String ruleConsidered)
```
    Creates a new name relationship from another taxon name to this taxon name and adds it both to the set of relations to this taxon name and to the set of relations from the other taxon name.
    
    Specified by:
    
    addRelationshipFromName in interface ITaxonNameBase
    
    Parameters:
    
    fromName - the taxon name of the source for this new name relationship
    
    type - the type of this new name relationship
    
    ruleConsidered - the string which specifies the rule on which this name relationship is based
    
    citation - the reference in which this relation was described
    
    microCitation - the reference detail for this relation (e.g. page)
    
    See Also:
    
    getRelationsFromThisName(), getNameRelations(), addRelationshipToName(TaxonNameBase, NameRelationshipType, String), addNameRelationship(NameRelationship)
  - addRelationshipFromName
```
public NameRelationship addRelationshipFromName(TaxonNameBase fromName,
                                                NameRelationshipType type,
                                                Reference citation,
                                                String microCitation,
                                                String ruleConsidered)
```
    Creates a new name relationship from another taxon name to this taxon name and adds it both to the set of relations to this taxon name and to the set of relations from the other taxon name.
    
    Specified by:
    
    addRelationshipFromName in interface ITaxonNameBase
    
    Parameters:
    
    fromName - the taxon name of the source for this new name relationship
    
    type - the type of this new name relationship
    
    ruleConsidered - the string which specifies the rule on which this name relationship is based
    
    citation - the reference in which this relation was described
    
    microCitation - the reference detail for this relation (e.g. page)
    
    See Also:
    
    getRelationsFromThisName(), getNameRelations(), addRelationshipToName(TaxonNameBase, NameRelationshipType, String), addNameRelationship(NameRelationship)
  - addNameRelationship
```
protected void addNameRelationship(NameRelationship rel)
```
    Adds an existing name relationship either to the set of relations to this taxon name or to the set of relations from this taxon name. If neither the source nor the target of the name relationship match with this taxon name no addition will be carried out.
    
    Parameters:
    
    rel - the name relationship to be added to one of this taxon name's name relationships sets
    
    See Also:
    
    getNameRelations(), addRelationshipToName(TaxonNameBase, NameRelationshipType, String), addRelationshipFromName(TaxonNameBase, NameRelationshipType, String)
  - removeNameRelationship
```
public void removeNameRelationship(NameRelationship nameRelation)
```
    Removes one name relationship from one of both sets of name relationships in which this taxon name is involved. The name relationship will also be removed from one of both sets belonging to the second taxon name involved. Furthermore the fromName and toName attributes of the name relationship object will be nullified.
    
    Specified by:
    
    removeNameRelationship in interface ITaxonNameBase
    
    Parameters:
    
    nameRelation - the name relationship which should be deleted from one of both sets
    
    See Also:
    
    getNameRelations()
  - removeRelationToTaxonName
```
public void removeRelationToTaxonName(TaxonNameBase toTaxonName)
```
    Specified by:
    
    removeRelationToTaxonName in interface ITaxonNameBase
  - addRelationship
```
@Deprecated
public void addRelationship(RelationshipBase relation)
```
    Deprecated. to be used by RelationshipBase only
    
    If relation is of type NameRelationship, addNameRelationship is called; if relation is of type HybridRelationship addHybridRelationship is called, otherwise an IllegalArgumentException is thrown.
    
    Specified by:
    
    addRelationship in interface IRelated
    
    Parameters:
    
    relation - the relationship to be added to one of this taxon name's name relationships sets
    
    See Also:
    
    addNameRelationship(NameRelationship), getNameRelations(), NameRelationship, RelationshipBase, addHybridRelationship(HybridRelationship)
  - getRelationsFromThisName
```
public Set<NameRelationship> getRelationsFromThisName()
```
    Returns the set of all name relationships in which this taxon name is involved as a source ("from"-side).
    
    Specified by:
    
    getRelationsFromThisName in interface ITaxonNameBase
    
    See Also:
    
    getNameRelations(), getRelationsToThisName(), addRelationshipFromName(TaxonNameBase, NameRelationshipType, String)
  - getRelationsToThisName
```
public Set<NameRelationship> getRelationsToThisName()
```
    Returns the set of all name relationships in which this taxon name is involved as a target ("to"-side).
    
    Specified by:
    
    getRelationsToThisName in interface ITaxonNameBase
    
    See Also:
    
    getNameRelations(), getRelationsFromThisName(), addRelationshipToName(TaxonNameBase, NameRelationshipType, String)
  - getStatus
```
public Set<NomenclaturalStatus> getStatus()
```
    Returns the set of nomenclatural status assigned to this taxon name according to its corresponding nomenclature code. This includes the type of the nomenclatural status and the nomenclatural code rule considered.
    
    Specified by:
    
    getStatus in interface ITaxonNameBase
    
    See Also:
    
    NomenclaturalStatus, NomenclaturalStatusType
  - addStatus
```
public void addStatus(NomenclaturalStatus nomStatus)
```
    Adds a new nomenclatural status to this taxon name's set of nomenclatural status.
    
    Specified by:
    
    addStatus in interface ITaxonNameBase
    
    Parameters:
    
    nomStatus - the nomenclatural status to be added
    
    See Also:
    
    getStatus()
  - addStatus
```
public NomenclaturalStatus addStatus(NomenclaturalStatusType statusType,
                                     Reference citation,
                                     String microCitation)
```
    Specified by:
    
    addStatus in interface ITaxonNameBase
  - removeStatus
```
public void removeStatus(NomenclaturalStatus nomStatus)
```
    Removes one element from the set of nomenclatural status of this taxon name. Type and ruleConsidered attributes of the nomenclatural status object will be nullified.
    
    Specified by:
    
    removeStatus in interface ITaxonNameBase
    
    Parameters:
    
    nomStatus - the nomenclatural status of this taxon name which should be deleted
    
    See Also:
    
    getStatus()
  - generateNameCache
```
protected String generateNameCache()
```
    Generates the composed name string of this non viral taxon name without author strings or year according to the strategy defined in INonViralNameCacheStrategy. The result might be stored in nameCache if the flag protectedNameCache is not set.
    
    Returns:
    
    the string with the composed name of this non viral taxon name without authors or year
    
    See Also:
    
    getNameCache()
  - getNameCache
```
public String getNameCache()
```
    Returns or generates the nameCache (scientific name without author strings and year) string for this non viral taxon name. If the protectedNameCache flag is not set (False) the string will be generated according to a defined strategy, otherwise the value of the actual nameCache string will be returned.
    
    Specified by:
    
    getNameCache in interface INonViralName
    
    Returns:
    
    the string which identifies this non viral taxon name (without authors or year)
    
    See Also:
    
    generateNameCache()
  - setNameCache
```
public void setNameCache(String nameCache)
```
    Assigns a nameCache string to this non viral taxon name and protects it from being overwritten. Sets the protectedNameCache flag to true.
    
    Specified by:
    
    setNameCache in interface INonViralName
    
    Parameters:
    
    nameCache - the string which identifies this non viral taxon name (without authors or year)
    
    See Also:
    
    getNameCache()
  - setNameCache
```
public void setNameCache(String nameCache,
                         boolean protectedNameCache)
```
    Assigns a nameCache string to this non viral taxon name and protects it from being overwritten. Sets the protectedNameCache flag to true.
    
    Specified by:
    
    setNameCache in interface INonViralName
    
    Parameters:
    
    nameCache - the string which identifies this non viral taxon name (without authors or year)
    
    protectedNameCache - if true teh protectedNameCache is set to true or otherwise set to false
    
    See Also:
    
    getNameCache()
  - isOriginalCombination
```
public boolean isOriginalCombination()
```
    Indicates whether this taxon name is a basionym or a replaced synonym of any other taxon name. Returns "true", if a basionym or a replaced synonym relationship from this taxon name to another taxon name exists, false otherwise (also in case this taxon name is the only one in the homotypical group).
    
    Specified by:
    
    isOriginalCombination in interface ITaxonNameBase
  - isReplacedSynonym
```
public boolean isReplacedSynonym()
```
    Indicates this taxon name is a replaced synonym of any other taxon name. Returns "true", if a replaced synonym relationship from this taxon name to another taxon name exists, false otherwise (also in case this taxon name is the only one in the homotypical group).
    
    Specified by:
    
    isReplacedSynonym in interface ITaxonNameBase
  - getBasionym
```
public TaxonNameBase getBasionym()
```
    Returns the taxon name which is the basionym of this taxon name. The basionym of a taxon name is its epithet-bringing synonym. For instance Pinus abies L. was published by Linnaeus and the botanist Karsten transferred later this taxon to the genus Picea. Therefore, Pinus abies L. is the basionym of the new combination Picea abies (L.) H. Karst. If more than one basionym exists one is choosen at radom. If no basionym exists null is returned.
    
    Specified by:
    
    getBasionym in interface ITaxonNameBase
  - getBasionyms
```
public Set<TaxonNameBase> getBasionyms()
```
    Returns the set of taxon names which are the basionyms of this taxon name. The basionym of a taxon name is its epithet-bringing synonym. For instance Pinus abies L. was published by Linnaeus and the botanist Karsten transferred later this taxon to the genus Picea. Therefore, Pinus abies L. is the basionym of the new combination Picea abies (L.) H. Karst.
    
    Specified by:
    
    getBasionyms in interface ITaxonNameBase
  - addBasionym
```
public void addBasionym(TaxonNameBase basionym)
```
    Assigns a taxon name as basionym of this taxon name. The basionym relationship will be added to this taxon name and to the basionym. The basionym cannot have itself a basionym. The homotypical groups of this taxon name and of the basionym will be merged.
    
    Specified by:
    
    addBasionym in interface ITaxonNameBase
    
    Parameters:
    
    basionym - the taxon name to be set as the basionym of this taxon name
    
    See Also:
    
    getBasionym(), #addBasionym(TaxonNameBase, String)
  - addBasionym
```
public NameRelationship addBasionym(TaxonNameBase basionym,
                                    Reference citation,
                                    String microcitation,
                                    String ruleConsidered)
```
    Assigns a taxon name as basionym of this taxon name and keeps the nomenclatural rule considered for it. The basionym relationship will be added to this taxon name and to the basionym. The basionym cannot have itself a basionym. The homotypical groups of this taxon name and of the basionym will be merged.
    
    Specified by:
    
    addBasionym in interface ITaxonNameBase
    
    Parameters:
    
    basionym - the taxon name to be set as the basionym of this taxon name
    
    ruleConsidered - the string identifying the nomenclatural rule
    
    Returns:
    
    See Also:
    
    getBasionym(), addBasionym(TaxonNameBase)
  - getReplacedSynonyms
```
public Set<TaxonNameBase> getReplacedSynonyms()
```
    Returns the set of taxon names which are the replaced synonyms of this taxon name.
    
    Specified by:
    
    getReplacedSynonyms in interface ITaxonNameBase
  - addReplacedSynonym
```
public void addReplacedSynonym(TaxonNameBase replacedSynonym,
                               Reference citation,
                               String microcitation,
                               String ruleConsidered)
```
    Assigns a taxon name as replaced synonym of this taxon name and keeps the nomenclatural rule considered for it. The replaced synonym relationship will be added to this taxon name and to the replaced synonym. The homotypical groups of this taxon name and of the replaced synonym will be merged.
    
    Specified by:
    
    addReplacedSynonym in interface ITaxonNameBase
    
    Parameters:
    
    basionym - the taxon name to be set as the basionym of this taxon name
    
    ruleConsidered - the string identifying the nomenclatural rule
    
    See Also:
    
    getBasionym(), addBasionym(TaxonNameBase)
  - removeBasionyms
```
public void removeBasionyms()
```
    Removes the basionym relationship from the set of name relationships to this taxon name. The same relationhip will be removed from the set of name relationships from the taxon name previously used as basionym.
    
    Specified by:
    
    removeBasionyms in interface ITaxonNameBase
    
    See Also:
    
    getBasionym(), addBasionym(TaxonNameBase)
  - getRank
```
public Rank getRank()
```
    Returns the taxonomic rank of this taxon name.
    
    Specified by:
    
    getRank in interface ITaxonNameBase
    
    See Also:
    
    Rank
  - setRank
```
public void setRank(Rank rank)
```
    Specified by:
    
    setRank in interface ITaxonNameBase
    
    See Also:
    
    getRank()
  - getNomenclaturalReference
```
public INomenclaturalReference getNomenclaturalReference()
```
    Returns the nomenclatural reference of this taxon name. The nomenclatural reference is here meant to be the one publication this taxon name was originally published in while fulfilling the formal requirements as specified by the corresponding nomenclatural code.
    
    Specified by:
    
    getNomenclaturalReference in interface ITaxonNameBase
    
    See Also:
    
    INomenclaturalReference, Reference
  - setNomenclaturalReference
```
public void setNomenclaturalReference(INomenclaturalReference nomenclaturalReference)
```
    Assigns a nomenclatural reference to this taxon name. The corresponding nomenclaturally relevant flag will be set to true as it is obviously used for nomenclatural purposes.
    
    Specified by:
    
    setNomenclaturalReference in interface ITaxonNameBase
    
    Throws:
    
    IllegalArgumentException - if parameter nomenclaturalReference is not assignable from INomenclaturalReference
    
    See Also:
    
    getNomenclaturalReference()
  - getAppendedPhrase
```
public String getAppendedPhrase()
```
    Returns the appended phrase string assigned to this taxon name. The appended phrase is a non-atomised addition to a name. It is not ruled by a nomenclatural code.
    
    Specified by:
    
    getAppendedPhrase in interface ITaxonNameBase
  - setAppendedPhrase
```
public void setAppendedPhrase(String appendedPhrase)
```
    Specified by:
    
    setAppendedPhrase in interface ITaxonNameBase
    
    See Also:
    
    getAppendedPhrase()
  - getNomenclaturalMicroReference
```
public String getNomenclaturalMicroReference()
```
    Returns the details string of the nomenclatural reference assigned to this taxon name. The details describe the exact localisation within the publication used as nomenclature reference. These are mostly (implicitly) pages but can also be figures or tables or any other element of a publication. A nomenclatural micro reference (details) requires the existence of a nomenclatural reference.
    
    Specified by:
    
    getNomenclaturalMicroReference in interface ITaxonNameBase
  - setNomenclaturalMicroReference
```
public void setNomenclaturalMicroReference(String nomenclaturalMicroReference)
```
    Specified by:
    
    setNomenclaturalMicroReference in interface ITaxonNameBase
    
    See Also:
    
    getNomenclaturalMicroReference()
  - getParsingProblem
```
public int getParsingProblem()
```
    Description copied from interface: IParsable
    
    Returns an integer value indicating whether the used parser method was able to parse a string successfully into this object (0) or not (!=0). The the parsing was not successful the value returned defines in more detail what the problem was. The definition of these values depends on the parser that has been used for parsing.
    
    Specified by:
    
    getParsingProblem in interface IParsable
    
    Returns:
    
    the int value parsingProblem
  - setParsingProblem
```
public void setParsingProblem(int parsingProblem)
```
    Specified by:
    
    setParsingProblem in interface IParsable
    
    See Also:
    
    IParsable.getParsingProblem()
  - addParsingProblem
```
public void addParsingProblem(ParserProblem problem)
```
    Description copied from interface: IParsable
    
    Adds a parsing problem to the list of parsing problems
    
    Specified by:
    
    addParsingProblem in interface IParsable
  - removeParsingProblem
```
public void removeParsingProblem(ParserProblem problem)
```
    Description copied from interface: IParsable
    
    Removes a parsing problem from the list of parsing problems. If the problem is not in the list or is null, nothing happens.
    
    Specified by:
    
    removeParsingProblem in interface IParsable
  - addParsingProblems
```
public void addParsingProblems(int problems)
```
    Specified by:
    
    addParsingProblems in interface ITaxonNameBase
    
    Parameters:
    
    warnings -
  - hasProblem
```
public boolean hasProblem()
```
    Description copied from interface: IParsable
    
    Returns true if any parsing problem (warning or error) exists.
    
    Specified by:
    
    hasProblem in interface IParsable
    
    See Also:
    
    #getHasProblem()
  - hasProblem
```
public boolean hasProblem(ParserProblem problem)
```
    Description copied from interface: IParsable
    
    Returns true, if the specified problem exists. False otherwise.
    
    Specified by:
    
    hasProblem in interface IParsable
    
    Returns:
  - getProblemStarts
```
public int getProblemStarts()
```
    Description copied from interface: IParsable
    
    Returns the integer value of the position where a parsing problem starts. If no problem exists -1 is returned. Default: -1
    
    Specified by:
    
    getProblemStarts in interface IParsable
    
    See Also:
    
    #getHasProblem()
  - setProblemStarts
```
public void setProblemStarts(int start)
```
    Specified by:
    
    setProblemStarts in interface IParsable
    
    See Also:
    
    IParsable.getProblemStarts()
  - getProblemEnds
```
public int getProblemEnds()
```
    Description copied from interface: IParsable
    
    Returns the integer value of the position where a parsing problem ends. If no problem exists -1 is returned. Default: -1
    
    Specified by:
    
    getProblemEnds in interface IParsable
    
    See Also:
    
    #getHasProblem()
  - setProblemEnds
```
public void setProblemEnds(int end)
```
    Specified by:
    
    setProblemEnds in interface IParsable
    
    See Also:
    
    IParsable.getProblemEnds()
  - getTypeDesignations
```
public Set<TypeDesignationBase> getTypeDesignations()
```
    Returns the set of type designations assigned to this taxon name.
    
    Specified by:
    
    getTypeDesignations in interface ITaxonNameBase
    
    See Also:
    
    NameTypeDesignation, SpecimenTypeDesignation
  - removeTypeDesignation
```
public void removeTypeDesignation(TypeDesignationBase typeDesignation)
```
    Removes one element from the set of type designations assigned to this taxon name. The type designation itself will be nullified.
    
    Specified by:
    
    removeTypeDesignation in interface ITaxonNameBase
    
    Parameters:
    
    typeDesignation - the type designation which should be deleted
  - getSpecimenTypeDesignationsOfHomotypicalGroup
```
public Set<SpecimenTypeDesignation> getSpecimenTypeDesignationsOfHomotypicalGroup()
```
    Returns the set of specimen type designations assigned to this taxon name. The rank of this taxon name is generally "species" or below. The specimen type designations include all the specimens on which the typification of this name is based (which are exclusively used to typify taxon names belonging to the same homotypical group to which this taxon name belongs) and eventually the status of these designations.
    
    Specified by:
    
    getSpecimenTypeDesignationsOfHomotypicalGroup in interface ITaxonNameBase
    
    See Also:
    
    SpecimenTypeDesignation, NameTypeDesignation, HomotypicalGroup
  - getNameTypeDesignations
```
public Set<NameTypeDesignation> getNameTypeDesignations()
```
    Returns the set of name type designations assigned to this taxon name the rank of which must be above "species". The name type designations include all the taxon names used to typify this taxon name and eventually the rejected or conserved status of these designations.
    
    Specified by:
    
    getNameTypeDesignations in interface ITaxonNameBase
    
    See Also:
    
    NameTypeDesignation, SpecimenTypeDesignation
  - addNameTypeDesignation
```
public NameTypeDesignation addNameTypeDesignation(TaxonNameBase typeSpecies,
                                                  Reference citation,
                                                  String citationMicroReference,
                                                  String originalNameString,
                                                  NameTypeDesignationStatus status,
                                                  boolean isRejectedType,
                                                  boolean isConservedType,
                                                  boolean isNotDesignated,
                                                  boolean addToAllHomotypicNames)
```
    Creates and adds a new name type designation to this taxon name's set of type designations.
    
    Specified by:
    
    addNameTypeDesignation in interface ITaxonNameBase
    
    Parameters:
    
    typeSpecies - the taxon name to be used as type of this taxon name
    
    citation - the reference for this new designation
    
    citationMicroReference - the string with the details (generally pages) within the reference
    
    originalNameString - the taxon name string used in the reference to assert this designation
    
    isRejectedType - the boolean status for a rejected name type designation
    
    isConservedType - the boolean status for a conserved name type designation
    
    isLectoType - the boolean status for a lectotype name type designation
    
    isNotDesignated - the boolean status for a name type designation without name type
    
    addToAllHomotypicNames - the boolean indicating whether the name type designation should be added to all taxon names of the homotypical group this taxon name belongs to
    
    Returns:
    
    See Also:
    
    getNameTypeDesignations(), NameTypeDesignation, TypeDesignationBase.isNotDesignated()
  - addNameTypeDesignation
```
public NameTypeDesignation addNameTypeDesignation(TaxonNameBase typeSpecies,
                                                  Reference citation,
                                                  String citationMicroReference,
                                                  String originalNameString,
                                                  NameTypeDesignationStatus status,
                                                  boolean addToAllHomotypicNames)
```
    Creates and adds a new name type designation to this taxon name's set of type designations.
    
    Specified by:
    
    addNameTypeDesignation in interface ITaxonNameBase
    
    Parameters:
    
    typeSpecies - the taxon name to be used as type of this taxon name
    
    citation - the reference for this new designation
    
    citationMicroReference - the string with the details (generally pages) within the reference
    
    originalNameString - the taxon name string used in the reference to assert this designation
    
    status - the name type designation status
    
    addToAllHomotypicNames - the boolean indicating whether the name type designation should be added to all taxon names of the homotypical group this taxon name belongs to
    
    Returns:
    
    See Also:
    
    getNameTypeDesignations(), NameTypeDesignation, TypeDesignationBase.isNotDesignated()
  - getSpecimenTypeDesignations
```
public Set<SpecimenTypeDesignation> getSpecimenTypeDesignations()
```
    Returns the set of specimen type designations that typify this taxon name.
    
    Specified by:
    
    getSpecimenTypeDesignations in interface ITaxonNameBase
  - addSpecimenTypeDesignation
```
public SpecimenTypeDesignation addSpecimenTypeDesignation(DerivedUnit typeSpecimen,
                                                          SpecimenTypeDesignationStatus status,
                                                          Reference citation,
                                                          String citationMicroReference,
                                                          String originalNameString,
                                                          boolean isNotDesignated,
                                                          boolean addToAllHomotypicNames)
```
    Creates and adds a new specimen type designation to this taxon name's set of type designations.
    
    Specified by:
    
    addSpecimenTypeDesignation in interface ITaxonNameBase
    
    Parameters:
    
    typeSpecimen - the specimen to be used as a type for this taxon name
    
    status - the specimen type designation status
    
    citation - the reference for this new specimen type designation
    
    citationMicroReference - the string with the details (generally pages) within the reference
    
    originalNameString - the taxon name used in the reference to assert this designation
    
    isNotDesignated - the boolean status for a specimen type designation without specimen type
    
    addToAllHomotypicNames - the boolean indicating whether the specimen type designation should be added to all taxon names of the homotypical group the typified taxon name belongs to
    
    Returns:
    
    See Also:
    
    getSpecimenTypeDesignations(), SpecimenTypeDesignationStatus, SpecimenTypeDesignation, TypeDesignationBase.isNotDesignated()
  - addTypeDesignation
```
public boolean addTypeDesignation(TypeDesignationBase typeDesignation,
                                  boolean addToAllNames)
```
    Adds a type designation to this taxon name's set of type designations
    
    Specified by:
    
    addTypeDesignation in interface ITaxonNameBase
    
    Parameters:
    
    typeDesignation - the typeDesignation to be added to this taxon name
    
    addToAllNames - the boolean indicating whether the type designation should be added to all taxon names of the homotypical group the typified taxon name belongs to
    
    Returns:
    
    true if the operation was succesful
    
    Throws:
    
    IllegalArgumentException - if the type designation already has typified names, an exception is thrown. We do this to prevent a type designation to be used for multiple taxon names.
  - getHomotypicalGroup
```
public HomotypicalGroup getHomotypicalGroup()
```
    Returns the homotypical group to which this taxon name belongs. A homotypical group represents all taxon names that share the same types.
    
    Specified by:
    
    getHomotypicalGroup in interface ITaxonNameBase
    
    See Also:
    
    HomotypicalGroup
  - setHomotypicalGroup
```
public void setHomotypicalGroup(HomotypicalGroup homotypicalGroup)
```
    Specified by:
    
    setHomotypicalGroup in interface ITaxonNameBase
    
    See Also:
    
    getHomotypicalGroup()
  - getCitationString
```
public String getCitationString()
```
    Returns the complete string containing the nomenclatural reference citation and the details assigned to this taxon name.
    
    Specified by:
    
    getCitationString in interface ITaxonNameBase
    
    Returns:
    
    the string containing the nomenclatural reference of this taxon name
    
    See Also:
    
    eu.etaxonomy.cdm.model.reference.INomenclaturalReference#getNomenclaturalCitation(), getNomenclaturalReference(), getNomenclaturalMicroReference()
  - getParsingProblems
```
public List<ParserProblem> getParsingProblems()
```
    Returns the parsing problems
    
    Specified by:
    
    getParsingProblems in interface IParsable
    
    Returns:
  - getReferenceYear
```
@ValidTaxonomicYear(groups=Level3.class)
public String getReferenceYear()
```
    Returns the string containing the publication date (generally only year) of the nomenclatural reference for this taxon name, null if there is no nomenclatural reference.
    
    Specified by:
    
    getReferenceYear in interface ITaxonNameBase
    
    Returns:
    
    the string containing the publication date of this taxon name
    
    See Also:
    
    INomenclaturalReference.getYear()
  - getTaxonBases
```
public Set<TaxonBase> getTaxonBases()
```
    Returns the set of taxon bases that refer to this taxon name. In this context a taxon base means the use of a taxon name by a reference either as a taxon ("accepted/correct" name) or as a (junior) synonym. A taxon name can be used by several distinct references but only once within a taxonomic treatment (identified by one reference).
    
    Specified by:
    
    getTaxonBases in interface ITaxonNameBase
    
    See Also:
    
    getTaxa(), getSynonyms()
  - addTaxonBase
```
public void addTaxonBase(TaxonBase taxonBase)
```
    Adds a new taxon base to the set of taxon bases using this taxon name.
    
    Specified by:
    
    addTaxonBase in interface ITaxonNameBase
    
    Parameters:
    
    taxonBase - the taxon base to be added
    
    See Also:
    
    getTaxonBases(), removeTaxonBase(TaxonBase)
  - removeTaxonBase
```
public void removeTaxonBase(TaxonBase taxonBase)
```
    Removes one element from the set of taxon bases that refer to this taxon name.
    
    Specified by:
    
    removeTaxonBase in interface ITaxonNameBase
    
    Parameters:
    
    taxonBase - the taxon base which should be removed from the corresponding set
    
    See Also:
    
    getTaxonBases(), addTaxonBase(TaxonBase)
  - getTaxa
```
public Set<Taxon> getTaxa()
```
    Returns the set of taxa ("accepted/correct" names according to any reference) that are based on this taxon name. This set is a subset of the set returned by getTaxonBases().
    
    Specified by:
    
    getTaxa in interface ITaxonNameBase
    
    See Also:
    
    Taxon, getTaxonBases(), getSynonyms()
  - getSynonyms
```
public Set<Synonym> getSynonyms()
```
    Returns the set of (junior) synonyms (according to any reference) that are based on this taxon name. This set is a subset of the set returned by getTaxonBases().
    
    Specified by:
    
    getSynonyms in interface ITaxonNameBase
    
    See Also:
    
    Synonym, getTaxonBases(), getTaxa()
  - getOrderedChildRelationships
```
public List<HybridRelationship> getOrderedChildRelationships()
```
    Returns the hybrid child relationships ordered by relationship type, or if equal by title cache of the related names.
    
    Specified by:
    
    getOrderedChildRelationships in interface INonViralName
    
    See Also:
    
    getHybridParentRelations()
  - addHybridParent
```
public HybridRelationship addHybridParent(INonViralName parentName,
                                          HybridRelationshipType type,
                                          String ruleConsidered)
```
    Creates a new hybrid relationship to this botanical name. A HybridRelationship may be of type "is first/second parent" or "is male/female parent". By invoking this method this botanical name becomes a hybrid child of the parent botanical name.
    
    Specified by:
    
    addHybridParent in interface INonViralName
    
    Parameters:
    
    parentName - the botanical name of the parent for this new hybrid name relationship
    
    type - the type of this new name relationship
    
    ruleConsidered - the string which specifies the rule on which this name relationship is based
    
    Returns:
    
    See Also:
    
    #addHybridChild(BotanicalName, HybridRelationshipType,String ), getRelationsToThisName(), getNameRelations(), addRelationshipFromName(TaxonNameBase, NameRelationshipType, String), addNameRelationship(NameRelationship)
  - addHybridChild
```
public HybridRelationship addHybridChild(INonViralName childName,
                                         HybridRelationshipType type,
                                         String ruleConsidered)
```
    Creates a new hybrid relationship to this botanical name. A HybridRelationship may be of type "is first/second parent" or "is male/female parent". By invoking this method this botanical name becomes a parent of the hybrid child botanical name.
    
    Specified by:
    
    addHybridChild in interface INonViralName
    
    Parameters:
    
    childName - the botanical name of the child for this new hybrid name relationship
    
    type - the type of this new name relationship
    
    ruleConsidered - the string which specifies the rule on which this name relationship is based
    
    Returns:
    
    See Also:
    
    #addHybridParent(BotanicalName, HybridRelationshipType,String ), getRelationsToThisName(), getNameRelations(), addRelationshipFromName(TaxonNameBase, NameRelationshipType, String), addNameRelationship(NameRelationship)
  - removeHybridChild
```
public void removeHybridChild(INonViralName child)
```
    Specified by:
    
    removeHybridChild in interface INonViralName
  - removeHybridParent
```
public void removeHybridParent(INonViralName parent)
```
    Specified by:
    
    removeHybridParent in interface INonViralName
  - getDescriptions
```
public Set<TaxonNameDescription> getDescriptions()
```
    Returns the set of taxon name descriptions assigned to this taxon name. A taxon name description is a piece of information concerning the taxon name like for instance the content of its first publication (protolog) or a picture of this publication.
    
    Specified by:
    
    getDescriptions in interface ITaxonNameBase
    
    See Also:
    
    addDescription(TaxonNameDescription), removeDescription(TaxonNameDescription), TaxonNameDescription
  - addDescription
```
public void addDescription(TaxonNameDescription description)
```
    Adds a new taxon name description to the set of taxon name descriptions assigned to this taxon name. The content of the taxonName attribute of the taxon name description itself will be replaced with this taxon name.
    
    Specified by:
    
    addDescription in interface ITaxonNameBase
    
    Parameters:
    
    description - the taxon name description to be added
    
    See Also:
    
    getDescriptions(), removeDescription(TaxonNameDescription)
  - removeDescription
```
public void removeDescription(TaxonNameDescription description)
```
    Removes one element from the set of taxon name descriptions assigned to this taxon name. The content of the taxonName attribute of the description itself will be set to "null".
    
    Specified by:
    
    removeDescription in interface ITaxonNameBase
    
    Parameters:
    
    description - the taxon name description which should be removed
    
    See Also:
    
    getDescriptions(), addDescription(TaxonNameDescription), TaxonNameDescription.getTaxonName()
  - mergeHomotypicGroups
```
public void mergeHomotypicGroups(TaxonNameBase name)
```
    Specified by:
    
    mergeHomotypicGroups in interface ITaxonNameBase
  - isHomotypic
```
public boolean isHomotypic(TaxonNameBase homoTypicName)
```
    Returns the boolean value indicating whether a given taxon name belongs to the same homotypical group as this taxon name (true) or not (false). Returns "true" only if the homotypical groups of both taxon names exist and if they are identical.
    
    Specified by:
    
    isHomotypic in interface ITaxonNameBase
    
    Parameters:
    
    homoTypicName - the taxon name the homotypical group of which is to be checked
    
    Returns:
    
    the boolean value of the check
    
    See Also:
    
    HomotypicalGroup
  - isGroupsBasionym
```
public boolean isGroupsBasionym()
```
    Checks whether name is a basionym for ALL names in its homotypical group. Returns false if there are no other names in the group
    
    Specified by:
    
    isGroupsBasionym in interface ITaxonNameBase
    
    Parameters:
    
    name -
    
    Returns:
  - isBasionymFor
```
public boolean isBasionymFor(TaxonNameBase newCombinationName)
```
    Checks whether a basionym relationship exists between fromName and toName.
    
    Specified by:
    
    isBasionymFor in interface ITaxonNameBase
    
    Parameters:
    
    fromName -
    
    toName -
    
    Returns:
  - makeGroupsBasionym
```
public void makeGroupsBasionym()
```
    Creates a basionym relationship to all other names in this names homotypical group.
    
    Specified by:
    
    makeGroupsBasionym in interface ITaxonNameBase
    
    See Also:
    
    HomotypicalGroup.setGroupBasionym(TaxonNameBase basionymName)
  - isSupraGeneric
```
public boolean isSupraGeneric()
```
    Returns the boolean value indicating whether the taxonomic rank of this taxon name is higher than the genus rank (true) or not (false). Suprageneric non viral names are monomials. Returns false if rank is null.
    
    Specified by:
    
    isSupraGeneric in interface ITaxonNameBase
    
    See Also:
    
    isGenus(), isInfraGeneric(), isSpecies(), isInfraSpecific()
  - isGenus
```
public boolean isGenus()
```
    Returns the boolean value indicating whether the taxonomic rank of this taxon name is the genus rank (true) or not (false). Non viral names with genus rank are monomials. Returns false if rank is null.
    
    Specified by:
    
    isGenus in interface ITaxonNameBase
    
    See Also:
    
    isSupraGeneric(), isInfraGeneric(), isSpecies(), isInfraSpecific()
  - isInfraGeneric
```
public boolean isInfraGeneric()
```
    Returns the boolean value indicating whether the taxonomic rank of this taxon name is higher than the species rank and lower than the genus rank (true) or not (false). Infrageneric non viral names are binomials. Returns false if rank is null.
    
    Specified by:
    
    isInfraGeneric in interface ITaxonNameBase
    
    See Also:
    
    isSupraGeneric(), isGenus(), isSpecies(), isInfraSpecific()
  - isSupraSpecific
```
public boolean isSupraSpecific()
```
    Returns the boolean value indicating whether the taxonomic rank of this taxon name is higher than the species rank (true) or not (false). Returns false if rank is null.
    
    Specified by:
    
    isSupraSpecific in interface ITaxonNameBase
    
    See Also:
    
    isGenus(), isInfraGeneric(), isSpecies(), isInfraSpecific()
  - isSpecies
```
public boolean isSpecies()
```
    Returns the boolean value indicating whether the taxonomic rank of this taxon name is the species rank (true) or not (false). Non viral names with species rank are binomials. Returns false if rank is null.
    
    Specified by:
    
    isSpecies in interface ITaxonNameBase
    
    See Also:
    
    isSupraGeneric(), isGenus(), isInfraGeneric(), isInfraSpecific()
  - isInfraSpecific
```
public boolean isInfraSpecific()
```
    Returns the boolean value indicating whether the taxonomic rank of this taxon name is lower than the species rank (true) or not (false). Infraspecific non viral names are trinomials. Returns false if rank is null.
    
    Specified by:
    
    isInfraSpecific in interface ITaxonNameBase
    
    See Also:
    
    isSupraGeneric(), isGenus(), isInfraGeneric(), isSpecies()
  - isSpeciesAggregate
```
public boolean isSpeciesAggregate()
```
    Returns true if this name's rank indicates a rank that aggregates species like species aggregates or species groups, false otherwise. This methods currently returns false for all user defined ranks.
    
    Specified by:
    
    isSpeciesAggregate in interface ITaxonNameBase
    
    Returns:
    
    See Also:
    
    Rank.isSpeciesAggregate()
  - getNomenclaturalCode
```
public NomenclaturalCode getNomenclaturalCode()
```
    Returns null as the nomenclatural code that governs the construction of this taxon name since there is no specific nomenclatural code defined. The real implementention takes place in the subclasses BacterialName, BotanicalName, CultivarPlantName and ZoologicalName. Each taxon name is governed by one and only one nomenclatural code.
    
    Specified by:
    
    getNomenclaturalCode in interface ITaxonNameBase
    
    Returns:
    
    null
    
    See Also:
    
    #isCodeCompliant(), #getHasProblem()
  - setAsGroupsBasionym
```
public void setAsGroupsBasionym()
```
    Creates a basionym relationship between this name and each name in its homotypic group.
    
    Specified by:
    
    setAsGroupsBasionym in interface ITaxonNameBase
    
    Parameters:
    
    basionymName -
  - removeAsGroupsBasionym
```
public void removeAsGroupsBasionym()
```
    Removes basionym relationship between this name and each name in its homotypic group.
    
    Specified by:
    
    removeAsGroupsBasionym in interface ITaxonNameBase
    
    Parameters:
    
    basionymName -
  - getLastNamePart
```
public String getLastNamePart()
```
    Defines the last part of the name. This is for infraspecific taxa, the infraspecific epithet, for species the specific epithet, for infageneric taxa the infrageneric epithet else the genusOrUninomial. However, the result does not depend on the rank (which may be not correctly set in case of dirty data) but returns the first name part which is not blank considering the above order.
    
    Specified by:
    
    getLastNamePart in interface INonViralName
    
    Returns:
    
    the first not blank name part in reverse order
  - isHybridName
```
public boolean isHybridName()
```
    Computes if this name is a hybrid name. true if any of the monon, binom or trinom hybrid flags is set. false if neither of these flags is set. Note: usually false if the hybrid formula flag is set as a name is either a hybrid name or a hybrid formula or none of them, but never both.
    
    Specified by:
    
    isHybridName in interface INonViralName
    
    Returns:
    
    the boolean value indicating if this is a hybrid name
    
    See Also:
    
    INonViralName.isHybridFormula(), INonViralName.isMonomHybrid(), INonViralName.isBinomHybrid(), INonViralName.isTrinomHybrid(), INonViralName.isHybrid()
  - isHybrid
```
public boolean isHybrid()
```
    Computes if this name is a hybrid (hybrid name or hybrid formula). true if any of the monon, binom, trinom hybrid flags or the hybrid formula flag is set. false otherwise.
    
    Specified by:
    
    isHybrid in interface INonViralName
    
    Returns:
    
    the boolean value indicating if this is a hybrid
    
    See Also:
    
    INonViralName.isHybridFormula(), INonViralName.isMonomHybrid(), INonViralName.isBinomHybrid(), INonViralName.isTrinomHybrid(), INonViralName.isHybridName()
  - compareToName
```
public int compareToName(TaxonNameBase<?,?> otherName)
```
    Description copied from interface: ITaxonNameBase
    
    This method compares 2 taxon names on it's name titles and caches. Maybe in future more parts will be added. It is not fully clear/defined how this method relates to explicit comparators like TaxonNameComparator. Historically it was a compareTo method in IdentifiableEntity but did not fulfill the Comparable contract.
    
    https://dev.e-taxonomy.eu/redmine/issues/922
    https://dev.e-taxonomy.eu/redmine/issues/6311
    
    Specified by:
    
    compareToName in interface ITaxonNameBase
    
    Returns:
    
    the compareTo result similar to Comparable.compareTo(Object)
    
    See Also:
    
    compareToName(TaxonNameBase), TaxonNameComparator, TaxonComparator
  - castAndDeproxy
```
public static TaxonNameBase castAndDeproxy(ITaxonNameBase interfacedName)
```
    Method to cast a interfaced name to a concrete name. The method includes a deproxy to guarantee that no class cast exception is thrown.
    
    Parameters:
    
    interfacedName -
    
    Returns:
    
    See Also:
    
    castAndDeproxy(Set)
  - castAndDeproxy
```
public static Set<TaxonNameBase> castAndDeproxy(Set<ITaxonNameBase> naminterfacedNames)
```
    Method to cast a set of interfaced names to concrete namex. The method includes a deproxy to guarantee that no class cast exception is thrown.
    
    Parameters:
    
    naminterfacedNames -
    
    Returns:
    
    See Also:
    
    castAndDeproxy(ITaxonNameBase)
  - clone
```
public Object clone()
```
    Clones this taxon name. This is a shortcut that enables to create a new instance that differs only slightly from this taxon name by modifying only some of the attributes.
    
    Usages of this name in a taxon concept are not cloned.
    The name gets a newly created homotypical group
    (CAUTION: this behaviour needs to be discussed and may change in future).
    
    Name descriptions are cloned and not reused.
    Type designations are cloned and not reused.
    
    Specified by:
    
    clone in interface ITaxonNameBase
    
    Overrides:
    
    clone in class IdentifiableEntity<S extends INameCacheStrategy>
    
    See Also:
    
    eu.etaxonomy.cdm.model.media.IdentifiableEntity#clone(), Object.clone()

Class TaxonNameBase<T extends TaxonNameBase<?,?>,S extends INameCacheStrategy>

Field Summary

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

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

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

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

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

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

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

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

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

Field Detail

fullTitleCache

protectedNameCache

protectedAuthorshipCache

Constructor Detail

TaxonNameBase

TaxonNameBase

TaxonNameBase

TaxonNameBase

TaxonNameBase

Method Detail

initListener

getAllFields

isProtectedNameCache

setProtectedNameCache

getGenusOrUninomial

setGenusOrUninomial

getInfraGenericEpithet

setInfraGenericEpithet

getSpecificEpithet

setSpecificEpithet

getInfraSpecificEpithet

setInfraSpecificEpithet

getCombinationAuthorship

setCombinationAuthorship

getExCombinationAuthorship

setExCombinationAuthorship

getBasionymAuthorship

setBasionymAuthorship

getExBasionymAuthorship

setExBasionymAuthorship

isProtectedAuthorshipCache

setProtectedAuthorshipCache

getHybridParentRelations

getHybridChildRelations

isProtectedFullTitleCache

setProtectedFullTitleCache

isHybridFormula

setHybridFormula

isMonomHybrid

setMonomHybrid

isBinomHybrid

setBinomHybrid

isTrinomHybrid

setTrinomHybrid

getAcronym

setAcronym

getSubGenusAuthorship

setSubGenusAuthorship

getNameApprobation

setNameApprobation

getBreed

setBreed

getPublicationYear

setPublicationYear

getOriginalPublicationYear

setOriginalPublicationYear

getCultivarName

setCultivarName

addHybridRelationship

removeHybridRelationship

generateFullTitle

setFullTitleCache