Module org.scijava.ops.engine

Package org.scijava.ops.engine.matcher

Interface MatchingRoutine

All Superinterfaces:

Comparable<MatchingRoutine>

All Known Implementing Classes:

AdaptationMatchingRoutine, ConversionMatchingRoutine, RuntimeSafeMatchingRoutine

public interface MatchingRoutine
extends Comparable<MatchingRoutine>

A plugin type employing a particular strategy to generate an OpCandidate.

Author:

Gabriel Selzer

Method Summary

Modifier and Type	Method	Description
void	checkSuitability(MatchingConditions conditions)
default int	compareTo(MatchingRoutine o)
OpCandidate	findMatch(MatchingConditions conditions, OpMatcher matcher, OpEnvironment env)
default OpCandidate	match(MatchingConditions conditions, OpMatcher matcher, OpEnvironment env)	Generates an OpCandidate from the Ops in the provided OpEnvironment, conforming to the provided MatchingConditions
double	priority()	The priority of this MatchingRoutine

Method Detail

checkSuitability

void checkSuitability(MatchingConditions conditions)
               throws OpMatchingException

Throws:

OpMatchingException

compareTo

default int compareTo(MatchingRoutine o)

Specified by:

compareTo in interface Comparable<MatchingRoutine>

findMatch

OpCandidate findMatch(MatchingConditions conditions,
                      OpMatcher matcher,
                      OpEnvironment env)
               throws OpMatchingException

Throws:

OpMatchingException

match

default OpCandidate match(MatchingConditions conditions,
                          OpMatcher matcher,
                          OpEnvironment env)

Generates an OpCandidate from the Ops in the provided OpEnvironment, conforming to the provided MatchingConditions

Parameters:

conditions - the MatchingConditions the returned Op must conform to

matcher - the OpMatcher responsible for matching

env - the OpEnvironment containing the Ops able to be matched

Returns:

an OpCandidate

priority

double priority()

The priority of this MatchingRoutine

Returns:

the priority