public interface INonViralName extends ITaxonNameBase
Modifier and Type | Method and Description |
---|---|
HybridRelationship |
addHybridChild(INonViralName childName,
HybridRelationshipType type,
java.lang.String ruleConsidered)
Creates a new
hybrid relationship
to this non viral name. |
HybridRelationship |
addHybridParent(INonViralName parentName,
HybridRelationshipType type,
Reference reference,
java.lang.String microReference,
java.lang.String ruleConsidered,
NomenclaturalCodeEdition codeEdition)
Creates a new
hybrid relationship
to this non viral name. |
HybridRelationship |
addHybridParent(INonViralName parentName,
HybridRelationshipType type,
java.lang.String ruleConsidered)
Creates a new
hybrid relationship
to this non viral name. |
java.lang.String |
computeBasionymAuthorNomenclaturalTitle()
Shortcut.
|
java.lang.String |
computeCombinationAuthorNomenclaturalTitle()
Shortcut.
|
java.lang.String |
computeExBasionymAuthorNomenclaturalTitle()
Shortcut.
|
java.lang.String |
computeExCombinationAuthorNomenclaturalTitle()
Shortcut.
|
java.lang.String |
generateAuthorship()
Generates and returns a concatenated and formatted author teams string
including basionym and combination authors of this non viral taxon name
according to the strategy defined in
INonViralNameCacheStrategy . |
java.lang.String |
getAuthorshipCache()
Returns the concatenated and formatted author teams string including
basionym and combination authors of this non viral taxon name.
|
TeamOrPersonBase<?> |
getBasionymAuthorship()
Returns the
author (team) that published the original combination
on which this non viral taxon name is nomenclaturally based. |
TeamOrPersonBase<?> |
getCombinationAuthorship()
Returns the
author (team) that published this non viral
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). |
java.lang.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). |
java.util.Set<HybridRelationship> |
getHybridChildRelations()
Returns the set of all
hybrid relationships
in which this taxon name is involved as a child . |
java.util.Set<HybridRelationship> |
getHybridParentRelations()
Returns the set of all
hybrid relationships
in which this taxon name is involved as a parent . |
java.lang.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). |
java.lang.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). |
java.lang.String |
getLastNamePart()
Defines the last part of the name.
|
java.lang.String |
getNameCache()
Returns or generates the nameCache (scientific name
without author strings and year) string for this non viral taxon name.
|
java.util.List<HybridRelationship> |
getOrderedChildRelationships()
Returns the hybrid child relationships ordered by relationship type, or if equal
by title cache of the related names.
|
java.lang.String |
getSpecificEpithet()
Returns the species epithet string for this non viral taxon name if its
rank is
species aggregate or lower (bi- or trinomial). |
boolean |
hasAuthors()
Tests if the given name has any authors.
|
boolean |
isAutonym()
Needs to be implemented by those classes that handle autonyms (e.g.
|
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 |
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 |
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 |
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 |
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 |
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 |
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 |
setAuthorshipCache(java.lang.String authorshipCache)
Assigns an authorshipCache string to this non viral taxon name.
|
void |
setAuthorshipCache(java.lang.String authorshipCache,
boolean protectedAuthorshipCache)
Assigns an authorshipCache string to this non viral taxon name.
|
void |
setBasionymAuthorship(TeamOrPersonBase<?> basionymAuthorship) |
void |
setBinomHybrid(boolean binomHybrid) |
void |
setCombinationAuthorship(TeamOrPersonBase<?> combinationAuthorship) |
void |
setExBasionymAuthorship(TeamOrPersonBase<?> exBasionymAuthorship) |
void |
setExCombinationAuthorship(TeamOrPersonBase<?> exCombinationAuthorship) |
void |
setGenusOrUninomial(java.lang.String genusOrUninomial) |
void |
setHybridFormula(boolean hybridFormula) |
void |
setInfraGenericEpithet(java.lang.String infraGenericEpithet) |
void |
setInfraSpecificEpithet(java.lang.String infraSpecificEpithet) |
void |
setMonomHybrid(boolean monomHybrid) |
void |
setNameCache(java.lang.String nameCache)
Assigns a nameCache string to this non viral taxon name and protects it from being overwritten.
|
void |
setNameCache(java.lang.String nameCache,
boolean protectedNameCache)
Assigns a nameCache string to this non viral taxon name and protects it from being overwritten.
|
void |
setProtectedAuthorshipCache(boolean protectedAuthorshipCache) |
void |
setProtectedNameCache(boolean protectedNameCache) |
void |
setSpecificEpithet(java.lang.String specificEpithet) |
void |
setTrinomHybrid(boolean trinomHybrid) |
addBasionym, addBasionym, addDescription, addNameTypeDesignation, addNameTypeDesignation, addOriginalSpelling, addParsingProblems, addRelationshipFromName, addRelationshipFromName, addRelationshipToName, addRelationshipToName, addRelationshipToName, addReplacedSynonym, addSpecimenTypeDesignation, addStatus, addStatus, addTaxonBase, addTextualTypeDesignation, addTypeDesignation, clone, compareToName, generateFullTitle, getAppendedPhrase, getBasionym, getBasionyms, getCitationString, getDescriptions, getFullTitleCache, getHomotypicalGroup, getNameRelations, getNameType, getNameTypeDesignations, getNomenclaturalMicroReference, getNomenclaturalReference, getNomenclaturalSource, getRank, getReferenceYear, getRegistrations, getRelationsFromThisName, getRelationsToThisName, getReplacedSynonyms, getSpecimenTypeDesignations, getSpecimenTypeDesignationsOfHomotypicalGroup, getStatus, getSynonyms, getTaggedFullTitle, getTaggedName, getTaxa, getTaxonBases, getTypeDesignations, isBacterial, isBasionymFor, isBotanical, isCultivar, isGenus, isGenusOrSupraGeneric, isGroupsBasionym, isHomotypic, isInfraGeneric, isInfraSpecific, isNonViral, isOriginalCombination, isProtectedFullTitleCache, isReplacedSynonym, isSpecies, isSpeciesAggregate, isSupraGeneric, isSupraSpecific, isViral, isZoological, makeGroupsBasionym, mergeHomotypicGroups, removeAsGroupsBasionym, removeBasionyms, removeDescription, removeNameRelationship, removeRelationToTaxonName, removeStatus, removeTaxonBase, removeTypeDesignation, setAppendedPhrase, setAsGroupsBasionym, setFullTitleCache, setFullTitleCache, setHomotypicalGroup, setNameType, setNomenclaturalMicroReference, setNomenclaturalReference, setNomenclaturalReference, setNomenclaturalSource, setProtectedFullTitleCache, setRank
addCredit, addCredit, addExtension, addExtension, addIdentifier, addIdentifier, addIdentifier, addRights, generateTitle, getCredits, getCredits, getData, getExtensions, getIdentifiers, getLsid, getRights, getTitleCache, isProtectedTitleCache, removeCredit, removeCredit, removeExtension, removeIdentifier, removeIdentifier, removeRights, removeSources, replaceCredit, replaceIdentifier, resetTitleCache, setLsid, setProtectedTitleCache, setTitleCache, setTitleCache, toString
addAggregationSource, addImportSource, addPrimaryTaxonomicSource, addPrimaryTaxonomicSource, addSource, addSource, addSource, addSources, getSources, removeSource
addAnnotation, addMarker, getAnnotations, getMarkers, getMarkers, hasMarker, hasMarker, markerValue, removeAnnotation, removeMarker, removeMarker
getUpdated, getUpdatedBy, setUpdated, setUpdatedBy
getCreated, getCreatedBy, getId, getUuid, isInstanceOf, isPersited, setCreated, setCreatedBy, setId, setUuid
addParsingProblem, getParsingProblem, getParsingProblems, getProblemEnds, getProblemStarts, hasProblem, hasProblem, removeParsingProblem, setParsingProblem, setProblemEnds, setProblemStarts
addRelationship, getUuid
HybridRelationship addHybridChild(INonViralName childName, HybridRelationshipType type, java.lang.String ruleConsidered)
hybrid relationship
to this non viral name. A HybridRelationship may be of type
"is first/second parent" or "is male/female parent". By invoking this
method this non viral name becomes a parent of the hybrid child
non viral name.childName
- the non viral name of the child for this new hybrid name relationshiptype
- the type of this new name relationshipruleConsidered
- the string which specifies the rule on which this name relationship is based#addHybridParent(TaxonName, HybridRelationshipType,String )
,
ITaxonNameBase.getRelationsToThisName()
,
ITaxonNameBase.getNameRelations()
,
#addRelationshipFromName(TaxonName, NameRelationshipType, String)
,
#addNameRelationship(NameRelationship)
HybridRelationship addHybridParent(INonViralName parentName, HybridRelationshipType type, java.lang.String ruleConsidered)
hybrid relationship
to this non viral name. A HybridRelationship may be of type
"is first/second parent" or "is male/female parent". By invoking this
method this non viral name becomes a hybrid child of the parent
non viral name.parentName
- the non viral name of the parent for this new hybrid name relationshiptype
- the type of this new name relationshipruleConsidered
- the string which specifies the rule on which this name relationship is based#addHybridChild(TaxonName, HybridRelationshipType,String )
,
ITaxonNameBase.getRelationsToThisName()
,
ITaxonNameBase.getNameRelations()
,
#addRelationshipFromName(TaxonName, NameRelationshipType, String)
,
#addNameRelationship(NameRelationship)
HybridRelationship addHybridParent(INonViralName parentName, HybridRelationshipType type, Reference reference, java.lang.String microReference, java.lang.String ruleConsidered, NomenclaturalCodeEdition codeEdition)
hybrid relationship
to this non viral name. A HybridRelationship may be of type
"is first/second parent" or "is male/female parent". By invoking this
method this non viral name becomes a hybrid child of the parent
non viral name.parentName
- the non viral name of the parent for this new hybrid name relationshiptype
- the type of this new name relationshipreference
- the reference for this relationshipmicroReference
- the micro reference (e.g. page no.) of this relationshipruleConsidered
- the string which specifies the rule on which this name relationship is basedcodeEditrion
- the nomenclatural code used for the considered rule#addHybridChild(TaxonName, HybridRelationshipType,String )
,
ITaxonNameBase.getRelationsToThisName()
,
ITaxonNameBase.getNameRelations()
,
#addRelationshipFromName(TaxonName, NameRelationshipType, String)
,
#addNameRelationship(NameRelationship)
java.lang.String computeBasionymAuthorNomenclaturalTitle()
java.lang.String computeCombinationAuthorNomenclaturalTitle()
java.lang.String computeExBasionymAuthorNomenclaturalTitle()
java.lang.String computeExCombinationAuthorNomenclaturalTitle()
java.lang.String generateAuthorship()
INonViralNameCacheStrategy
.eu.etaxonomy.cdm.strategy.cache.name.INonViralNameCacheStrategy#getAuthorshipCache(NonViralName)
java.lang.String getAuthorshipCache()
generateAuthorship()
TeamOrPersonBase<?> getBasionymAuthorship()
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.getCombinationAuthorship()
,
INomenclaturalAuthor
,
TeamOrPersonBase.getNomenclaturalTitle()
TeamOrPersonBase<?> getCombinationAuthorship()
author (team)
that published this non viral
taxon name.INomenclaturalAuthor
,
TeamOrPersonBase.getNomenclaturalTitle()
TeamOrPersonBase<?> getExBasionymAuthorship()
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.getBasionymAuthorship()
,
getExCombinationAuthorship()
,
getCombinationAuthorship()
,
INomenclaturalAuthor
,
TeamOrPersonBase.getNomenclaturalTitle()
TeamOrPersonBase<?> getExCombinationAuthorship()
author (team)
that contributed to
the publication of this non viral taxon name as generally stated by
the combination author (team)
itself.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.
getCombinationAuthorship()
,
INomenclaturalAuthor
,
TeamOrPersonBase.getNomenclaturalTitle()
java.lang.String getGenusOrUninomial()
rank
is lower than genus (bi- or trinomial).
Genus or uninomial strings begin with an upper case letter.getNameCache()
java.util.Set<HybridRelationship> getHybridChildRelations()
hybrid relationships
in which this taxon name is involved as a child
.#getHybridRelationships()
,
#getParentRelationships()
,
HybridRelationshipType
java.util.Set<HybridRelationship> getHybridParentRelations()
hybrid relationships
in which this taxon name is involved as a parent
.#getHybridRelationships()
,
#getChildRelationships()
,
HybridRelationshipType
java.lang.String getInfraGenericEpithet()
rank
is infrageneric (lower than genus and
higher than species aggregate: binomial). Genus subdivision epithet
strings begin with an upper case letter.getNameCache()
java.lang.String getSpecificEpithet()
rank
is
species aggregate or lower (bi- or trinomial). Species epithet strings
begin with a lower case letter.getNameCache()
java.lang.String getInfraSpecificEpithet()
rank
is infraspecific
(lower than species: trinomial). Species subdivision epithet strings
begin with a lower case letter.getNameCache()
java.lang.String getLastNamePart()
java.lang.String getNameCache()
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.#generateNameCache()
java.util.List<HybridRelationship> getOrderedChildRelationships()
getHybridParentRelations()
boolean hasAuthors()
boolean isAutonym()
boolean isHybridFormula()
autorship
nor other name components. If this flag is set no other hybrid flags may
be set.isMonomHybrid()
,
isBinomHybrid()
,
isTrinomHybrid()
,
isHybridName()
,
isHybrid()
boolean isMonomHybrid()
isHybridFormula()
,
isBinomHybrid()
,
isTrinomHybrid()
,
isHybridName()
,
isHybrid()
boolean isBinomHybrid()
isHybridFormula()
,
isMonomHybrid()
,
isTrinomHybrid()
,
isHybridName()
,
isHybrid()
boolean isTrinomHybrid()
isHybridFormula()
,
isMonomHybrid()
,
isBinomHybrid()
,
isHybridName()
,
isHybrid()
boolean isHybridName()
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.isHybridFormula()
,
isMonomHybrid()
,
isBinomHybrid()
,
isTrinomHybrid()
,
isHybrid()
boolean isHybrid()
true
if any of the monon, binom, trinom
hybrid flags or the hybrid formula flag is set. false
otherwise.isHybridFormula()
,
isMonomHybrid()
,
isBinomHybrid()
,
isTrinomHybrid()
,
isHybridName()
boolean isProtectedAuthorshipCache()
authorshipCache
(complete authorship string)
of this non viral taxon name.getAuthorshipCache()
boolean isProtectedNameCache()
nameCache
(scientific name without author strings and year)
string of this non viral taxon name.getNameCache()
void removeHybridChild(INonViralName child)
void removeHybridParent(INonViralName parent)
void removeHybridRelationship(HybridRelationship hybridRelation)
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.relationship
- the hybrid relationship which should be deleted from the corresponding sets#getHybridRelationships()
void setAuthorshipCache(java.lang.String authorshipCache)
true
.authorshipCache
- the string which identifies the complete authorship of this non viral taxon namegetAuthorshipCache()
void setAuthorshipCache(java.lang.String authorshipCache, boolean protectedAuthorshipCache)
authorshipCache
- the string which identifies the complete authorship of this non viral taxon nameprotectedAuthorshipCache
- if true the isProtectedAuthorshipCache flag is set to true
, otherwise
the flag is set to false
.getAuthorshipCache()
void setBasionymAuthorship(TeamOrPersonBase<?> basionymAuthorship)
getBasionymAuthorship()
void setBinomHybrid(boolean binomHybrid)
isBinomHybrid()
,
isMonomHybrid()
,
isTrinomHybrid()
void setCombinationAuthorship(TeamOrPersonBase<?> combinationAuthorship)
getCombinationAuthorship()
void setExBasionymAuthorship(TeamOrPersonBase<?> exBasionymAuthorship)
getExBasionymAuthorship()
void setExCombinationAuthorship(TeamOrPersonBase<?> exCombinationAuthorship)
getExCombinationAuthorship()
void setGenusOrUninomial(java.lang.String genusOrUninomial)
getGenusOrUninomial()
void setHybridFormula(boolean hybridFormula)
isHybridFormula()
void setInfraGenericEpithet(java.lang.String infraGenericEpithet)
getInfraGenericEpithet()
void setInfraSpecificEpithet(java.lang.String infraSpecificEpithet)
getInfraSpecificEpithet()
void setMonomHybrid(boolean monomHybrid)
isMonomHybrid()
,
isBinomHybrid()
,
isTrinomHybrid()
void setNameCache(java.lang.String nameCache)
true
.nameCache
- the string which identifies this non viral taxon name (without authors or year)getNameCache()
void setNameCache(java.lang.String nameCache, boolean protectedNameCache)
true
.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
getNameCache()
void setProtectedAuthorshipCache(boolean protectedAuthorshipCache)
isProtectedAuthorshipCache()
,
getAuthorshipCache()
void setProtectedNameCache(boolean protectedNameCache)
isProtectedNameCache()
void setSpecificEpithet(java.lang.String specificEpithet)
getSpecificEpithet()
void setTrinomHybrid(boolean trinomHybrid)
isTrinomHybrid()
,
isBinomHybrid()
,
isMonomHybrid()
Copyright © 2007-2020 EDIT. All Rights Reserved.