Package org.opensextant.data

Class Taxon

  • public class Taxon
extends java.lang.Object
    A Taxon is an entry in a taxonomy, which could be as simple as a flat word list or something with lots of structure. The name attribute represents the hierarchical path for the Taxon.
    • "terms" are the phrases you wish to find in free text. This is the common vernacular that implies this taxon or concept. e.g., "la piña" may be a term that we want to file under "fruits.tropical.pineapple"
    • "tags" are any metadata items associated with the terms or the taxon, e.g., source of terms, database identifier, language of terms, contributing staff
    Author:
    ubaldino

    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.lang.String catalog
      Catalog, for example "fruit"
      java.lang.String id
      Nod OID: 1.2.3
      boolean isAcronym
      Acronyms are assumed to be ALL UPPER CASE; granted this does not always apply.
      java.lang.String name
      Node name: citrus.tropical
      java.lang.String rootid
      Node root: citrus
      java.util.Set<java.lang.String> tagset  
      java.util.Set<java.lang.String> termset
      Terms: "pineapple", "mango", ...

    • Constructor Summary

      Constructors 
      Constructor Description
      Taxon()  

    • Method Summary

      Modifier and Type Method Description
      void addTag​(java.lang.String t)  
      void addTags​(java.util.List<java.lang.String> tlist)  
      void addTerm​(java.lang.String t)  
      void addTerms​(java.util.Collection<java.lang.String> tlist)  
      boolean hasTags()  
      void setId​(java.lang.String i)  
      void setName​(java.lang.String n)  
      void setRootid​(java.lang.String i)  
      void setTerms​(java.lang.String[] t)  
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • catalog

        public java.lang.String catalog
        Catalog, for example "fruit"

      • name

        public java.lang.String name
        Node name: citrus.tropical

      • id

        public java.lang.String id
        Nod OID: 1.2.3

      • rootid

        public java.lang.String rootid
        Node root: citrus

      • termset

        public java.util.Set<java.lang.String> termset
        Terms: "pineapple", "mango", ...

      • tagset

        public java.util.Set<java.lang.String> tagset

      • isAcronym

        public boolean isAcronym
        Acronyms are assumed to be ALL UPPER CASE; granted this does not always apply. But this is used to inform post-processing if a match, such as 'abc' matched 'ABC' incorrectly. If the match is lower case, but the Taxon is Acronym, then you have a mismatch of case and semantics likley.

    • Constructor Detail

      • Taxon

        public Taxon()

    • Method Detail

      • setName

        public void setName​(java.lang.String n)

      • setId

        public void setId​(java.lang.String i)

      • setRootid

        public void setRootid​(java.lang.String i)

      • setTerms

        public void setTerms​(java.lang.String[] t)

      • hasTags

        public boolean hasTags()

      • addTags

        public void addTags​(java.util.List<java.lang.String> tlist)

      • addTag

        public void addTag​(java.lang.String t)

      • addTerm

        public void addTerm​(java.lang.String t)

      • addTerms

        public void addTerms​(java.util.Collection<java.lang.String> tlist)

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object