import {TaxonomicUnitMatcher} from '@phyloref/phyx/src/matchers/TaxonomicUnitMatcher.js'
TaxonomicUnitMatcher
The TaxonomicUnitMatcher matches pairs of taxonomic units and provides a consistent report on:
- Which taxonomic units have matched, and
- Why the match occurred.
In Model 2.0, we start by using direct matching in OWL, so this should no longer be needed. However, I'll leave this around to provide matching in the Curation Tool UI and in case it's needed again later.
Constructor Summary
Public Constructor | ||
public |
Create a Taxonomic Unit Matcher to match two taxonomic units. |
Member Summary
Public Members | ||
public |
matchReason: * |
|
public |
matched: * |
|
public |
tunit1: * |
|
public |
tunit2: * |
Method Summary
Public Methods | ||
public |
asJSONLD(idIRI: *): {"@id": *, "reason": *, "matchesTaxonomicUnits": *} Return this TUMatch as a JSON object for insertion into the PHYX file. |
|
public |
match() Try to match the two taxonomic units using a number of matching methods. |
|
public |
Match by external references. |
|
public |
Try to match by nameComplete, and return true if it could be matched. |
|
public |
Match by occurrence ID |
Public Constructors
public constructor() source
Create a Taxonomic Unit Matcher to match two taxonomic units. Matching will occur immediately, so when this method returns, you can check tuMatch.matched and tuMatch.matchReason to determine if the two TUs matched and why.
Public Members
public matchReason: * source
public matched: * source
public tunit1: * source
public tunit2: * source
Public Methods
public asJSONLD(idIRI: *): {"@id": *, "reason": *, "matchesTaxonomicUnits": *} source
Return this TUMatch as a JSON object for insertion into the PHYX file.
Params:
Name | Type | Attribute | Description |
idIRI | * |
Return:
{"@id": *, "reason": *, "matchesTaxonomicUnits": *} |