TaxonName (SIH-Adagio :: Core 3.5.6 API)

Object
- TaxonName

All Implemented Interfaces:

Serializable, Comparable<TaxonName>

Direct Known Subclasses:

TaxonNameImpl
```
public abstract class TaxonName
extends Object
implements Serializable, Comparable<TaxonName>
```
Classe regroupant les taxons. Il s'agit en fait d'une combinaison entre un rang taxinomique, un nom de taxon, un code et éventuellement un auteur et une date. Cette classe regroupe les taxons valides, provisoires, obsolètes, virtuels et les synonymes. On garde l'historique du passage en taxon valide, puis du passage en synonyme (date de fin référent). Dans COST : "Use the FAO reference list ftp://ftp.fao.org/FI/stat/data/ASFIS_sp.zip"

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TaxonName.Factory
Constructs new instances of TaxonName.

Nested Classes
Modifier and Type	Class and Description
`static class`	`TaxonName.Factory` Constructs new instances of `TaxonName`.

Constructor Summary

Constructors
Constructor and Description

TaxonName()

Constructors
Constructor and Description
`TaxonName()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`addChildTaxonNames(TaxonName elementToAdd)` Classe regroupant les taxons.
`boolean`	`addParentTaxonNameHistories(TaxonNameHistory elementToAdd)`
`boolean`	`addTaxonNamehistories(TaxonNameHistory elementToAdd)`
`int`	`compareTo(TaxonName o)`
`boolean`	`equals(Object object)` Returns `true` if the argument is an TaxonName instance and all identifiers for this entity equal the identifiers of the argument entity.
`Collection<TaxonName>`	`getChildTaxonNames()` Classe regroupant les taxons.
`Citation`	`getCitation()` Deux éléments sont à distinguer dans l'autorité de classification d’un taxon : - La publication qui fait état de la description et de la nomenclature du taxon
`String`	`getComments()` Commentaire associé au libellé du taxon.
`String`	`getCompleteName()`
`Date`	`getCreationDate()` Date de création système du libellé.
`Date`	`getEndDate()` Date où le libellé n'est plus référent et a été remplacé par un autre libellé.
`Integer`	`getId()` Identifiant système unique du libellé.
`String`	`getName()` Nom latin présent dans la nomenclature du libellé.
`TaxonName`	`getParentTaxonName()` Classe regroupant les taxons.
`Collection<TaxonNameHistory>`	`getParentTaxonNameHistories()`
`ReferenceTaxon`	`getReferenceTaxon()`
`Date`	`getStartDate()` Date à laquelle le taxon est devenu valide.
`Collection<TaxonNameHistory>`	`getTaxonNamehistories()`
`TaxonomicLevel`	`getTaxonomicLevel()` Liste des rangs taxinomiques possibles.
`Timestamp`	`getUpdateDate()` Date de mise à jour système du libellé.
`Integer`	`getUpperRank()` Ce numéro d'ordre du taxon dans l'arbre phylogénique permet de classer les fils d'un même taxon père et donc l'ensemble des taxons valides les uns par rapport aux autres.
`int`	`hashCode()` Returns a hash code based on this entity's identifiers.
`Boolean`	`isIsNaming()` Indique si les regles de nomenclature sont à appliquer.
`Boolean`	`isIsObsolete()` Indique qu’un taxon est obsolète
`Boolean`	`isIsReferent()`
`Boolean`	`isIsTemporary()` Un libellé peut être provisoire (sp1,sp2 etc.)
`Boolean`	`isIsVirtual()`
`boolean`	`removeChildTaxonNames(TaxonName elementToRemove)` Classe regroupant les taxons.
`boolean`	`removeParentTaxonNameHistories(TaxonNameHistory elementToRemove)`
`boolean`	`removeTaxonNamehistories(TaxonNameHistory elementToRemove)`
`void`	`setChildTaxonNames(Collection<TaxonName> childTaxonNamesIn)` Classe regroupant les taxons.
`void`	`setCitation(Citation citationIn)` Deux éléments sont à distinguer dans l'autorité de classification d’un taxon : - La publication qui fait état de la description et de la nomenclature du taxon
`void`	`setComments(String commentsIn)` Commentaire associé au libellé du taxon.
`void`	`setCompleteName(String completeNameIn)`
`void`	`setCreationDate(Date creationDateIn)` Date de création système du libellé.
`void`	`setEndDate(Date endDateIn)` Date où le libellé n'est plus référent et a été remplacé par un autre libellé.
`void`	`setId(Integer idIn)` Identifiant système unique du libellé.
`void`	`setIsNaming(Boolean isNamingIn)` Indique si les regles de nomenclature sont à appliquer.
`void`	`setIsObsolete(Boolean isObsoleteIn)` Indique qu’un taxon est obsolète
`void`	`setIsReferent(Boolean isReferentIn)`
`void`	`setIsTemporary(Boolean isTemporaryIn)` Un libellé peut être provisoire (sp1,sp2 etc.)
`void`	`setIsVirtual(Boolean isVirtualIn)`
`void`	`setName(String nameIn)` Nom latin présent dans la nomenclature du libellé.
`void`	`setParentTaxonName(TaxonName parentTaxonNameIn)` Classe regroupant les taxons.
`void`	`setParentTaxonNameHistories(Collection<TaxonNameHistory> parentTaxonNameHistoriesIn)`
`void`	`setReferenceTaxon(ReferenceTaxon referenceTaxonIn)`
`void`	`setStartDate(Date startDateIn)` Date à laquelle le taxon est devenu valide.
`void`	`setTaxonNamehistories(Collection<TaxonNameHistory> taxonNamehistoriesIn)`
`void`	`setTaxonomicLevel(TaxonomicLevel taxonomicLevelIn)` Liste des rangs taxinomiques possibles.
`void`	`setUpdateDate(Timestamp updateDateIn)` Date de mise à jour système du libellé.
`void`	`setUpperRank(Integer upperRankIn)` Ce numéro d'ordre du taxon dans l'arbre phylogénique permet de classer les fils d'un même taxon père et donc l'ensemble des taxons valides les uns par rapport aux autres.

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TaxonName
```
public TaxonName()
```
- Method Detail
  - getId
```
public Integer getId()
```
    Identifiant système unique du libellé.
    
    Returns:
    this.id Integer
  - setId
```
public void setId(Integer idIn)
```
    Identifiant système unique du libellé.
    
    Parameters:
    idIn - Integer
  - getName
```
public String getName()
```
    Nom latin présent dans la nomenclature du libellé. Il obéit aux règles de la concaténation du libellé décrites dans le règle [R0018].
    
    Returns:
    this.name String
  - setName
```
public void setName(String nameIn)
```
    Nom latin présent dans la nomenclature du libellé. Il obéit aux règles de la concaténation du libellé décrites dans le règle [R0018].
    
    Parameters:
    nameIn - String
  - getCompleteName
```
public String getCompleteName()
```
    Returns:
    this.completeName String
  - setCompleteName
```
public void setCompleteName(String completeNameIn)
```
    Parameters:
    completeNameIn - String
  - isIsNaming
```
public Boolean isIsNaming()
```
    Indique si les regles de nomenclature sont à appliquer.
    
    Returns:
    this.isNaming Boolean
  - setIsNaming
```
public void setIsNaming(Boolean isNamingIn)
```
    Indique si les regles de nomenclature sont à appliquer.
    
    Parameters:
    isNamingIn - Boolean
  - isIsReferent
```
public Boolean isIsReferent()
```
    Returns:
    this.isReferent Boolean
  - setIsReferent
```
public void setIsReferent(Boolean isReferentIn)
```
    Parameters:
    isReferentIn - Boolean
  - getUpperRank
```
public Integer getUpperRank()
```
    Ce numéro d'ordre du taxon dans l'arbre phylogénique permet de classer les fils d'un même taxon père et donc l'ensemble des taxons valides les uns par rapport aux autres. Il permet notamment de gérer les ordre d'affichage suivant l'ordre taxinomique.
    
    Returns:
    this.upperRank Integer
  - setUpperRank
```
public void setUpperRank(Integer upperRankIn)
```
    Ce numéro d'ordre du taxon dans l'arbre phylogénique permet de classer les fils d'un même taxon père et donc l'ensemble des taxons valides les uns par rapport aux autres. Il permet notamment de gérer les ordre d'affichage suivant l'ordre taxinomique.
    
    Parameters:
    upperRankIn - Integer
  - isIsVirtual
```
public Boolean isIsVirtual()
```
    Returns:
    this.isVirtual Boolean
  - setIsVirtual
```
public void setIsVirtual(Boolean isVirtualIn)
```
    Parameters:
    isVirtualIn - Boolean
  - isIsObsolete
```
public Boolean isIsObsolete()
```
    Indique qu’un taxon est obsolète
    
    Returns:
    this.isObsolete Boolean
  - setIsObsolete
```
public void setIsObsolete(Boolean isObsoleteIn)
```
    Indique qu’un taxon est obsolète
    
    Parameters:
    isObsoleteIn - Boolean
  - isIsTemporary
```
public Boolean isIsTemporary()
```
    Un libellé peut être provisoire (sp1,sp2 etc.)
    
    Returns:
    this.isTemporary Boolean
  - setIsTemporary
```
public void setIsTemporary(Boolean isTemporaryIn)
```
    Un libellé peut être provisoire (sp1,sp2 etc.)
    
    Parameters:
    isTemporaryIn - Boolean
  - getStartDate
```
public Date getStartDate()
```
    Date à laquelle le taxon est devenu valide. Cette date peut être vide si le libellé n'a jamais été valide. Cette date est renseignée automatiquement par le système.
    
    Returns:
    this.startDate Date
  - setStartDate
```
public void setStartDate(Date startDateIn)
```
    Date à laquelle le taxon est devenu valide. Cette date peut être vide si le libellé n'a jamais été valide. Cette date est renseignée automatiquement par le système.
    
    Parameters:
    startDateIn - Date
  - getEndDate
```
public Date getEndDate()
```
    Date où le libellé n'est plus référent et a été remplacé par un autre libellé. Cette date est renseignée automatiquement par le système.
    
    Returns:
    this.endDate Date
  - setEndDate
```
public void setEndDate(Date endDateIn)
```
    Date où le libellé n'est plus référent et a été remplacé par un autre libellé. Cette date est renseignée automatiquement par le système.
    
    Parameters:
    endDateIn - Date
  - getComments
```
public String getComments()
```
    Commentaire associé au libellé du taxon.
    
    Returns:
    this.comments String
  - setComments
```
public void setComments(String commentsIn)
```
    Commentaire associé au libellé du taxon.
    
    Parameters:
    commentsIn - String
  - getCreationDate
```
public Date getCreationDate()
```
    Date de création système du libellé. Renseigné automatiquement par le système.
    
    Returns:
    this.creationDate Date
  - setCreationDate
```
public void setCreationDate(Date creationDateIn)
```
    Date de création système du libellé. Renseigné automatiquement par le système.
    
    Parameters:
    creationDateIn - Date
  - getUpdateDate
```
public Timestamp getUpdateDate()
```
    Date de mise à jour système du libellé. Renseigné automatiquement par le système.
    
    Returns:
    this.updateDate Timestamp
  - setUpdateDate
```
public void setUpdateDate(Timestamp updateDateIn)
```
    Date de mise à jour système du libellé. Renseigné automatiquement par le système.
    
    Parameters:
    updateDateIn - Timestamp
  - getCitation
```
public Citation getCitation()
```
    Deux éléments sont à distinguer dans l'autorité de classification d’un taxon : - La publication qui fait état de la description et de la nomenclature du taxon. - La citation, associée au nom du taxon, pour faire référence à la publication d'origine du taxon. Les règles de nomenclature des taxons et de leurs auteurs sont définies dans The International Code of Zoological Nomenclature (ICZN : http://www.iczn.org/iczn/index.jsp ) pour la faune, et dans The International Code of Botanical Nomenclature (ICBN : http://www.bgbm.fu-berlin.de/iapt/nomenclature/CODE/SaintLouis/0000St.Luistitle.htm) pour la flore. Chaque taxon ne possède qu'une seule publication, et une seule citation. Une publication peut correspondre à plusieurs taxons, et une citation peut être identique pour plusieurs taxons.
    
    Returns:
    this.citation Citation
  - setCitation
```
public void setCitation(Citation citationIn)
```
    Deux éléments sont à distinguer dans l'autorité de classification d’un taxon : - La publication qui fait état de la description et de la nomenclature du taxon. - La citation, associée au nom du taxon, pour faire référence à la publication d'origine du taxon. Les règles de nomenclature des taxons et de leurs auteurs sont définies dans The International Code of Zoological Nomenclature (ICZN : http://www.iczn.org/iczn/index.jsp ) pour la faune, et dans The International Code of Botanical Nomenclature (ICBN : http://www.bgbm.fu-berlin.de/iapt/nomenclature/CODE/SaintLouis/0000St.Luistitle.htm) pour la flore. Chaque taxon ne possède qu'une seule publication, et une seule citation. Une publication peut correspondre à plusieurs taxons, et une citation peut être identique pour plusieurs taxons.
    
    Parameters:
    citationIn - Citation
  - getParentTaxonName
```
public TaxonName getParentTaxonName()
```
    Classe regroupant les taxons. Il s'agit en fait d'une combinaison entre un rang taxinomique, un nom de taxon, un code et éventuellement un auteur et une date. Cette classe regroupe les taxons valides, provisoires, obsolètes, virtuels et les synonymes. On garde l'historique du passage en taxon valide, puis du passage en synonyme (date de fin référent). Dans COST : "Use the FAO reference list ftp://ftp.fao.org/FI/stat/data/ASFIS_sp.zip"
    
    Returns:
    this.parentTaxonName TaxonName
  - setParentTaxonName
```
public void setParentTaxonName(TaxonName parentTaxonNameIn)
```
    Classe regroupant les taxons. Il s'agit en fait d'une combinaison entre un rang taxinomique, un nom de taxon, un code et éventuellement un auteur et une date. Cette classe regroupe les taxons valides, provisoires, obsolètes, virtuels et les synonymes. On garde l'historique du passage en taxon valide, puis du passage en synonyme (date de fin référent). Dans COST : "Use the FAO reference list ftp://ftp.fao.org/FI/stat/data/ASFIS_sp.zip"
    
    Parameters:
    parentTaxonNameIn - TaxonName
  - getChildTaxonNames
```
public Collection<TaxonName> getChildTaxonNames()
```
    Classe regroupant les taxons. Il s'agit en fait d'une combinaison entre un rang taxinomique, un nom de taxon, un code et éventuellement un auteur et une date. Cette classe regroupe les taxons valides, provisoires, obsolètes, virtuels et les synonymes. On garde l'historique du passage en taxon valide, puis du passage en synonyme (date de fin référent). Dans COST : "Use the FAO reference list ftp://ftp.fao.org/FI/stat/data/ASFIS_sp.zip"
    
    Returns:
    this.childTaxonNames Collection
  - setChildTaxonNames
```
public void setChildTaxonNames(Collection<TaxonName> childTaxonNamesIn)
```
    Classe regroupant les taxons. Il s'agit en fait d'une combinaison entre un rang taxinomique, un nom de taxon, un code et éventuellement un auteur et une date. Cette classe regroupe les taxons valides, provisoires, obsolètes, virtuels et les synonymes. On garde l'historique du passage en taxon valide, puis du passage en synonyme (date de fin référent). Dans COST : "Use the FAO reference list ftp://ftp.fao.org/FI/stat/data/ASFIS_sp.zip"
    
    Parameters:
    childTaxonNamesIn - Collection
  - addChildTaxonNames
```
public boolean addChildTaxonNames(TaxonName elementToAdd)
```
    Classe regroupant les taxons. Il s'agit en fait d'une combinaison entre un rang taxinomique, un nom de taxon, un code et éventuellement un auteur et une date. Cette classe regroupe les taxons valides, provisoires, obsolètes, virtuels et les synonymes. On garde l'historique du passage en taxon valide, puis du passage en synonyme (date de fin référent). Dans COST : "Use the FAO reference list ftp://ftp.fao.org/FI/stat/data/ASFIS_sp.zip"
    
    Parameters:
    elementToAdd - TaxonName
    
    Returns:
    true if this collection changed as a result of the call
  - removeChildTaxonNames
```
public boolean removeChildTaxonNames(TaxonName elementToRemove)
```
    Classe regroupant les taxons. Il s'agit en fait d'une combinaison entre un rang taxinomique, un nom de taxon, un code et éventuellement un auteur et une date. Cette classe regroupe les taxons valides, provisoires, obsolètes, virtuels et les synonymes. On garde l'historique du passage en taxon valide, puis du passage en synonyme (date de fin référent). Dans COST : "Use the FAO reference list ftp://ftp.fao.org/FI/stat/data/ASFIS_sp.zip"
    
    Parameters:
    elementToRemove - TaxonName
    
    Returns:
    true if this collection changed as a result of the call
  - getParentTaxonNameHistories
```
public Collection<TaxonNameHistory> getParentTaxonNameHistories()
```
    Returns:
    this.parentTaxonNameHistories Collection
  - setParentTaxonNameHistories
```
public void setParentTaxonNameHistories(Collection<TaxonNameHistory> parentTaxonNameHistoriesIn)
```
    Parameters:
    parentTaxonNameHistoriesIn - Collection
  - addParentTaxonNameHistories
```
public boolean addParentTaxonNameHistories(TaxonNameHistory elementToAdd)
```
    Parameters:
    elementToAdd - TaxonNameHistory
    
    Returns:
    true if this collection changed as a result of the call
  - removeParentTaxonNameHistories
```
public boolean removeParentTaxonNameHistories(TaxonNameHistory elementToRemove)
```
    Parameters:
    elementToRemove - TaxonNameHistory
    
    Returns:
    true if this collection changed as a result of the call
  - getTaxonNamehistories
```
public Collection<TaxonNameHistory> getTaxonNamehistories()
```
    Returns:
    this.taxonNamehistories Collection
  - setTaxonNamehistories
```
public void setTaxonNamehistories(Collection<TaxonNameHistory> taxonNamehistoriesIn)
```
    Parameters:
    taxonNamehistoriesIn - Collection
  - addTaxonNamehistories
```
public boolean addTaxonNamehistories(TaxonNameHistory elementToAdd)
```
    Parameters:
    elementToAdd - TaxonNameHistory
    
    Returns:
    true if this collection changed as a result of the call
  - removeTaxonNamehistories
```
public boolean removeTaxonNamehistories(TaxonNameHistory elementToRemove)
```
    Parameters:
    elementToRemove - TaxonNameHistory
    
    Returns:
    true if this collection changed as a result of the call
  - getTaxonomicLevel
```
public TaxonomicLevel getTaxonomicLevel()
```
    Liste des rangs taxinomiques possibles. C’est le nom du rang dans la classification systématique ; les niveaux systématiques sont désignés par des termes consacrés (ex. : espèce, genre, famille, etc.). Le niveau systématique d’un taxon peut changer avec l’évolution de la classification ; dans ce cas, son libellé est susceptible de changer également car les suffixes notamment obéissent à des règles strictes de nomenclature (règle [R0018]). Les niveaux systématiques pris en compte dans le référentiel taxinomique Quadrige² sont (par ordre de rang) (le nom anglais de chaque niveau est indiqué entre parenthèses) : - Règne (kingdom) - Sous-règne (subkingdom) - Division (division) / Embranchement (phylum) - Subdivision (subdivision) / Sous-embranchement (subphylum) - Super-classe (superclass) - Classe (class) - Sous-classe (subclass) - Infra-classe (infraclass) - Super-ordre (superordo) - Ordre (ordo) - Sous-ordre (subordo) - Infra-ordre (infraordo) - Section (section) - Sous-section (subsection) - Super-famille (superfamily) - Famille (family) - Sous-famille (subfamily) - Tribu (tribe) - Sous-tribu (subtribe) - Genre (genus) - Sous-genre (subgenus) - Espèce (species) - Sous-espèce (subspecies) - Variété (variety) - Sous-variété (subvariety) - Forme (forma) - Sous-forme (subforma) - Incertae sedis (dummy = taxons inclassables)
    
    Returns:
    this.taxonomicLevel TaxonomicLevel
  - setTaxonomicLevel
```
public void setTaxonomicLevel(TaxonomicLevel taxonomicLevelIn)
```
    Liste des rangs taxinomiques possibles. C’est le nom du rang dans la classification systématique ; les niveaux systématiques sont désignés par des termes consacrés (ex. : espèce, genre, famille, etc.). Le niveau systématique d’un taxon peut changer avec l’évolution de la classification ; dans ce cas, son libellé est susceptible de changer également car les suffixes notamment obéissent à des règles strictes de nomenclature (règle [R0018]). Les niveaux systématiques pris en compte dans le référentiel taxinomique Quadrige² sont (par ordre de rang) (le nom anglais de chaque niveau est indiqué entre parenthèses) : - Règne (kingdom) - Sous-règne (subkingdom) - Division (division) / Embranchement (phylum) - Subdivision (subdivision) / Sous-embranchement (subphylum) - Super-classe (superclass) - Classe (class) - Sous-classe (subclass) - Infra-classe (infraclass) - Super-ordre (superordo) - Ordre (ordo) - Sous-ordre (subordo) - Infra-ordre (infraordo) - Section (section) - Sous-section (subsection) - Super-famille (superfamily) - Famille (family) - Sous-famille (subfamily) - Tribu (tribe) - Sous-tribu (subtribe) - Genre (genus) - Sous-genre (subgenus) - Espèce (species) - Sous-espèce (subspecies) - Variété (variety) - Sous-variété (subvariety) - Forme (forma) - Sous-forme (subforma) - Incertae sedis (dummy = taxons inclassables)
    
    Parameters:
    taxonomicLevelIn - TaxonomicLevel
  - getReferenceTaxon
```
public ReferenceTaxon getReferenceTaxon()
```
    Returns:
    this.referenceTaxon ReferenceTaxon
  - setReferenceTaxon
```
public void setReferenceTaxon(ReferenceTaxon referenceTaxonIn)
```
    Parameters:
    referenceTaxonIn - ReferenceTaxon
  - equals
```
public boolean equals(Object object)
```
    Returns true if the argument is an TaxonName instance and all identifiers for this entity equal the identifiers of the argument entity. Returns false otherwise.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Returns a hash code based on this entity's identifiers.
    
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(TaxonName o)
```
    Specified by:
    
    compareTo in interface Comparable<TaxonName>
    
    See Also:
    Comparable.compareTo(T)

Class TaxonName

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

TaxonName

Method Detail

getId

setId

getName

setName

getCompleteName

setCompleteName

isIsNaming

setIsNaming

isIsReferent

setIsReferent

getUpperRank

setUpperRank

isIsVirtual

setIsVirtual

isIsObsolete

setIsObsolete

isIsTemporary

setIsTemporary

getStartDate

setStartDate

getEndDate

setEndDate

getComments

setComments

getCreationDate

setCreationDate

getUpdateDate

setUpdateDate

getCitation

setCitation

getParentTaxonName

setParentTaxonName

getChildTaxonNames

setChildTaxonNames

addChildTaxonNames

removeChildTaxonNames

getParentTaxonNameHistories

setParentTaxonNameHistories

addParentTaxonNameHistories

removeParentTaxonNameHistories

getTaxonNamehistories

setTaxonNamehistories

addTaxonNamehistories

removeTaxonNamehistories

getTaxonomicLevel

setTaxonomicLevel

getReferenceTaxon

setReferenceTaxon

equals

hashCode

compareTo