X-Git-Url: https://dev.e-taxonomy.eu/gitweb/cdmlib.git/blobdiff_plain/23de68fcac416330704a670f1a5e4bf1bcfe90e6..8a8db6f7a0a72cd900fe0512f9e49381fa6f5f91:/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/taxon/TaxonNodeStatus.java diff --git a/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/taxon/TaxonNodeStatus.java b/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/taxon/TaxonNodeStatus.java index be2be08fd1..d76d836ae1 100644 --- a/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/taxon/TaxonNodeStatus.java +++ b/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/taxon/TaxonNodeStatus.java @@ -13,39 +13,98 @@ import java.util.UUID; import javax.xml.bind.annotation.XmlEnumValue; -import org.apache.logging.log4j.LogManager;import org.apache.logging.log4j.Logger; +import org.apache.logging.log4j.LogManager; +import org.apache.logging.log4j.Logger; +import eu.etaxonomy.cdm.common.UTF8; import eu.etaxonomy.cdm.model.common.Language; import eu.etaxonomy.cdm.model.term.EnumeratedTermVoc; import eu.etaxonomy.cdm.model.term.IEnumTerm; /** + * The status for the placement (taxon node) of taxon/name in classification. + * + * For more information on the status see #10096, #9005, #8281 + * * @author a.mueller * @since 26.05.2020 */ public enum TaxonNodeStatus implements IEnumTerm{ - //0 - see #8281 + //TODO maybe we want a status "Included" too, instead of making TaxonNode.status an optional + // attribute (see comments in #10096 attachement) + //0 - see #10096 +// /** +// * The placement of the taxon is doubtful or preliminary. +// */ +// @XmlEnumValue("Included") +// INCLDUDED(UUID.fromString("7601cc89-8896-4b85-a83e-91700fe45a1d"), "Included (default)","Taxon included in parent taxon (default)", "INC", "", null), + + //1 - see #8281 /** * The placement of the taxon is doubtful or preliminary. */ @XmlEnumValue("Doubtful") - DOUBTFUL(UUID.fromString("022ebae2-a020-4a8d-8ee1-886d98d3a4db"), "Doubtful", "DOU", "?", null), + DOUBTFUL(UUID.fromString("022ebae2-a020-4a8d-8ee1-886d98d3a4db"), "Doubtful", "Taxon included in parent taxon with doubts", "DOU", "?", null), - //1 + //2 /** * The taxon is not placed to the correct place (yet). Instead it is placed here. */ @XmlEnumValue("Unplaced") - UNPLACED(UUID.fromString("92809dee-8b3f-4fd5-a915-638d7c86b351"), "Unplaced", "UNP", "??", null), + UNPLACED(UUID.fromString("92809dee-8b3f-4fd5-a915-638d7c86b351"), "Unplaced", "Taxon unplaced", "UNP", "??", null), - //2 + //3 /** - * The taxon for some reason is excluded from the treatment this {@link TaxonNode} belongs too. + * The taxon or name for any reason is excluded from the treatment this {@link TaxonNode} belongs too. + * See sub status for more specific reasons. */ @XmlEnumValue("Excluded") - EXCLUDED(UUID.fromString("23d259b6-2d7e-4df6-8745-0e24fbe63187"), "Excluded", "EXC", Character.toString((char)248), null) - ; + EXCLUDED(UUID.fromString("23d259b6-2d7e-4df6-8745-0e24fbe63187"), "Excluded", "Name or taxon excluded (unspecific)", "EXC", Character.toString((char)248), null), + + //4 #10096 + /** + * Taxon or name excluded, geographically out of scope.
+ * E.g. a taxon that does not occur in the region of the flora treatment. + */ + @XmlEnumValue("Excluded_geo") + EXCLUDED_GEO(UUID.fromString("a76c0fa8-e04d-421c-ac10-07a3c6770d45"), "Excluded geo.", "Taxon excluded (geographically out of scope)", "EXCG", Character.toString((char)248)+"g", EXCLUDED), + + //5 #10096 + /** + * Taxon or name excluded, taxonomically out of scope.
+ * E.g. name being a taxon name or synonym belonging to a taxon that is not part of the treatment. + */ + @XmlEnumValue("Excluded_tax") + EXCLUDED_TAX(UUID.fromString("689a5821-e59d-4ec2-ae33-2331bdb39f34"),"Excluded tax.", "Taxon or name excluded (taxonomically out of scope)", "EXCT", Character.toString((char)248)+"t", EXCLUDED), + + //6 #10096 + /** + * Name excluded for nomenclatural reasons.
+ * E.g. an effectively published name ascribing the name to an author who merely and correctly cited an earlier name. + */ + @XmlEnumValue("Excluded_nom") + EXCLUDED_NOM(UUID.fromString("b4484183-6f19-4901-af96-0ab6183cebfb"), "Excluded nom.","Name excluded (for nomenclatural reasons)", "EXCN", Character.toString((char)248)+"n", EXCLUDED), + + //7 #10096 + /** + * Name of verified uncertain application
+ * E.g. an effectively published name ascribing the name to an author who merely and correctly cited an earlier name.
+ * Alternative symbol: ↑ or u+2BD1 (https://unicode-table.com/en/2BD1/) + */ + @XmlEnumValue("Uncertain_app") + UNCERTAIN_APPLICATION(UUID.fromString("c87ea64a-f3d3-41fe-a4c5-dd6a8697fc46"), "Uncertain application", "Name of verified uncertain application", "UNA", Character.toString((char)248)+"a", EXCLUDED), + + //8 #10096 + /** + * Name of verified uncertain application
+ * E.g. an effectively published name ascribing the name to an author who merely and correctly cited an earlier name.
+ * Alternative symbol: ↑ or u+2BD1 (https://unicode-table.com/en/2BD1/) + */ + @XmlEnumValue("Unresolved") + UNRESOLVED(UUID.fromString("ce6f2430-9662-4b78-8fc2-48b5fa9fd37e"), "Unresolved", "Unresolved name "+UTF8.EN_DASH+" to be further revised", "UNR", "u", null), + +; // **************** END ENUM **********************/ @@ -54,12 +113,12 @@ public enum TaxonNodeStatus implements IEnumTerm{ private String symbol; - private TaxonNodeStatus(UUID uuid, String defaultString, String key, String symbol){ - this(uuid, defaultString, key, symbol, null); + private TaxonNodeStatus(UUID uuid, String label, String key, String symbol){ + this(uuid, label, label, key, symbol, null); } - private TaxonNodeStatus(UUID uuid, String defaultString, String key, String symbol, TaxonNodeStatus parent){ - delegateVocTerm = EnumeratedTermVoc.addTerm(getClass(), this, uuid, defaultString, key, parent); + private TaxonNodeStatus(UUID uuid, String label, String longLabel, String key, String symbol, TaxonNodeStatus parent){ + delegateVocTerm = EnumeratedTermVoc.addTerm(getClass(), this, uuid, longLabel, key, parent); this.symbol = symbol; } @@ -105,5 +164,4 @@ public enum TaxonNodeStatus implements IEnumTerm{ public String getSymbol(){ return symbol; } - }