DefaultOpMatchingService (ImageJ2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.scijava.AbstractContextual
- - org.scijava.plugin.AbstractRichPlugin
  - - org.scijava.service.AbstractService
    - - net.imagej.ops.DefaultOpMatchingService

All Implemented Interfaces:

Comparable<Prioritized>, ImageJService, OpMatchingService, Contextual, Disposable, Identifiable, Initializable, Locatable, Logged, HasPluginInfo, RichPlugin, SciJavaPlugin, Prioritized, Service, Versioned
```
public class DefaultOpMatchingService
extends AbstractService
implements OpMatchingService
```
Default service for finding Ops which match a request.

Author:

Curtis Rueden

Constructor Summary

Constructors
Constructor and Description

DefaultOpMatchingService()

Constructors
Constructor and Description
`DefaultOpMatchingService()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Module`	`assignInputs(Module module, Object... args)` Assigns arguments into the given module's inputs.
`List<OpCandidate>`	`filterMatches(List<OpCandidate> candidates)` Filters a list of ops to those matching the given arguments.
`List<OpCandidate>`	`findCandidates(OpEnvironment ops, List<OpRef> refs)` Builds a list of candidate ops which might match one of the given op references.
`List<OpCandidate>`	`findCandidates(OpEnvironment ops, OpRef ref)` Builds a list of candidate ops which might match the given op reference.
`OpCandidate`	`findMatch(OpEnvironment ops, List<OpRef> refs)` Finds and initializes the best module matching any of the given op name and/or type + arguments.
`OpCandidate`	`findMatch(OpEnvironment ops, OpRef ref)` Finds and initializes the best module matching the given op name and/or type + arguments.
`Module`	`match(OpCandidate candidate)` Attempts to match the given arguments to the `Op` described by the specified `ModuleInfo`.
`Object[]`	`padArgs(OpCandidate candidate)` Checks the number of args, padding optional args with null as needed.
`boolean`	`typesMatch(OpCandidate candidate)` Checks that each parameter is type-compatible with its corresponding argument.

Methods inherited from class org.scijava.service.AbstractService
getContext, setContext, toString

Methods inherited from class org.scijava.plugin.AbstractRichPlugin
getInfo, getPriority, setInfo, setPriority

Methods inherited from class org.scijava.AbstractContextual
context

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.scijava.service.Service
initialize, registerEventHandlers

Methods inherited from interface org.scijava.plugin.RichPlugin
getIdentifier, log

Methods inherited from interface org.scijava.Contextual
context, getContext, setContext

Methods inherited from interface org.scijava.Prioritized
compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.HasPluginInfo
getInfo, setInfo

Methods inherited from interface org.scijava.Locatable
getLocation

Methods inherited from interface org.scijava.Versioned
getVersion

Methods inherited from interface org.scijava.Disposable
dispose

- Constructor Detail
  - DefaultOpMatchingService
```
public DefaultOpMatchingService()
```
- Method Detail
  - findMatch
```
public OpCandidate findMatch(OpEnvironment ops,
                             OpRef ref)
```
    Description copied from interface: OpMatchingService
    
    Finds and initializes the best module matching the given op name and/or type + arguments. An OpCandidate containing the matching module will be returned.
    
    Specified by:
    
    findMatch in interface OpMatchingService
    
    Parameters:
    
    ops - The pool from which candidate ops should be drawn.
    
    ref - The op reference describing the op to match.
    
    Returns:
    
    An OpCandidate containing the module which wraps the best Op, with populated inputs, ready to run.
  - findMatch
```
public OpCandidate findMatch(OpEnvironment ops,
                             List<OpRef> refs)
```
    Description copied from interface: OpMatchingService
    
    Finds and initializes the best module matching any of the given op name and/or type + arguments. An OpCandidate containing the matching module will be returned.
    
    Specified by:
    
    findMatch in interface OpMatchingService
    
    Parameters:
    
    ops - The pool from which candidate ops should be drawn.
    
    refs - The op references describing the op to match.
    
    Returns:
    
    An OpCandidate containing the module which wraps the best Op, with populated inputs, ready to run.
  - findCandidates
```
public List<OpCandidate> findCandidates(OpEnvironment ops,
                                        OpRef ref)
```
    Description copied from interface: OpMatchingService
    
    Builds a list of candidate ops which might match the given op reference.
    
    Specified by:
    
    findCandidates in interface OpMatchingService
    
    Parameters:
    
    ops - The pool from which candidate ops should be drawn.
    
    ref - The op reference describing the op to match.
    
    Returns:
    
    The list of candidate operations.
  - findCandidates
```
public List<OpCandidate> findCandidates(OpEnvironment ops,
                                        List<OpRef> refs)
```
    Description copied from interface: OpMatchingService
    
    Builds a list of candidate ops which might match one of the given op references.
    
    Specified by:
    
    findCandidates in interface OpMatchingService
    
    Parameters:
    
    ops - The pool from which candidate ops should be drawn.
    
    refs - The op references describing the op to match.
    
    Returns:
    
    The list of candidate operations.
  - filterMatches
```
public List<OpCandidate> filterMatches(List<OpCandidate> candidates)
```
    Description copied from interface: OpMatchingService
    
    Filters a list of ops to those matching the given arguments.
    
    Specified by:
    
    filterMatches in interface OpMatchingService
    
    Parameters:
    
    candidates - The list of op candidates to scan for matches.
    
    Returns:
    
    The list of matching op candidates, with associated Module instances attached.
  - match
```
public Module match(OpCandidate candidate)
```
    Description copied from interface: OpMatchingService
    
    Attempts to match the given arguments to the Op described by the specified ModuleInfo.
    
    Specified by:
    
    match in interface OpMatchingService
    
    Returns:
    
    A populated Module instance for the matching Op, or null if the arguments do not match the Op.
  - typesMatch
```
public boolean typesMatch(OpCandidate candidate)
```
    Description copied from interface: OpMatchingService
    
    Checks that each parameter is type-compatible with its corresponding argument.
    
    Specified by:
    
    typesMatch in interface OpMatchingService
  - assignInputs
```
public Module assignInputs(Module module,
                           Object... args)
```
    Description copied from interface: OpMatchingService
    
    Assigns arguments into the given module's inputs.
    
    Specified by:
    
    assignInputs in interface OpMatchingService
  - padArgs
```
public Object[] padArgs(OpCandidate candidate)
```
    Description copied from interface: OpMatchingService
    
    Checks the number of args, padding optional args with null as needed.
    
    Specified by:
    
    padArgs in interface OpMatchingService

Class DefaultOpMatchingService

Constructor Summary

Method Summary

Methods inherited from class org.scijava.service.AbstractService

Methods inherited from class org.scijava.plugin.AbstractRichPlugin

Methods inherited from class org.scijava.AbstractContextual

Methods inherited from class java.lang.Object

Methods inherited from interface org.scijava.service.Service

Methods inherited from interface org.scijava.plugin.RichPlugin

Methods inherited from interface org.scijava.Contextual

Methods inherited from interface org.scijava.Prioritized

Methods inherited from interface org.scijava.plugin.HasPluginInfo

Methods inherited from interface org.scijava.Locatable

Methods inherited from interface org.scijava.Versioned

Methods inherited from interface org.scijava.Disposable

Constructor Detail

DefaultOpMatchingService

Method Detail

findMatch

findMatch

findCandidates

findCandidates

filterMatches

match

typesMatch

assignInputs

padArgs