org.cishell.framework.algorithm
Interface Algorithm


public interface Algorithm

A class which executes some arbitrary code and optionally returns any data produced. What happens when the execute method is run is entirely up to the Algorithm developer. Algorithms should be primed with whatever data is needed, usually by its associated AlgorithmFactory, before execution. This allows an Algorithm to be set up, then scheduled for later execution.

Author:
Bruce Herr (bh2@bh2.net)

Method Summary
 Data[] execute()
          Executes and optionally returns a Data array
 

Method Detail

execute

Data[] execute()
               throws AlgorithmExecutionException
Executes and optionally returns a Data array

Returns:
A Data array that was created. null is ONLY acceptable when the algorithms out_data is null.
Throws:
AlgorithmExecutionException - An exception has occured while executing the algorithm. This exception should have a user-comprehendable message if at all possible.