FP-Akka Class Dependency Tree

akka.fp.Loader  [FP-Akka module]

• Instantiates and runs workflow comprising five Akka actors represented by the five class dependencies below.
• Configures MongoDBReader and MongoDBWriter actors using parsed command-line options.
• Injects fp.services.COLService into the scientificNameService field of the instantiated akka.fp.NewScientificName actor.

akka.fp.NewScientificNameValidator  [FP-Akka module]

• • Akka actor for validating scientific name and authorship fields.
  • Internally creates an instance of the nested class ScientificNameValidatorInvocation (which performs the work below).
  • Uses the class injected into the scientificNameService field (fp.services.COLService and its parent fp.services.SciNameServiceParent) to carry out validation tasks
  • Receives individual SpecimenRecord instances from upstream MongoDBReader.
  • For each specimen record:
    • Disassembles the specimen record into fields.
    • Calls the validateScientificName() method on the scientificNameService (implemented by fp.services.SciNameServiceParent) passing the individual field values extracted from the record.
    • Calls getters getCurationStatus(), getCorrectedScientificName(), getCorrectedAuthor(), getLSID(), getComment(), getServiceName() on the scientificNameService to extract validation results.
    • If the result returned by getCurationStatus() is CURATED or Filled_In, replaces the scientificName and scientificNameAuthorship fields in the input specimen record with the results from getCorrectedScientificName() and getCorrectedAuthor() respectively.
    • Adds to the input specimen record three fields with labels scinComment, scinStatus, and scinSource using the results from getCurationStatus(), getComment(), and getServiceName() on the scientificNameService.
    • Forwards the updated specimen record to downstream actors in workflow.
    • Comment: The NewScientificNameValidator actor overwrites the original scientificName and scientificNameAuthorship fields in each record that it updates.  Downstream actors in the workflow, including MongoDBWriter which saves the workflow results, do not have programmatic access to the original values in these fields.

fp.services.COLService [FP-KurationServices module]

• • • • Injected by akka.FP.Loader into the scientificNameService field of the akka.fp.NewScientificNameValidator actor.
      • Derived from fp.services.SciNameServiceParent (to which it defers most method calls from the actor).
      • Overrides nameSearchAgainstServices() to look up scientific name and author in the Catalog of Life using the web service at http://www.catalogueoflife.org/col/webservice.

fp.services.SciNameServiceParent [FP-KurationServices]

fp.util.SciNameServiceUtil

edu.harvard.mcz.nametools.NameUsage

fp.services.GNISupportingService

org.gbif.nameparser.NameParser

org.gbif.api.model.checklistbank.ParsedName