uk.ac.ebi.microarray.zooma.eval
Interface OntologyMappingOutcome

All Known Implementing Classes:

BasicZoomaOutcome, CurationDecorator, FailureReportWriterDecorator, JSONProducerDecorator, OntologyMappingOutcomeDecorator, ReportWriterDecorator

public interface OntologyMappingOutcome

The outcome of an ontology mapping process. This may include several possible OntologyMappingHypotheses, of which no single hypothesis could be determined to be best. In this case, manual curation is required. If a single hypothesis was present, or if no improved hypothesis was determined, the outcome is adjudged to be automatically acceptable.

Some implementations will generate outcomes after changes have been applied by an OntologyMapper in the underlying datasource. In other implementations, the outcome may be to generate a log, or may require curation in order to determine which single outcome can be applied.

Author:

Tony Burdett

Method Summary

void	apply() Applies the current outcome.
java.util.Collection<OntologyMappingHypothesis>	getBestHypotheses() A collection of OntologyMappingHypothesis objects that describe ontology mappings.
Value	getUnmappedValue() Returns that value that has been used to produce this outcome.
boolean	isAutomaticallyAcceptable() Whether or not it was possible to automatically accept a given outcome.

Method Detail

getUnmappedValue

Value getUnmappedValue()

Returns that value that has been used to produce this outcome.

Returns:

the value that produced this outcome

getBestHypotheses

java.util.Collection<OntologyMappingHypothesis> getBestHypotheses()

A collection of OntologyMappingHypothesis objects that describe ontology mappings. In the general case, if there is a single valued hypothesis it can be automatically accepted, and if there are many hypotheses user curation will be required before a single outcome can be applied. If there are zero, no mappings were possible.

Returns:

a collections of hypotheses describing how a description may match to known ontology terms

isAutomaticallyAcceptable

boolean isAutomaticallyAcceptable()

Whether or not it was possible to automatically accept a given outcome. Generally, this will be true if there was a single improved hypothesis that was accepted and written to some underlying datasource, but implementations are free to define their own criteria for automated acceptance.

Returns:

whether this mapping outcome was automatically accepted

apply

void apply()
           throws BadOutcomeException

Applies the current outcome. This will normally trigger some action that results in the persistance of the new mapping.

Throws:

BadOutcomeException