de.unihalle.informatik.Alida.tools
Class ALDOpRunner

java.lang.Object
  extended by de.unihalle.informatik.Alida.tools.ALDOpRunner

public class ALDOpRunner
extends java.lang.Object

Generic commandline interface to run an Alida operator. The operator needs to be annotated to allows execution mode CMDLINE.

Reading of IN and INOUT parameters and writing of OUT and INOUT parameters is accomplished using the interface ALDDataIOCmdline in conjunction with ALDDataIOManagerCmdline. For each parameter which should be read or written according to its annotated direction, a name=value pair has to be given as argument.

If the flag --donotrun or -n is given, only the parameters of the operator and there details will be printed but the operator is not invoked.

The flag noDefaultHistory specifies that not for each input parameter a history file should be read and associated with the parameter for all data types (irrespective whether the corresponding provider does so). Likewise this flags specifies if a history is to be written for all output parameters.

If the flag --verbose or -v the interface of the operator will be printed to stdout (and potentially further information).

Author:
Stefan Posch

Field Summary
protected  java.util.LinkedList<java.lang.String> matchingClassNames
          List of fully qualified class names of operators available
protected  boolean useRegEx
          If true, matching of operator name from commandline to the annoteated ALDOperators uses regular expression matching, otherwise exact substring matching
 
Constructor Summary
ALDOpRunner(java.lang.String[] args)
          Construct a ALDOpRunner using args
 
Method Summary
 java.util.LinkedList<java.lang.String> findALDOperators(java.lang.String opNamePattern)
          Find operator with given pattern among all annotated ALDOperators and return the full qualified names as a list.
protected  void findOperators(java.lang.String opNamePattern)
          This method is call once to populate the member matchingClassNames.
protected  ALDOperator getOperator(java.lang.String opName)
          This method is called to instantiate the ALDOperator.
protected  boolean isExactSubstring(java.lang.String substr, java.lang.String str)
          return true, if substr is a exact substring of str
static void main(java.lang.String[] args)
          Main routine of ALDOpRunner , see usage.
 void runIt()
          This method does the complete work to scan arguments, read and write parameters and runOp the operator.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

useRegEx

protected boolean useRegEx
If true, matching of operator name from commandline to the annoteated ALDOperators uses regular expression matching, otherwise exact substring matching


matchingClassNames

protected java.util.LinkedList<java.lang.String> matchingClassNames
List of fully qualified class names of operators available

Constructor Detail

ALDOpRunner

public ALDOpRunner(java.lang.String[] args)
Construct a ALDOpRunner using args

Parameters:
args - command line arguments
Method Detail

main

public static void main(java.lang.String[] args)
Main routine of ALDOpRunner , see usage.

Parameters:
args - command line arguments

runIt

public void runIt()
This method does the complete work to scan arguments, read and write parameters and runOp the operator.


getOperator

protected ALDOperator getOperator(java.lang.String opName)
This method is called to instantiate the ALDOperator. May be overrridden may extending classes.


findOperators

protected void findOperators(java.lang.String opNamePattern)
This method is call once to populate the member matchingClassNames. May be overrridden may extending classes.

Parameters:
opNamePattern - string with pattern for operator name

findALDOperators

public java.util.LinkedList<java.lang.String> findALDOperators(java.lang.String opNamePattern)
Find operator with given pattern among all annotated ALDOperators and return the full qualified names as a list. Operators found depend on member variable useRegEx return only ALDOperators annotated with appropriate execution mode.

Parameters:
opNamePattern - string with pattern for operator name

isExactSubstring

protected boolean isExactSubstring(java.lang.String substr,
                                   java.lang.String str)
return true, if substr is a exact substring of str



Copyright © 2010-2014 Martin Luther University Halle-Wittenberg. All Rights Reserved.