Module org.scijava.ops.engine

Package org.scijava.ops.engine

Interface InfoTreeGenerator

All Superinterfaces:

Comparable<InfoTreeGenerator>, Prioritized<InfoTreeGenerator>

All Known Implementing Classes:

AdaptationInfoTreeGenerator, ConvertedInfoTreeGenerator, DefaultInfoTreeGenerator

public interface InfoTreeGenerator
extends Prioritized<InfoTreeGenerator>

Method Summary

Modifier and Type	Method	Description
boolean	canGenerate(String signature)	Describes whether this InfoTreeGenerator is designed to generate the outer layer of the InfoTree
static InfoTreeGenerator	findSuitableGenerator(String signature, Collection<InfoTreeGenerator> generators)	Filters through a list of InfoTreeGenerators to find the generator best suited towards generating signature
InfoTree	generate(OpEnvironment env, String signature, Map<String,OpInfo> idMap, Collection<InfoTreeGenerator> generators)	Generates an InfoTree.
static InfoTree	generateDependencyTree(OpEnvironment env, String subsignature, Map<String,OpInfo> idMap, Collection<InfoTreeGenerator> generators)
default double	priority()
static String	subSignatureFrom(String signature, int start)	Finds the subsignature in String signature.

Methods inherited from interface org.scijava.priority.Prioritized

compareTo

Method Detail

generate

InfoTree generate(OpEnvironment env,
                  String signature,
                  Map<String,OpInfo> idMap,
                  Collection<InfoTreeGenerator> generators)

Generates an InfoTree. This InfoTreeGenerator is only responsible for generating the outer layer of the InfoTree, and delegates to generators to generate other needed components, such as dependencies.

Parameters:

env - the OpEnvironment

signature - the signature for which an InfoTreeGenerator must be generated

idMap - the available OpInfos, keyed by their id

generators - the available InfoTreeGenerators

Returns:

an InfoTree matching the specifications of signature

findSuitableGenerator

static InfoTreeGenerator findSuitableGenerator(String signature,
                                               Collection<InfoTreeGenerator> generators)

Filters through a list of InfoTreeGenerators to find the generator best suited towards generating signature

Parameters:

signature - the signature that must be generated

generators - the list of InfoTreeGenerators

Returns:

the InfoTreeGenerator best suited to the task

generateDependencyTree

static InfoTree generateDependencyTree(OpEnvironment env,
                                       String subsignature,
                                       Map<String,OpInfo> idMap,
                                       Collection<InfoTreeGenerator> generators)

subSignatureFrom

static String subSignatureFrom(String signature,
                               int start)

Finds the subsignature in String signature. The subsignature is assumed to start at index start. Note that we cannot simply use String.substring(int) because the subsignature may have dependencies, which are not easily parsed.

Parameters:

signature - the signature of some Op

start - the index where the subsignature starts

Returns:

a signature contained withing signature

canGenerate

boolean canGenerate(String signature)

Describes whether this InfoTreeGenerator is designed to generate the outer layer of the InfoTree

Parameters:

signature - the signature to use as the template for the InfoTree

Returns:

true iff this InfoTreeGenerator can generate the outer layer of the InfoTree

priority

default double priority()

Specified by:

priority in interface Prioritized<InfoTreeGenerator>