Package org.scijava.module.process

Interface ModulePreprocessor

All Superinterfaces:

Cancelable, ModuleProcessor

All Known Subinterfaces:

PreprocessorPlugin

All Known Implementing Classes:

AbstractInputHarvesterPlugin, AbstractPreprocessorPlugin, AbstractSingleInputPreprocessor, ActiveDisplayPreprocessor, CheckInputsPreprocessor, DebugPreprocessor, DefaultValuePreprocessor, FileListPreprocessor, FilePreprocessor, GatewayPreprocessor, InitPreprocessor, LoadInputsPreprocessor, LoggerPreprocessor, SaveInputsPreprocessor, ServicePreprocessor, UIPreprocessor, ValidityPreprocessor

public interface ModulePreprocessor
extends ModuleProcessor, Cancelable

A module preprocessor defines a step that occurs just prior to the actual execution of a Module. Typically, a preprocessor prepares the module for execution in some way, such as populating module inputs or checking prerequisites.

The preprocessor may decide to cancel the module's pending execution, subject to its own criteria. In this case, its Cancelable.isCanceled() method will return true, and its Cancelable.getCancelReason() method may optionally explain why.

Author:

Curtis Rueden

Method Summary

Methods inherited from interface org.scijava.Cancelable

cancel, getCancelReason, isCanceled

Methods inherited from interface org.scijava.module.process.ModuleProcessor

process