uk.ac.ebi.microarray.zooma.hypothesis
Interface OntologyMappingHypothesis

All Superinterfaces:

Information

All Known Implementing Classes:

AbstractTrackedHypothesis, NoMappingPossibleHypothesis, PossibleDuplicateMappingsHypothesis

public interface OntologyMappingHypothesis
extends Information

A hypothesis regarding how a given description may map to a given term. The OntologyMapper may chose to accept or reject a series of hypotheses in order to produce an OntologyMappingOutcome

Author:

Tony Burdett

Method Summary

void	accept(OntologyMappingHypothesisVisitor visitor) Accept a visit from an OntologyMappingHypothesisVisitor.
void	acceptHypothesis() Accept this hypothesis, informing the ontology mapping mediator of this change.
void	addOntologyTerm(uk.ac.ebi.ontocat.OntologyTerm ontologyTerm) Adds an additional term to the collection of terms that are mapped by this hypothesis.
OntologyMappingContext	getContext() The context in which this mapping hypothesis should be attempted
java.util.Collection<uk.ac.ebi.ontocat.OntologyTerm>	getOntologyTerms() Gets the collections of OntologyTerms that can hypothetically be mapped to the given value.
Value	getValue() Gets the description that is attempted to be mapped in this hypothesis.
boolean	isAccepted() Returns whether or not this hypothesis has been accepted as the best mapping hypothesis
boolean	isRejected() Returns whether or not this hypothesis has been rejected against another, better hypothesis
void	rejectHypothesis() Reject this hypothesis, informing the ontology mapping mediator of this change.
void	setOntologyTerms(java.util.Collection<uk.ac.ebi.ontocat.OntologyTerm> ontologyTerms) Sets the collection of OntologyTerms that can hypothetically be mapped to the value for this hypothesis.

Methods inherited from interface uk.ac.ebi.microarray.zooma.track.Information

changed

Method Detail

getValue

Value getValue()

Gets the description that is attempted to be mapped in this hypothesis.

Returns:

the description we're trying to map

setOntologyTerms

void setOntologyTerms(java.util.Collection<uk.ac.ebi.ontocat.OntologyTerm> ontologyTerms)

Sets the collection of OntologyTerms that can hypothetically be mapped to the value for this hypothesis.

Parameters:

ontologyTerms - the collections of terms that can be mapped

getOntologyTerms

java.util.Collection<uk.ac.ebi.ontocat.OntologyTerm> getOntologyTerms()

Gets the collections of OntologyTerms that can hypothetically be mapped to the given value.

Returns:

a collection of possible ontology term mappings

addOntologyTerm

void addOntologyTerm(uk.ac.ebi.ontocat.OntologyTerm ontologyTerm)

Adds an additional term to the collection of terms that are mapped by this hypothesis. Implementations should define whether duplicate mappings are possible for this hypothesis.

Parameters:

ontologyTerm - the ontology term being added to this hypothesis

getContext

OntologyMappingContext getContext()

The context in which this mapping hypothesis should be attempted

Returns:

the mapping context for this outcome

isAccepted

boolean isAccepted()

Returns whether or not this hypothesis has been accepted as the best mapping hypothesis

Returns:

true if this hypothesis is accepted, false otherwise

isRejected

boolean isRejected()

Returns whether or not this hypothesis has been rejected against another, better hypothesis

Returns:

true if this hypothesis is rejected, false otherwise

acceptHypothesis

void acceptHypothesis()

Accept this hypothesis, informing the ontology mapping mediator of this change.

rejectHypothesis

void rejectHypothesis()

Reject this hypothesis, informing the ontology mapping mediator of this change.

accept

void accept(OntologyMappingHypothesisVisitor visitor)

Accept a visit from an OntologyMappingHypothesisVisitor.

Parameters:

visitor - the visitor to accept a visit from