Package qupath.lib.plugins.workflow

Class SimplePluginWorkflowStep

java.lang.Object

qupath.lib.plugins.workflow.SimplePluginWorkflowStep

All Implemented Interfaces:

Externalizable, Serializable, ScriptableWorkflowStep, WorkflowStep

public class SimplePluginWorkflowStep
extends Object
implements ScriptableWorkflowStep, Externalizable

Updated version of DefaultPluginWorkflowStep, adapted to use Externalizable and to avoid storing the plugin class as a class object (preferring a String instead).

Author:

Pete Bankhead

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SimplePluginWorkflowStep()	Default public constructor, required for Externalizable.
SimplePluginWorkflowStep(String name, Class<? extends PathPlugin<?>> pluginClass, String arg)	Constructor for a workflow step that calls a plugin.
SimplePluginWorkflowStep(String name, Class<? extends PathPlugin<?>> pluginClass, String arg, String scriptBefore, String scriptAfter)	Constructor for a workflow step that calls a plugin, which optionally should include additional scripting lines before or afterwards.

Method Summary

Modifier and Type	Method	Description
String	getName()	Get the name of the workflow step.
Map<String,?>	getParameterMap()	Get a map of parameters required for this step.
String	getPluginClass()	Get the full name of the plugin class.
String	getScript()	Get one or more script lines that may be used to apply the step.
void	readExternal(ObjectInput in)
String	toString()
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Constructor Details

SimplePluginWorkflowStep

public SimplePluginWorkflowStep()

Default public constructor, required for Externalizable. Shouldn't be used directly! Doing so would give an ineffective script...

SimplePluginWorkflowStep

public SimplePluginWorkflowStep(String name,
 Class<? extends PathPlugin<?>> pluginClass,
 String arg)

Constructor for a workflow step that calls a plugin.

Parameters:

name -

pluginClass -

arg -

SimplePluginWorkflowStep

public SimplePluginWorkflowStep(String name,
 Class<? extends PathPlugin<?>> pluginClass,
 String arg,
 String scriptBefore,
 String scriptAfter)

Constructor for a workflow step that calls a plugin, which optionally should include additional scripting lines before or afterwards.

Parameters:

name -

pluginClass -

arg -

scriptBefore -

scriptAfter -

Method Details

getName

public String getName()

Description copied from interface: WorkflowStep

Get the name of the workflow step.

Specified by:

getName in interface WorkflowStep

Returns:

getPluginClass

public String getPluginClass()

Get the full name of the plugin class.

Returns:

getParameterMap

public Map<String,?> getParameterMap()

Description copied from interface: WorkflowStep

Get a map of parameters required for this step.

Specified by:

getParameterMap in interface WorkflowStep

Returns:

toString

public String toString()

Overrides:

toString in class Object

getScript

public String getScript()

Description copied from interface: ScriptableWorkflowStep

Get one or more script lines that may be used to apply the step.

Specified by:

getScript in interface ScriptableWorkflowStep

Returns:

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException