org.scijava.batch

Interface BatchService

All Superinterfaces:

Comparable<Prioritized>, Contextual, Disposable, HandlerService<BatchInput,BatchInputProvider<?>>, HasPluginInfo, Identifiable, Initializable, Locatable, Logged, Prioritized, PTService<BatchInputProvider<?>>, RichPlugin, SciJavaPlugin, SciJavaService, Service, SingletonService<BatchInputProvider<?>>, Typed<BatchInput>, TypedService<BatchInput,BatchInputProvider<?>>, Versioned

All Known Implementing Classes:

FileBatchService

public interface BatchService
extends HandlerService<BatchInput,BatchInputProvider<?>>, SciJavaService

Method Summary

Modifier and Type	Method and Description
default List<ModuleItem<?>>	batchableInputs(ModuleInfo moduleInfo) A collection of input ModuleItems of the given ModuleInfo that are supported (i.e.
<I> void	fillInput(Module module, ModuleItem<?> moduleItem, I inputObject) Fill a provided ModuleItem with a given input object
void	run(ModuleInfo moduleInfo) Run the module described by ModuleInfo in batch.
boolean	supportsItem(ModuleItem<?> moduleItem) Returns true if type can be populated with batch inputs provided by this service
default boolean	supportsModule(ModuleInfo moduleInfo) Returns true if moduleInfo has at least one input item whose type is supported by this service

Methods inherited from interface org.scijava.plugin.HandlerService

getHandler, getInstances, supports

Methods inherited from interface org.scijava.plugin.SingletonService

create, filterInstances, getInstance, initialize, objectService

Methods inherited from interface org.scijava.plugin.TypedService

find

Methods inherited from interface org.scijava.plugin.PTService

getPlugins, getPluginService, getPluginType, pluginService

Methods inherited from interface org.scijava.service.Service

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

Methods inherited from interface org.scijava.Typed

getType

Method Detail

supportsModule

default boolean supportsModule(ModuleInfo moduleInfo)

Returns true if moduleInfo has at least one input item whose type is supported by this service

supportsItem

boolean supportsItem(ModuleItem<?> moduleItem)

Returns true if type can be populated with batch inputs provided by this service

run

void run(ModuleInfo moduleInfo)

Run the module described by ModuleInfo in batch.

batchableInputs

default List<ModuleItem<?>> batchableInputs(ModuleInfo moduleInfo)

A collection of input ModuleItems of the given ModuleInfo that are supported (i.e. can be batch-processed) by this service

fillInput

<I> void fillInput(Module module,
                   ModuleItem<?> moduleItem,
                   I inputObject)

Fill a provided ModuleItem with a given input object

Type Parameters:

I -