2 * Copyright (C) 2007 EDIT
3 * European Distributed Institute of Taxonomy
4 * http://www.e-taxonomy.eu
6 * The contents of this file are subject to the Mozilla Public License Version 1.1
7 * See LICENSE.TXT at the top of this package for the full license terms.
10 package eu
.etaxonomy
.cdm
.model
.name
;
12 import java
.util
.HashMap
;
13 import java
.util
.List
;
15 import java
.util
.UUID
;
17 import javax
.persistence
.Entity
;
18 import javax
.persistence
.Enumerated
;
19 import javax
.persistence
.Transient
;
20 import javax
.validation
.constraints
.NotNull
;
21 import javax
.xml
.bind
.annotation
.XmlAccessType
;
22 import javax
.xml
.bind
.annotation
.XmlAccessorType
;
23 import javax
.xml
.bind
.annotation
.XmlAttribute
;
24 import javax
.xml
.bind
.annotation
.XmlType
;
26 import org
.apache
.log4j
.Logger
;
27 import org
.hibernate
.annotations
.Type
;
28 import org
.hibernate
.envers
.Audited
;
29 import org
.hibernate
.search
.annotations
.Indexed
;
31 import eu
.etaxonomy
.cdm
.common
.CdmUtils
;
32 import eu
.etaxonomy
.cdm
.model
.common
.DefinedTermBase
;
33 import eu
.etaxonomy
.cdm
.model
.common
.Language
;
34 import eu
.etaxonomy
.cdm
.model
.common
.OrderedTermBase
;
35 import eu
.etaxonomy
.cdm
.model
.common
.Representation
;
36 import eu
.etaxonomy
.cdm
.model
.common
.TermType
;
37 import eu
.etaxonomy
.cdm
.model
.common
.TermVocabulary
;
38 import eu
.etaxonomy
.cdm
.strategy
.exceptions
.UnknownCdmTypeException
;
41 * The class representing the taxonomical ranks (like "Family", "Genus" or
42 * "Species") used for {@link TaxonNameBase taxon names} across all {@link NomenclaturalCode nomenclatural codes}
43 * for bacteria (ICNB), viruses (ICVCN), plants and fungi (ICBN),
44 * cultivars (ICNCP) and animals (ICZN).
46 * A standard (ordered) list of taxonomical rank instances will be automatically
47 * created as the project starts. But this class allows to extend this standard
48 * list by creating new instances of additional taxonomical ranks if needed.
50 * This class corresponds to: <ul>
51 * <li> TaxonRankTerm according to the TDWG ontology
52 * <li> TaxonomicRankEnum according to the TCS
53 * <li> Rank according to the ABCD schema
58 * @created 08-Nov-2007 13:06:46
60 @XmlAccessorType(XmlAccessType
.FIELD
)
61 @XmlType(name
= "Rank")
63 @Indexed(index
= "eu.etaxonomy.cdm.model.common.DefinedTermBase")
65 public class Rank
extends OrderedTermBase
<Rank
> {
66 private static final long serialVersionUID
= -8648081681348758485L;
67 private static final Logger logger
= Logger
.getLogger(Rank
.class);
69 private static final UUID uuidEmpire
= UUID
.fromString("ac470211-1586-4b24-95ca-1038050b618d");
70 private static final UUID uuidDomain
= UUID
.fromString("ffca6ec8-8b88-417b-a6a0-f7c992aac19b");
71 private static final UUID uuidSuperkingdom
= UUID
.fromString("64223610-7625-4cfd-83ad-b797bf7f0edd");
72 private static final UUID uuidKingdom
= UUID
.fromString("fbe7109d-66b3-498c-a697-c6c49c686162");
73 private static final UUID uuidSubkingdom
= UUID
.fromString("a71bd9d8-f3ab-4083-afb5-d89315d71655");
74 private static final UUID uuidInfrakingdom
= UUID
.fromString("1e37930c-86cf-44f6-90fd-7822928df260");
75 private static final UUID uuidSuperphylum
= UUID
.fromString("0d0cecb1-e254-4607-b210-6801e7ecbb04");
76 private static final UUID uuidPhylum
= UUID
.fromString("773430d2-76b4-438c-b817-97a543a33287");
77 private static final UUID uuidSubphylum
= UUID
.fromString("23a9b6ff-9408-49c9-bd9e-7a2ca5ab4725");
78 private static final UUID uuidInfraphylum
= UUID
.fromString("1701de3a-7693-42a5-a2d3-42697f944190");
79 private static final UUID uuidSuperdivision
= UUID
.fromString("a735a48f-4fc8-49a7-ae0c-6a984f658131");
80 private static final UUID uuidDivision
= UUID
.fromString("7e56f5cc-123a-4fd1-8cbb-6fd80358b581");
81 private static final UUID uuidSubdivision
= UUID
.fromString("931c840f-7a6b-4d76-ad38-bfdd77d7b2e8");
82 private static final UUID uuidInfradivision
= UUID
.fromString("c0ede273-be52-4dee-b411-66ee08d30c94");
83 private static final UUID uuidSuperclass
= UUID
.fromString("e65b4e1a-21ec-428d-9b9f-e87721ab967c");
84 private static final UUID uuidClass
= UUID
.fromString("f23d14c4-1d34-4ee6-8b4e-eee2eb9a3daf");
85 private static final UUID uuidSubclass
= UUID
.fromString("8cb26733-e2f5-46cb-ab5c-f99254f877aa");
86 private static final UUID uuidInfraclass
= UUID
.fromString("ad23cfda-879a-4021-8629-c54d27caf717");
87 private static final UUID uuidSuperorder
= UUID
.fromString("c8c67a22-301a-4219-b882-4a49121232ff");
88 private static final UUID uuidOrder
= UUID
.fromString("b0785a65-c1c1-4eb4-88c7-dbd3df5aaad1");
89 private static final UUID uuidSuborder
= UUID
.fromString("768ad378-fa85-42ab-b668-763225832f57");
90 private static final UUID uuidInfraorder
= UUID
.fromString("84099182-a6f5-47d7-8586-33c9e9955a10");
91 private static final UUID uuidSectionZoology
= UUID
.fromString("691d371e-10d7-43f0-93db-3d7fa1a62c54");
92 private static final UUID uuidSubsectionZoology
= UUID
.fromString("0ed32d28-adc4-4303-a9ca-68e2acd67e33");
93 private static final UUID uuidSuperfamily
= UUID
.fromString("2cfa510a-dcea-4a03-b66a-b1528f9b0796");
94 private static final UUID uuidFamily
= UUID
.fromString("af5f2481-3192-403f-ae65-7c957a0f02b6");
95 private static final UUID uuidSubfamily
= UUID
.fromString("862526ee-7592-4760-a23a-4ff3641541c5");
96 private static final UUID uuidInfrafamily
= UUID
.fromString("c3f2e3bb-6eef-4a26-9fb7-b14f4c8c5e4f");
97 private static final UUID uuidSupertribe
= UUID
.fromString("11e94828-8c61-499b-87d6-1de35ce2c51c");
98 private static final UUID uuidTribe
= UUID
.fromString("4aa6890b-0363-4899-8d7c-ee0cb78e6166");
99 private static final UUID uuidSubtribe
= UUID
.fromString("ae41ecc5-5165-4126-9d24-79939ae5d822");
100 private static final UUID uuidInfratribe
= UUID
.fromString("1ec02e8f-f2b7-4c65-af9f-b436b34c79a3");
101 private static final UUID uuidSupragenericTaxon
= UUID
.fromString("1fdc0b93-c354-441a-8406-091e0303ff5c");
102 public static final UUID uuidGenus
= UUID
.fromString("1b11c34c-48a8-4efa-98d5-84f7f66ef43a");
103 private static final UUID uuidSubgenus
= UUID
.fromString("78786e16-2a70-48af-a608-494023b91904");
104 private static final UUID uuidInfragenus
= UUID
.fromString("a9972969-82cd-4d54-b693-a096422f13fa");
105 private static final UUID uuidSectionBotany
= UUID
.fromString("3edff68f-8527-49b5-bf91-7e4398bb975c");
106 private static final UUID uuidSubsectionBotany
= UUID
.fromString("d20f5b61-d463-4448-8f8a-c1ff1f262f59");
107 private static final UUID uuidSeries
= UUID
.fromString("d7381ecf-48f8-429b-9c54-f461656978cd");
108 private static final UUID uuidSubseries
= UUID
.fromString("80c9a263-f4db-4a13-b6c2-b7fec1aa1200");
109 private static final UUID uuidSpeciesAggregate
= UUID
.fromString("1ecae058-4217-4f75-9c27-6d8ba099ac7a");
110 private static final UUID uuidSpeciesGroup
= UUID
.fromString("d1988a11-292b-46fa-8fb7-bc64ea6d8fc6");
111 public static final UUID uuidInfragenericTaxon
= UUID
.fromString("41bcc6ac-37d3-4fd4-bb80-3cc5b04298b9");
112 public static final UUID uuidSpecies
= UUID
.fromString("b301f787-f319-4ccc-a10f-b4ed3b99a86d");
113 private static final UUID uuidSubspecificAggregate
= UUID
.fromString("72c248b9-027d-4402-b375-dd4f0850c9ad");
114 private static final UUID uuidSubspecies
= UUID
.fromString("462a7819-8b00-4190-8313-88b5be81fad5");
115 private static final UUID uuidInfraspecies
= UUID
.fromString("f28ebc9e-bd50-4194-9af1-42f5cb971a2c");
116 private static final UUID uuidNatio
= UUID
.fromString("965f2f38-7f97-4270-ab5a-1999bf050a22");
117 private static final UUID uuidVariety
= UUID
.fromString("d5feb6a5-af5c-45ef-9878-bb4f36aaf490");
118 private static final UUID uuidBioVariety
= UUID
.fromString("a3a364cb-1a92-43fc-a717-3c44980a0991");
119 private static final UUID uuidPathoVariety
= UUID
.fromString("2f4f4303-a099-47e3-9048-d749d735423b");
120 private static final UUID uuidSubvariety
= UUID
.fromString("9a83862a-7aee-480c-a98d-4bceaf8712ca");
121 private static final UUID uuidSubsubvariety
= UUID
.fromString("bff22f84-553a-4429-a4e7-c4b3796c3a18");
123 private static final UUID uuidProles
= UUID
.fromString("8810d1ba-6a34-4ae3-a355-919ccd1cd1a5");
124 private static final UUID uuidRace
= UUID
.fromString("196dee39-cfd8-4460-8bf0-88b83da27f62");
125 private static final UUID uuidSublusus
= UUID
.fromString("1fafa596-a8e7-4e62-a378-3cc8cb3627ca");
127 private static final UUID uuidConvar
= UUID
.fromString("2cc740c9-cebb-43c8-9b06-1bef79e6a56a");
128 private static final UUID uuidForm
= UUID
.fromString("0461281e-458a-47b9-8d41-19a3d39356d5");
129 private static final UUID uuidSpecialForm
= UUID
.fromString("bed20aee-2f5a-4635-9c02-eff06246d067");
130 private static final UUID uuidSubform
= UUID
.fromString("47cfc5b0-0fb7-4ceb-b61d-e1dd8de8b569");
131 private static final UUID uuidSubsubform
= UUID
.fromString("1c8ac389-4349-4ae0-87be-7239f6635068");
132 public static final UUID uuidInfraspecificTaxon
= UUID
.fromString("eb75c27d-e154-4570-9d96-227b2df60474");
133 private static final UUID uuidCandidate
= UUID
.fromString("ead9a1f5-dfd4-4de2-9121-70a47accb10b");
134 private static final UUID uuidDenominationClass
= UUID
.fromString("49bdf74a-2170-40ed-8be2-887a0db517bf");
135 private static final UUID uuidGrex
= UUID
.fromString("08dcb4ff-ac58-48a3-93af-efb3d836ac84");
136 private static final UUID uuidGraftChimaera
= UUID
.fromString("6b4063bc-f934-4796-9bf3-0ef3aea5c1cb");
137 private static final UUID uuidCultivarGroup
= UUID
.fromString("d763e7d3-e7de-4bb1-9d75-225ca6948659");
138 private static final UUID uuidCultivar
= UUID
.fromString("5e98415b-dc6e-440b-95d6-ea33dbb39ad0");
139 private static final UUID uuidUnknownRank
= UUID
.fromString("5c4d6755-2cf6-44ca-9220-cccf8881700b");
141 private static Map
<String
, UUID
> abbrevMap
= null;
142 private static Map
<String
, UUID
> labelMap
= null;
144 protected static Map
<UUID
, Rank
> termMap
= null;
146 //*********************** Factory methods ********************************************/
149 // * Creates a new empty rank.
151 // * @see #NewInstance(String, String, String)
153 // private static Rank NewInstance(){
154 // return new Rank();
158 * Creates an additional rank with a description (in the {@link Language#DEFAULT() default language}),
159 * a label and a label abbreviation.
161 * @param term the string (in the default language) describing the
162 * new rank to be created
163 * @param label the string identifying the new rank to be created
164 * @param labelAbbrev the string identifying (in abbreviated form) the
165 * new rank to be created
166 * @see #NewInstance()
168 public static Rank
NewInstance(RankClass rankClass
, String term
, String label
, String labelAbbrev
){
169 return new Rank(rankClass
, term
, label
, labelAbbrev
);
173 * The {@link RankClass rank class} of a rank. It is usually needed for correct formatting of a
174 * rank by using e.g. isSupraGeneric(). Prior to v3.3 this was computed by comparison of ranks.
176 @XmlAttribute(name
="RankClass")
178 @Enumerated //TODO use UserType
179 @Type(type
= "eu.etaxonomy.cdm.hibernate.EnumUserType",
180 parameters
= {@org.hibernate
.annotations
.Parameter(name
="enumClass", value
="eu.etaxonomy.cdm.model.name.RankClass")}
182 private RankClass rankClass
;
185 // ********************* CONSTRUCTORS ************************************+/
187 //for hibernate use only
191 * Class constructor: creates an additional rank instance with a description
192 * (in the {@link eu.etaxonomy.cdm.model.common.Language#DEFAULT() default language}), a label and a label abbreviation.
194 * @param term the string (in the default language) describing the
195 * new rank to be created
196 * @param label the string identifying the new rank to be created
197 * @param labelAbbrev the string identifying (in abbreviated form) the
198 * new rank to be created
201 protected Rank(RankClass rankClass
, String term
, String label
, String labelAbbrev
) {
202 super(TermType
.Rank
, term
, label
, labelAbbrev
);
203 this.rankClass
= rankClass
;
207 //********* METHODS **************************************/
210 * @see eu.etaxonomy.cdm.model.common.DefinedTermBase#resetTerms()
213 public void resetTerms(){
219 protected static Rank
getTermByUuid(UUID uuid
){
220 if (termMap
== null){
221 return null; //better return null then initialize the termMap in an unwanted way
223 return (Rank
)termMap
.get(uuid
);
226 public static final Rank
EMPIRE(){
227 return getTermByUuid(uuidEmpire
);
229 public static final Rank
DOMAIN(){
230 return getTermByUuid(uuidDomain
);
232 public static final Rank
SUPERKINGDOM(){
233 return getTermByUuid(uuidSuperkingdom
);
235 public static final Rank
KINGDOM(){
236 return getTermByUuid(uuidKingdom
);
238 public static final Rank
SUBKINGDOM(){
239 return getTermByUuid(uuidSubkingdom
);
241 public static final Rank
INFRAKINGDOM(){
242 return getTermByUuid(uuidInfrakingdom
);
244 public static final Rank
SUPERPHYLUM(){
245 return getTermByUuid(uuidSuperphylum
);
247 public static final Rank
PHYLUM(){
248 return getTermByUuid(uuidPhylum
);
250 public static final Rank
SUBPHYLUM(){
251 return getTermByUuid(uuidSubphylum
);
253 public static final Rank
INFRAPHYLUM(){
254 return getTermByUuid(uuidInfraphylum
);
256 public static final Rank
SUPERDIVISION(){
257 return getTermByUuid(uuidSuperdivision
);
259 public static final Rank
DIVISION(){
260 return getTermByUuid(uuidDivision
);
262 public static final Rank
SUBDIVISION(){
263 return getTermByUuid(uuidSubdivision
);
265 public static final Rank
INFRADIVISION(){
266 return getTermByUuid(uuidInfradivision
);
268 public static final Rank
SUPERCLASS(){
269 return getTermByUuid(uuidSuperclass
);
271 public static final Rank
CLASS(){
272 return getTermByUuid(uuidClass
);
274 public static final Rank
SUBCLASS(){
275 return getTermByUuid(uuidSubclass
);
277 public static final Rank
INFRACLASS(){
278 return getTermByUuid(uuidInfraclass
);
280 public static final Rank
SUPERORDER(){
281 return getTermByUuid(uuidSuperorder
);
283 public static final Rank
ORDER(){
284 return getTermByUuid(uuidOrder
);
286 public static final Rank
SUBORDER(){
287 return getTermByUuid(uuidSuborder
);
289 public static final Rank
INFRAORDER(){
290 return getTermByUuid(uuidInfraorder
);
292 public static final Rank
SUPERFAMILY(){
293 return getTermByUuid(uuidSuperfamily
);
295 public static final Rank
FAMILY(){
296 return getTermByUuid(uuidFamily
);
298 public static final Rank
SUBFAMILY(){
299 return getTermByUuid(uuidSubfamily
);
301 public static final Rank
INFRAFAMILY(){
302 return getTermByUuid(uuidInfrafamily
);
304 public static final Rank
SUPERTRIBE(){
305 return getTermByUuid(uuidSupertribe
);
307 public static final Rank
TRIBE(){
308 return getTermByUuid(uuidTribe
);
310 public static final Rank
SUBTRIBE(){
311 return getTermByUuid(uuidSubtribe
);
313 public static final Rank
INFRATRIBE(){
314 return getTermByUuid(uuidInfratribe
);
316 public static final Rank
SUPRAGENERICTAXON(){
317 return getTermByUuid(uuidSupragenericTaxon
);
319 public static final Rank
GENUS(){
320 return getTermByUuid(uuidGenus
);
322 public static final Rank
SUBGENUS(){
323 return getTermByUuid(uuidSubgenus
);
325 public static final Rank
INFRAGENUS(){
326 return getTermByUuid(uuidInfragenus
);
328 public static final Rank
SECTION_BOTANY(){
329 return getTermByUuid(uuidSectionBotany
);
331 public static final Rank
SUBSECTION_BOTANY(){
332 return getTermByUuid(uuidSubsectionBotany
);
334 public static final Rank
SECTION_ZOOLOGY(){
335 return getTermByUuid(uuidSectionZoology
);
337 public static final Rank
SUBSECTION_ZOOLOGY(){
338 return getTermByUuid(uuidSubsectionZoology
);
340 public static final Rank
SERIES(){
341 return getTermByUuid(uuidSeries
);
343 public static final Rank
SUBSERIES(){
344 return getTermByUuid(uuidSubseries
);
346 public static final Rank
SPECIESAGGREGATE(){
347 return getTermByUuid(uuidSpeciesAggregate
);
349 public static final Rank
SPECIESGROUP(){
350 return getTermByUuid(uuidSpeciesGroup
);
353 * 'Unranked infrageneric'. An infrageneric rank which is on purpose not further defined.
354 * This sometimes holds for names from the 19th century.
356 public static final Rank
INFRAGENERICTAXON(){
357 return getTermByUuid(uuidInfragenericTaxon
);
359 public static final Rank
SPECIES(){
360 return getTermByUuid(uuidSpecies
);
362 public static final Rank
SUBSPECIFICAGGREGATE(){
363 return getTermByUuid(uuidSubspecificAggregate
);
365 public static final Rank
SUBSPECIES(){
366 return getTermByUuid(uuidSubspecies
);
368 public static final Rank
INFRASPECIES(){
369 return getTermByUuid(uuidInfraspecies
);
371 public static final Rank
VARIETY(){
372 return getTermByUuid(uuidVariety
);
374 public static final Rank
BIOVARIETY(){
375 return getTermByUuid(uuidBioVariety
);
377 public static final Rank
PATHOVARIETY(){
378 return getTermByUuid(uuidPathoVariety
);
380 public static final Rank
SUBVARIETY(){
381 return getTermByUuid(uuidSubvariety
);
383 public static final Rank
SUBSUBVARIETY(){
384 return getTermByUuid(uuidSubsubvariety
);
386 public static final Rank
PROLES(){
387 return getTermByUuid(uuidProles
);
389 public static final Rank
RACE(){
390 return getTermByUuid(uuidRace
);
392 public static final Rank
SUBLUSUS(){
393 return getTermByUuid(uuidSublusus
);
396 public static final Rank
CONVAR(){
397 return getTermByUuid(uuidConvar
);
399 public static final Rank
FORM(){
400 return getTermByUuid(uuidForm
);
402 public static final Rank
SPECIALFORM(){
403 return getTermByUuid(uuidSpecialForm
);
405 public static final Rank
SUBFORM(){
406 return getTermByUuid(uuidSubform
);
408 public static final Rank
SUBSUBFORM(){
409 return getTermByUuid(uuidSubsubform
);
412 * 'Unranked infraspecific'. An infraspecific rank which is on purpose not further defined.
413 * This sometimes holds for names from the 19th century.
415 public static final Rank
INFRASPECIFICTAXON(){
416 return getTermByUuid(uuidInfraspecificTaxon
);
418 public static final Rank
CANDIDATE(){
419 return getTermByUuid(uuidCandidate
);
421 public static final Rank
DENOMINATIONCLASS(){
422 return getTermByUuid(uuidDenominationClass
);
424 public static final Rank
GREX(){
425 return getTermByUuid(uuidGrex
);
427 public static final Rank
GRAFTCHIMAERA(){
428 return getTermByUuid(uuidGraftChimaera
);
430 public static final Rank
CULTIVARGROUP(){
431 return getTermByUuid(uuidCultivarGroup
);
433 public static final Rank
CULTIVAR(){
434 return getTermByUuid(uuidCultivar
);
436 public static final Rank
UNKNOWN_RANK(){
437 return getTermByUuid(uuidUnknownRank
);
439 public static final Rank
NATIO(){
440 return getTermByUuid(uuidNatio
);
443 * @see #INFRASPECIFICTAXON()
445 public static final Rank
UNRANKED_INFRASPECIFIC(){
446 return getTermByUuid(uuidInfraspecificTaxon
);
449 * @see #INFRAGENERICTAXON()
451 public static final Rank
UNRANKED_INFRAGENERIC(){
452 return getTermByUuid(uuidInfragenericTaxon
);
455 // ************************ GETTER / SETTER **********************************/
457 public RankClass
getRankClass() {
461 public void setRankClass(RankClass rankClass
) {
462 this.rankClass
= rankClass
;
465 // ******************************** METHODS ***************************************/
468 * Returns the boolean value indicating whether <i>this</i> rank is higher than
469 * the genus rank (true) or not (false). Returns false if <i>this</i> rank is null.
472 * @see #isInfraGeneric()
474 * @see #isInfraSpecific()
477 public boolean isSupraGeneric(){
478 return this.rankClass
.equals(RankClass
.Suprageneric
); // (this.isHigher(Rank.GENUS()));
482 * Returns the boolean value indicating whether <i>this</i> rank is the genus rank
483 * (true) or not (false). Returns false if <i>this</i> rank is null.
485 * @see #isSupraGeneric()
486 * @see #isInfraGeneric()
488 * @see #isInfraSpecific()
491 public boolean isGenus(){
492 return this.rankClass
.equals(RankClass
.Genus
); // (this.equals(Rank.GENUS()));
496 * Returns the boolean value indicating whether <i>this</i> rank is higher than the
497 * species rank and lower than the genus rank (true) or not (false). Species groups or
498 * aggregates are also handled as infrageneric ranks.
499 * Returns false if <i>this</i> rank is null.
501 * @see #isSupraGeneric()
503 * @see #isSpeciesAggregate()
505 * @see #isInfraSpecific()
508 public boolean isInfraGeneric(){
509 return this.rankClass
.equals(RankClass
.Infrageneric
) || this.rankClass
.equals(RankClass
.SpeciesGroup
) ; //(this.isLower(Rank.GENUS()) && this.isHigher(Rank.SPECIES()));
513 * Returns true if this rank indicates a rank that aggregates species
514 * like species aggregates or species groups, false otherwise. This methods
515 * currently returns false for all user defined ranks.
519 public boolean isSpeciesAggregate(){
520 return this.rankClass
.equals(RankClass
.SpeciesGroup
); //(this.equals(Rank.SPECIESAGGREGATE()) || (this.isLower(Rank.SPECIESAGGREGATE()) && this.isHigher(Rank.SPECIES())));
524 * Returns the boolean value indicating whether <i>this</i> rank is the species
525 * rank (true) or not (false). Returns false if <i>this</i> rank is null.
527 * @see #isSupraGeneric()
529 * @see #isInfraGeneric()
530 * @see #isInfraSpecific()
533 public boolean isSpecies(){
534 return this.rankClass
.equals(RankClass
.Species
); //(this.equals(Rank.SPECIES()));
538 * Returns the boolean value indicating whether <i>this</i> rank is lower than the
539 * species rank (true) or not (false). Returns false if <i>this</i> rank is null.
541 * @see #isSupraGeneric()
543 * @see #isInfraGeneric()
547 public boolean isInfraSpecific(){
548 return this.rankClass
.equals(RankClass
.Infraspecific
); // (this.isLower(Rank.SPECIES()));
553 * Returns the rank identified through a name (abbreviated or not).
554 * Preliminary implementation for BotanicalNameParser.
556 * @param strRank the string identifying the rank
559 public static Rank
getRankByNameOrAbbreviation(String strRank
) throws UnknownCdmTypeException
{
560 return getRankByNameOrAbbreviation(strRank
, false);
564 * Returns the rank identified through a name (abbreviated or not) for a given nomenclatural code.
565 * Preliminary implementation for BotanicalNameParser.
567 * @param strRank the string identifying the rank
568 * @param nc the nomenclatural code
571 public static Rank
getRankByNameOrAbbreviation(String strRank
, NomenclaturalCode nc
)
572 throws UnknownCdmTypeException
{
573 return getRankByNameOrAbbreviation(strRank
, nc
, false);
577 // Preliminary implementation for BotanicalNameParser.
580 * Returns the rank identified through a name (abbreviated or not).
581 * Preliminary implementation for BotanicalNameParser.
583 * @param strRank the string identifying the rank
584 * @param useUnknown if true the rank UNKNOWN_RANK is returned if the abbrev is
585 * unknown or not yet implemented
588 public static Rank
getRankByNameOrAbbreviation(String strRank
, boolean useUnknown
)
589 throws UnknownCdmTypeException
{
591 return getRankByAbbreviation(strRank
);
592 } catch (UnknownCdmTypeException e
) {
593 return getRankByName(strRank
, useUnknown
);
598 // Preliminary implementation for BotanicalNameParser.
601 * Returns the rank identified through a name (abbreviated or not).
602 * Preliminary implementation for BotanicalNameParser.
604 * @param strRank the string identifying the rank
605 * @param nc the nomenclatural code
606 * @param useUnknown if true the rank UNKNOWN_RANK is returned if the abbrev is
607 * unknown or not yet implemented
610 public static Rank
getRankByNameOrAbbreviation(String strRank
, NomenclaturalCode nc
, boolean useUnknown
)
611 throws UnknownCdmTypeException
{
613 return getRankByAbbreviation(strRank
, nc
);
614 } catch (UnknownCdmTypeException e
) {
615 return getRankByName(strRank
, nc
, useUnknown
);
620 * Returns the rank identified through an abbreviated name.
621 * Preliminary implementation for BotanicalNameParser.<BR>
622 * Note: For abbrev = "[unranked]" the result is undefined.
623 * It maybe the infrageneric unranked or the infraspecific unranked.
624 * You need to define by context which one is correct.
626 * @param abbrev the string for the name abbreviation
629 public static Rank
getRankByAbbreviation(String abbrev
)
630 throws UnknownCdmTypeException
{
631 return getRankByAbbreviation(abbrev
, false);
635 * Returns the rank identified through an abbreviated name for a given nomenclatural code.
636 * See also {@link #getRankByAbbreviation(String, boolean)}
638 * @param abbrev the string for the name abbreviation
639 * @param nc the nomenclatural code
642 public static Rank
getRankByAbbreviation(String abbrev
, NomenclaturalCode nc
) throws UnknownCdmTypeException
{
643 return getRankByAbbreviation(abbrev
, nc
, false);
647 // Preliminary implementation for BotanicalNameParser.
650 * Returns the rank identified through an abbreviated representation.
651 * At the moment it uses the English abbreviations (being Latin because
652 * we do not have Latin representations yet.
654 * If no according abbreviation is available it throws either an UnknownCdmTypeException
655 * or an #Rank.UNKNOWN() object depending on the useUnknown flag.
657 * @param abbrev the string for the name abbreviation
658 * @param useUnknown if true the rank UNKNOWN_RANK is returned if the abbrev is
659 * unknown or not yet existent
662 public static Rank
getRankByAbbreviation(String abbrev
, boolean useUnknown
) throws UnknownCdmTypeException
{
665 throw new NullPointerException("Abbrev is NULL in getRankByAbbreviation");
667 if (abbrev
.trim().equals("")){
668 //handle empty abbrev as unknown
669 abbrev
= "oija�m��";
671 if (abbrevMap
== null){
674 UUID uuid
= abbrevMap
.get(abbrev
);
676 result
= getTermByUuid(uuid
);
685 logger
.info("Unknown rank name: " + abbrev
+ ". Rank 'UNKNOWN_RANK' created instead");
686 return Rank
.UNKNOWN_RANK();
688 throw new UnknownCdmTypeException("Unknown rank abbreviation: " + abbrev
);
694 // Preliminary implementation to cover Botany and Zoology.
696 * Returns the rank identified through an abbreviated name for a given nomenclatural code.
697 * Preliminary implementation for ICBN and ICZN.
698 * See also {@link #getRankByAbbreviation(String, boolean)}
701 * @param abbrev the string for the name abbreviation
702 * @param nc the nomenclatural code
703 * @param useUnknown if true the rank UNKNOWN_RANK is returned if the abbrev is
704 * unknown or not yet implemented
707 public static Rank
getRankByAbbreviation(String abbrev
, NomenclaturalCode nc
, boolean useUnknown
)
708 throws UnknownCdmTypeException
{
710 if (nc
!= null && nc
.equals(NomenclaturalCode
.ICZN
)) {
712 if (abbrev
.equalsIgnoreCase("sect.")) {
713 return Rank
.SECTION_ZOOLOGY();
714 } else if (abbrev
.equalsIgnoreCase("subsect.")) {
715 return Rank
.SUBSECTION_ZOOLOGY();
719 return getRankByAbbreviation(abbrev
, useUnknown
);
723 // Preliminary implementation for BotanicalNameParser.
726 * Returns the rank identified through a name.
727 * Preliminary implementation for BotanicalNameParser.
729 * @param rankName the string for the name of the rank
732 public static Rank
getRankByName(String rankName
) throws UnknownCdmTypeException
{
733 return getRankByName(rankName
, false);
738 // Preliminary implementation for ICBN and ICZN.
741 * Returns the rank identified through a name for a given nomenclatural code.
742 * Preliminary implementation for ICBN and ICZN.
744 * @param rankName the string for the name of the rank
745 * @param nc the nomenclatural code
748 public static Rank
getRankByName(String rankName
, NomenclaturalCode nc
) throws UnknownCdmTypeException
{
749 return getRankByName(rankName
, nc
, false);
753 * Returns the rank identified through a name.
754 * Preliminary implementation for BotanicalNameParser.
755 * TODO At the moment we do not have Latin representations yet.
757 * @param rankName the string for the name of the rank
758 * @param useUnknown if true the rank UNKNOWN_RANK is returned if the rank name is
759 * unknown or not yet implemented
762 public static Rank
getRankByName(String rankName
, boolean useUnknown
)
763 throws UnknownCdmTypeException
{
764 if (rankName
.equalsIgnoreCase("Regnum")){ return Rank
.KINGDOM();
765 }else if (rankName
.equalsIgnoreCase("Subregnum")){ return Rank
.SUBKINGDOM();
766 }else if (rankName
.equalsIgnoreCase("Phylum")){ return Rank
.PHYLUM();
767 }else if (rankName
.equalsIgnoreCase("Subphylum")){ return Rank
.SUBPHYLUM();
768 }else if (rankName
.equalsIgnoreCase("Divisio")){ return Rank
.DIVISION();
769 }else if (rankName
.equalsIgnoreCase("Subdivisio")){ return Rank
.SUBDIVISION();
770 }else if (rankName
.equalsIgnoreCase("Classis")){ return Rank
.CLASS();
771 }else if (rankName
.equalsIgnoreCase("Subclassis")){ return Rank
.SUBCLASS();
772 }else if (rankName
.equalsIgnoreCase("Superordo")){ return Rank
.SUPERORDER();
773 }else if (rankName
.equalsIgnoreCase("Ordo")){ return Rank
.ORDER();
774 }else if (rankName
.equalsIgnoreCase("Subordo")){ return Rank
.SUBORDER();
775 }else if (rankName
.equalsIgnoreCase("Familia")){ return Rank
.FAMILY();
776 }else if (rankName
.equalsIgnoreCase("Subfamilia")){ return Rank
.SUBFAMILY();
777 }else if (rankName
.equalsIgnoreCase("Tribus")){ return Rank
.TRIBE();
778 }else if (rankName
.equalsIgnoreCase("Subtribus")){ return Rank
.SUBTRIBE();
779 }else if (rankName
.equalsIgnoreCase("Genus")){ return Rank
.GENUS();
780 }else if (rankName
.equalsIgnoreCase("Subgenus")){ return Rank
.SUBGENUS();
781 }else if (rankName
.equalsIgnoreCase("Sectio")){ return Rank
.SECTION_BOTANY();
782 }else if (rankName
.equalsIgnoreCase("Subsectio")){ return Rank
.SUBSECTION_BOTANY();
783 }else if (rankName
.equalsIgnoreCase("Series")){ return Rank
.SERIES();
784 }else if (rankName
.equalsIgnoreCase("Subseries")){ return Rank
.SUBSERIES();
785 }else if (rankName
.equalsIgnoreCase("Aggregate")){ return Rank
.SPECIESAGGREGATE();
786 }else if (rankName
.equalsIgnoreCase("Speciesgroup")){ return Rank
.SPECIESGROUP();
787 }else if (rankName
.equalsIgnoreCase("Species")){ return Rank
.SPECIES();
788 }else if (rankName
.equalsIgnoreCase("Subspecies")){ return Rank
.SUBSPECIES();
789 }else if (rankName
.equalsIgnoreCase("Convarietas")){ return Rank
.CONVAR();
790 }else if (rankName
.equalsIgnoreCase("Varietas")){ return Rank
.VARIETY();
791 }else if (rankName
.equalsIgnoreCase("Subvarietas")){ return Rank
.SUBVARIETY();
792 }else if (rankName
.equalsIgnoreCase("Forma")){ return Rank
.FORM();
793 }else if (rankName
.equalsIgnoreCase("Subforma")){ return Rank
.SUBFORM();
794 }else if (rankName
.equalsIgnoreCase("Forma spec.")){ return Rank
.SPECIALFORM();
795 }else if (rankName
.equalsIgnoreCase("tax.infragen.")){ return Rank
.INFRAGENERICTAXON();
796 }else if (rankName
.equalsIgnoreCase("tax.infrasp.")){ return Rank
.INFRASPECIFICTAXON();
798 }else if (rankName
.equalsIgnoreCase("proles")){ return Rank
.PROLES();
799 }else if (rankName
.equalsIgnoreCase("race")){ return Rank
.RACE();
800 }else if (rankName
.equalsIgnoreCase("sublusus")){ return Rank
.SUBLUSUS();
802 }else if (rankName
.equalsIgnoreCase("taxon")){ return Rank
.INFRASPECIFICTAXON(); //to create the name put 'taxon' and the infraspeciesepi to the field unnamed namephrase
805 if (rankName
== null){
806 rankName
= "(null)"; //see NPE above
809 logger
.info("Unknown rank name: " + rankName
+". Rank 'UNKNOWN_RANK' created instead");
810 return Rank
.UNKNOWN_RANK();
812 throw new UnknownCdmTypeException("Unknown rank name: " + rankName
);
818 * Defines the rank according to the English name.
819 * @param rankName English rank name.
820 * @param nc Defines the handling of the section and subsection ranks. These are in different orders depending on the
821 * nomenclatural code.
822 * @param useUnknown if true, the "Unknown" rank is returned as a placeholder.
824 * @throws UnknownCdmTypeException never thrown if useUnknown is true
826 public static Rank
getRankByEnglishName(String rankName
, NomenclaturalCode nc
, boolean useUnknown
) throws UnknownCdmTypeException
{
828 if (rankName
== null){
829 throw new NullPointerException("Abbrev is NULL in getRankByAbbreviation");
831 if (labelMap
== null){
834 //handle section and subsection (not unique representations)
835 if (rankName
.equalsIgnoreCase("Section")){
836 if (nc
!= null && nc
.equals(NomenclaturalCode
.ICZN
)){ return Rank
.SECTION_ZOOLOGY();
837 }else if (nc
!= null && nc
.equals(NomenclaturalCode
.ICNAFP
)){return Rank
.SECTION_BOTANY();
839 String errorWarning
= "Section is only defined for ICZN and ICNAFP at the moment but here needed for " + ((nc
== null)?
"(null)": nc
.toString());
840 logger
.warn(errorWarning
);
841 throw new UnknownCdmTypeException (errorWarning
);
843 }else if (rankName
.equalsIgnoreCase("Subsection")){
844 if (nc
!= null && nc
.equals(NomenclaturalCode
.ICZN
)){ return Rank
.SUBSECTION_ZOOLOGY();
845 }else if (nc
!= null && nc
.equals(NomenclaturalCode
.ICNAFP
)){ return Rank
.SUBSECTION_BOTANY();
847 String errorWarning
= "Subsection is only defined for ICZN and ICBN at the moment but here needed for " + ((nc
== null)?
"(null)": nc
.toString());
848 logger
.warn(errorWarning
);
849 throw new UnknownCdmTypeException (errorWarning
);
853 rankName
= rankName
.toLowerCase();
855 UUID uuid
= labelMap
.get(rankName
);
857 result
= getTermByUuid(uuid
);
862 if (rankName
== null){
866 logger
.info("Unknown rank name: " + rankName
+ ". Rank 'UNKNOWN_RANK' created instead");
867 return Rank
.UNKNOWN_RANK();
869 throw new UnknownCdmTypeException("Unknown rank: " + rankName
);
875 public static Rank
getRankByName(String rankName
, NomenclaturalCode nc
, boolean useUnknown
)
876 throws UnknownCdmTypeException
{
878 if (nc
.equals(NomenclaturalCode
.ICZN
)) {
879 if (rankName
.equalsIgnoreCase("Sectio")) { return Rank
.SECTION_ZOOLOGY();
880 }else if (rankName
.equalsIgnoreCase("Subsectio")) { return Rank
.SUBSECTION_ZOOLOGY();
883 return getRankByName(rankName
, useUnknown
);
887 * Returns the abbreviated rank name for <i>this</i> rank according to the English representation
889 * TODO Needs to be changed to Latin as soon as Latin representations are available.
891 * @return the abbreviation string for <i>this</i> rank
893 public String
getAbbreviation(){
894 Language language
= Language
.ENGLISH();
895 String result
= this.getRepresentation(language
).getAbbreviatedLabel();
897 logger
.warn("Abbreviation for this Rank " + this.toString() + " not yet implemented");
898 return "no abbreviation available.";
904 public String
getInfraGenericMarker() throws UnknownCdmTypeException
{
905 String result
= null;
906 if (! this.isInfraGeneric()){
907 throw new IllegalStateException("An infrageneric marker is only available for a infrageneric rank but was asked for rank: " + this.toString());
909 result
= this.getAbbreviation();
912 throw new UnknownCdmTypeException("Abbreviation for rank unknown: " + this.toString());
920 public Rank
readCsvLine(Class
<Rank
> termClass
, List
<String
> csvLine
, Map
<UUID
, DefinedTermBase
> terms
) {
921 Rank rank
= super.readCsvLine(termClass
, csvLine
, terms
);
922 RankClass rankClass
= RankClass
.getByKey(csvLine
.get(5));
923 assert rankClass
!= null: "XXXXXXXXXXXXXXXXXXXXX Rank class must not be null: " + csvLine
;
924 rank
.setRankClass(rankClass
);
929 protected void setDefaultTerms(TermVocabulary
<Rank
> termVocabulary
) {
930 termMap
= new HashMap
<UUID
, Rank
>();
931 for (Rank term
: termVocabulary
.getTerms()){
932 termMap
.put(term
.getUuid(), (Rank
)term
);
940 private void addRank(Rank rank
) {
942 logger
.warn("rank is NULL");
945 if (rank
.getUuid().equals(uuidSectionZoology
) || rank
.getUuid().equals(uuidSubsectionZoology
)){
946 //sect./subsect. is used for botanical sections, see also #getRankByAbbreviation(String, NomenclaturalCode, boolean)
949 Language lang
= Language
.DEFAULT(); //TODO should be Latin but at the moment we have only English representations
950 Representation representation
= rank
.getRepresentation(lang
);
951 String abbrevLabel
= representation
.getAbbreviatedLabel();
952 String label
= representation
.getLabel();
953 if (abbrevLabel
== null){
954 logger
.warn("Abbreviated label for rank is NULL.Can't add rank: " + CdmUtils
.Nz(rank
.getLabel()));
958 if (abbrevMap
== null){
959 abbrevMap
= new HashMap
<String
, UUID
>();
961 if (labelMap
== null){
962 labelMap
= new HashMap
<String
, UUID
>();
965 abbrevMap
.put(abbrevLabel
, rank
.getUuid());
966 labelMap
.put(label
.toLowerCase(), rank
.getUuid());
971 * It is necessary to skip the vocabulary check, otherwise we would have
972 * problems in some CacheStrategies, due to uninitialized Vocabularies.
974 * @see eu.etaxonomy.cdm.model.common.OrderedTermBase#compareTo(eu.etaxonomy.cdm.model.common.OrderedTermBase)
977 public int compareTo(Rank orderedTerm
) {
978 return performCompareTo(orderedTerm
, true);