edu.udo.cs.yale.operator
Class CommandLineOperator

java.lang.Object
  edu.udo.cs.yale.operator.Operator
      edu.udo.cs.yale.operator.CommandLineOperator

All Implemented Interfaces:

ConfigurationListener

public class CommandLineOperator
extends Operator

This operator executes a system command. The command and all its arguments are specified by the parameter command. The standard output stream and the error stream of the process can be redirected to the logfile.
Please note also that the command is system dependent. Characters that have special meaning on the shell like e.g. the pipe symbol or brackets and braces do not have a special meaning to Java.
The method Runtime.exec(String) is used to execute the command. Please note, that this (Java) method parses the string into tokens before it is executed. These tokens are not interpreted by a shell (which?). If the desired command involves piping, redirection or other shell features, it is best to create a small shell script to handle this.

Version:

$Id: CommandLineOperator.java,v 2.15 2006/03/27 13:21:58 ingomierswa Exp $

Author:

Ingo Mierswa, Simon Fischer

Field Summary

private static java.lang.Class[]	INPUT_CLASSES
private static java.lang.Class[]	OUTPUT_CLASSES

Constructor Summary

CommandLineOperator(OperatorDescription description)

Method Summary

IOObject[]	apply() Implement this method in subclasses.
java.lang.Class[]	getInputClasses() no input
java.lang.Class[]	getOutputClasses() no output
java.util.List<ParameterType>	getParameterTypes() Returns a list of ParameterTypes describing the parameters of this operator.
private void	logOutput(java.lang.String message, java.io.InputStream in) Sends the output to the LogService.

Methods inherited from class edu.udo.cs.yale.operator.Operator

addError, addValue, addWarning, apply, checkDeprecations, checkIO, checkProperties, clearErrorList, cloneOperator, createExperimentTree, createExperimentTree, createFromXML, createMarkedExperimentTree, delete, experimentFinished, experimentStarts, getAddOnlyAdditionalOutput, getApplyCount, getDeliveredOutputClasses, getDeprecationInfo, getDesiredInputClasses, getErrorList, getExperiment, getInnerOperatorsXML, getInput, getInput, getInput, getInputDescription, getIOContainerForInApplyLoopBreakpoint, getName, getNumberOfSteps, getOperatorClassName, getOperatorDescription, getParameter, getParameterAsBoolean, getParameterAsColor, getParameterAsDouble, getParameterAsFile, getParameterAsInt, getParameterAsString, getParameterList, getParameters, getParameterType, getParent, getStartTime, getStatus, getUserDescription, getValue, getValues, getXML, hasBreakpoint, hasBreakpoint, hasInput, inApplyLoop, isEnabled, isParameterSet, logMessage, performAdditionalChecks, register, remove, rename, resume, setBreakpoint, setEnabled, setExperiment, setInput, setListParameter, setOperatorParameters, setParameter, setParameters, setParent, setUserDescription, toString, writeXML

Methods inherited from class java.lang.Object

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

Field Detail

INPUT_CLASSES

private static final java.lang.Class[] INPUT_CLASSES

OUTPUT_CLASSES

private static final java.lang.Class[] OUTPUT_CLASSES

Constructor Detail

CommandLineOperator

public CommandLineOperator(OperatorDescription description)

Method Detail

apply

public IOObject[] apply()
                 throws OperatorException

Description copied from class: Operator

Implement this method in subclasses.

Specified by:

apply in class Operator

Throws:

OperatorException

logOutput

private void logOutput(java.lang.String message,
                       java.io.InputStream in)
                throws java.io.IOException

Sends the output to the LogService.

Throws:

java.io.IOException

getInputClasses

public java.lang.Class[] getInputClasses()

no input

Specified by:

getInputClasses in class Operator

getOutputClasses

public java.lang.Class[] getOutputClasses()

no output

Specified by:

getOutputClasses in class Operator

getParameterTypes

public java.util.List<ParameterType> getParameterTypes()

Description copied from class: Operator

Returns a list of ParameterTypes describing the parameters of this operator. The default implementation returns an empty list if no input objects can be retained and special parameters for those input objects which can be prevented from being consumed.

Overrides:

getParameterTypes in class Operator