Module org.scijava.ops.engine

Package org.scijava.ops.engine.matcher

Class OpCandidate

java.lang.Object

org.scijava.ops.engine.matcher.OpCandidate

public class OpCandidate
extends Object

Container class for a possible operation match between an OpRequest and an OpInfo.

Author:

Curtis Rueden, Gabriel Selzer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpCandidate.StatusCode

Constructor Summary

Constructors

Constructor	Description
OpCandidate(OpEnvironment env, OpRequest request, OpInfo info)
OpCandidate(OpEnvironment env, OpRequest request, OpInfo info, Map<TypeVariable<?>,Type> typeVarAssigns)

Method Summary

Modifier and Type	Method	Description
Object	createOp(List<?> dependencies)
StructInstance<?>	createOpInstance(List<?> dependencies)
OpEnvironment	env()	Gets the op execution environment of the desired match.
static Type	getReifiedType(OpRequest request, OpInfo info, Map<TypeVariable<?>,Type> typeVarAssigns)
OpRequest	getRequest()	Gets the op request describing the desired match.
String	getStatus()	Gets a descriptive status message in human readable form.
OpCandidate.StatusCode	getStatusCode()	Gets the matching status code.
Member<?>	getStatusItem()	Gets the status item related to the matching status, if any.
Type	getType()	Gets the reified Type of the Op described by this candidate.
OpInfo	opInfo()	Gets the OpInfo metadata describing the op to match against.
Type[]	paddedArgs()
double	priority()	Gets the priority of this result
void	setStatus(OpCandidate.StatusCode code)	Sets the status of the matching attempt.
void	setStatus(OpCandidate.StatusCode code, String message)	Sets the status of the matching attempt.
void	setStatus(OpCandidate.StatusCode code, String message, Member<?> item)	Sets the status of the matching.
Struct	struct()	Gets the Struct metadata describing the op to match against.
String	toString()
Map<TypeVariable<?>,Type>	typeVarAssigns()	Gets the mapping between TypeVariables and Types that makes the OpCandidate pair legal.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

OpCandidate

public OpCandidate(OpEnvironment env,
                   OpRequest request,
                   OpInfo info,
                   Map<TypeVariable<?>,Type> typeVarAssigns)

OpCandidate

public OpCandidate(OpEnvironment env,
                   OpRequest request,
                   OpInfo info)

Method Detail

getReifiedType

public static Type getReifiedType(OpRequest request,
                                  OpInfo info,
                                  Map<TypeVariable<?>,Type> typeVarAssigns)

env

public OpEnvironment env()

Gets the op execution environment of the desired match.

getRequest

public OpRequest getRequest()

Gets the op request describing the desired match.

opInfo

public OpInfo opInfo()

Gets the OpInfo metadata describing the op to match against.

getType

public Type getType()

Gets the reified Type of the Op described by this candidate.

priority

public double priority()

Gets the priority of this result

typeVarAssigns

public Map<TypeVariable<?>,Type> typeVarAssigns()

Gets the mapping between TypeVariables and Types that makes the OpCandidate pair legal.

paddedArgs

public Type[] paddedArgs()

struct

public Struct struct()

Gets the Struct metadata describing the op to match against.

See Also:

OpInfo.struct()

setStatus

public void setStatus(OpCandidate.StatusCode code)

Sets the status of the matching attempt.

setStatus

public void setStatus(OpCandidate.StatusCode code,
                      String message)

Sets the status of the matching attempt.

setStatus

public void setStatus(OpCandidate.StatusCode code,
                      String message,
                      Member<?> item)

Sets the status of the matching.

getStatusCode

public OpCandidate.StatusCode getStatusCode()

Gets the matching status code.

getStatusItem

public Member<?> getStatusItem()

Gets the status item related to the matching status, if any. Typically, if set, this is the parameter for which matching failed.

getStatus

public String getStatus()

Gets a descriptive status message in human readable form.

toString

public String toString()

Overrides:

toString in class Object

createOpInstance

public StructInstance<?> createOpInstance(List<?> dependencies)

createOp

public Object createOp(List<?> dependencies)