Field Detail

• name

  protected String name

Constructor Detail

• Algorithm

  public Algorithm(String name)

Method Detail

• execute

  public abstract void execute(DataContainer<T> container)
                        throws MissingPreconditionException

  Executes the previously initialized Algorithm.

  Throws:

  MissingPreconditionException

• getName

  public String getName()

• processResults

  public void processResults(ResultHandler<T> handler)

  A method to give the algorithm the opportunity to let its results being processed by the passed handler. By default this methods passes the collected warnings to the handler and sub-classes should make use of this by adding custom behavior and call the super class.

  Parameters:

  handler - The ResultHandler to process the results.

• getWarnings

  public List<Warning> getWarnings()

  Gets a reference to the warnings.

  Returns:

  A reference to the warnings list

• addWarning

  protected void addWarning(String shortMsg,
                            String longMsg)

  Adds a warning to the list of warnings.

  Parameters:

  shortMsg - A short descriptive message

  longMsg - A long message