SpeciesFileGroup / taxonworks_doc

TaxonWorks (https://taxonworks.org) documentation.
https://docs.taxonworks.org
13 stars 13 forks source link

Understanding Combinations #10

Open mjy opened 4 years ago

mjy commented 4 years ago

Understanding Combinations

This is version 0.0.1. All changes beyond grammar will result in an increment. Higher level increments reflect larger changes that may reflect new ways of doing things, or differences in user interfaces, etc.

You can ask for help and clarification live in person on Gitter!

Overview

This is more of an overview than an exercise.

Exercise target audience

Users who are asking questions about how Combinations are represented in the data model.

Manual goals

The goals are to describe:

At the end of the exercise you should:

Assumptions

Related exercises

Manual

The Combination model

Asside from the documentation here the Combination model and the Nomenclatural concepts overview are useful references.

Combinations are a subclass of TaxonName with no name

Combinations are a subclass of TaxonName that have no name field filled out. They are "anonymous" in this sense. Their cached values are built through the values referenced through the taxon name relationships that link to this name. For example, if a combination has 3 parts, then there is one name linked to three individual names via three taxon name relationships. We use the id of the combination as the object id of the triple stored in the taxon name relationship.

The parent id of a Combination

The parent ID of a Combination is automatically set to the id of the parent of the highest ranked protonym in the Combination.

Original combinations are not Combinations

For various reasons that might ultimately change "original combinations" are not Combinations (upper case) in TaxonWorks. They are created by a special set of relationships unique to "original" that are applied between protonyms. There is no "anonymous" TaxonName that groups these original combinations, rather it is the protonym in question that is linked to.

Wrapping up