com.massimo.tools.scriptrunner.work
Class PauseTask

java.lang.Object
  com.massimo.tools.scriptrunner.AbstractTask
      com.massimo.tools.scriptrunner.work.PauseTask

All Implemented Interfaces:

Task

public class PauseTask
extends AbstractTask

Prompt and wait for any input.

Field Summary

protected static String

PAUSE_PROMPT

Fields inherited from class com.massimo.tools.scriptrunner.AbstractTask

definition, name, parent, properties, type

Fields inherited from interface com.massimo.tools.scriptrunner.Task

DATA_ERROR, ERROR, FINISHED, INTERRUPTED, PROMPT, RUNNING, START, SUCCESS

Constructor Summary

PauseTask(Task parent, String type, Element definition, Map<String,String> connectionProperties)

Method Summary

protected int	doProcess(ExecutionContext context) Implementing classes only need to do their own work and log progress when appropriate.
protected int	doValidate(ValidationContext context) Check whether this task should be able to run.
protected org.apache.log4j.Logger	getLogger()
void	interrupt() Tells the Task to stop processing.

Methods inherited from class com.massimo.tools.scriptrunner.AbstractTask

getBooleanProperty, getCurrentWorkingDirectory, getDefinition, getIntProperty, getName, getParent, getProperties, getStartProcessingRow, getText, getType, isIgnoreableError, isIgnoreableError, isInterrupted, isLogProgress, postProcess, preProcess, process, resultCodeToString, substituteParameters, toString, validate, validateConnections, validateParameters

Methods inherited from class java.lang.Object

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

Field Detail

PAUSE_PROMPT

protected static final String PAUSE_PROMPT

See Also:

Constant Field Values

Constructor Detail

PauseTask

public PauseTask(Task parent,
                 String type,
                 Element definition,
                 Map<String,String> connectionProperties)

Parameters:

parent -

type -

definition -

connectionProperties -

Method Detail

doProcess

protected int doProcess(ExecutionContext context)
                 throws SRException

Implementing classes only need to do their own work and log progress when appropriate.
Substitute any parameters into the text of the task element and print to stdout. Wait for any input before proceeding.

Specified by:

doProcess in class AbstractTask

Returns:

O for success. Anything else is a failure.

Throws:

SRException

See Also:

AbstractTask.process(ExecutionContext)

doValidate

protected int doValidate(ValidationContext context)

Check whether this task should be able to run. Implementations should check for the prescence of files, attributes,...
The Task body cannot be empty.

Specified by:

doValidate in class AbstractTask

Returns:

O for success. Anything else is a failure.

getLogger

protected org.apache.log4j.Logger getLogger()

Specified by:

getLogger in class AbstractTask

Returns:

Class logger

interrupt

public void interrupt()

Tells the Task to stop processing. This does not garrantee that the task will return immediately.

Specified by:

interrupt in interface Task

Overrides:

interrupt in class AbstractTask