Package de.ipk_gatersleben.ag_nw.graffiti.plugins.algorithms.ratioview

Class SubstanceRatioCalculationAlgorithm

java.lang.Object

org.graffiti.plugin.algorithm.AbstractAlgorithm

de.ipk_gatersleben.ag_nw.graffiti.plugins.algorithms.ratioview.SubstanceRatioCalculationAlgorithm

All Implemented Interfaces:

UndoableEdit, Algorithm, AlgorithmWithComponentDescription

public class SubstanceRatioCalculationAlgorithm
extends AbstractAlgorithm
implements AlgorithmWithComponentDescription

Author:

Christian Klukas 10.7.2006

Field Summary

Fields

Modifier and Type	Field	Description
static int	ratioCalculationCount

Constructor Summary

Constructors

Constructor	Description
SubstanceRatioCalculationAlgorithm()

Method Summary

Modifier and Type	Method	Description
void	check()	Checks whether all preconditions of the current graph are satisfied.
void	execute()	Executes the whole algorithm.
Graph	executeAndReturnGraph(BackgroundTaskStatusProviderSupportingExternalCall status)
String	getCategory()	Returns the category an algorithm should assigned to.
String	getDescription()	The algorithm description.
JComponent	getDescriptionComponent()
String	getName()	Returns the name (ID) of the algorithm.
Parameter[]	getParameters()	Returns a list of Parameter that are set for this algorithm.
Set<Category>	getSetCategory()	Returns a set of categories to classify this algorithm .
boolean	isLayoutAlgorithm()	A LayoutAlgorithm should return true.
void	setParameters(Parameter[] params)	Sets the parameters for this algorithm.

Methods inherited from class org.graffiti.plugin.algorithm.AbstractAlgorithm

addEdit, attach, canRedo, canUndo, die, doesUndo, getAcceleratorKeyStroke, getActionEvent, getMenuCategory, getPresentationName, getRedoPresentationName, getUndoPresentationName, isAlwaysExecutable, isSignificant, markExecutionDone, markRedoDone, markUndoDone, mayWorkOnMultipleGraphs, redo, replaceEdit, reset, setActionEvent, showMenuIcon, undo

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ratioCalculationCount

public static int ratioCalculationCount

Constructor Details

SubstanceRatioCalculationAlgorithm

public SubstanceRatioCalculationAlgorithm()

Method Details

getName

public String getName()

Description copied from interface: Algorithm

Returns the name (ID) of the algorithm.

Specified by:

getName in interface Algorithm

Returns:

DOCUMENT ME!

getCategory

public String getCategory()

Description copied from interface: Algorithm

Returns the category an algorithm should assigned to. Return NULL if the algorithm should be sorted directly in the plugin menu.

Specified by:

getCategory in interface Algorithm

Overrides:

getCategory in class AbstractAlgorithm

Returns:

The category an algorithm should assigned to.

getSetCategory

public Set<Category> getSetCategory()

Description copied from interface: Algorithm

Returns a set of categories to classify this algorithm . e.g. return new HashSet(Arrays.asList( Category.GRAPH, Category.NODE )); is an algorithm, working on graphs and more specific on nodes

Specified by:

getSetCategory in interface Algorithm

Overrides:

getSetCategory in class AbstractAlgorithm

Returns:

Set of Category Enums that classify this algorithm.

getDescription

public String getDescription()

Description copied from class: AbstractAlgorithm

The algorithm description.

Specified by:

getDescription in interface Algorithm

Overrides:

getDescription in class AbstractAlgorithm

Returns:

String, could be HTML-styled.

check

public void check()
           throws PreconditionException

Description copied from interface: Algorithm

Checks whether all preconditions of the current graph are satisfied.

Specified by:

check in interface Algorithm

Overrides:

check in class AbstractAlgorithm

Throws:

PreconditionException - if the preconditions of the current graph are not satisfied.

isLayoutAlgorithm

public boolean isLayoutAlgorithm()

Description copied from interface: Algorithm

A LayoutAlgorithm should return true. All other types of algorithms should return false.

Specified by:

isLayoutAlgorithm in interface Algorithm

Overrides:

isLayoutAlgorithm in class AbstractAlgorithm

Returns:

execute

public void execute()

Description copied from interface: Algorithm

Executes the whole algorithm.

Specified by:

execute in interface Algorithm

executeAndReturnGraph

public Graph executeAndReturnGraph(BackgroundTaskStatusProviderSupportingExternalCall status)

getParameters

public Parameter[] getParameters()

Description copied from interface: Algorithm

Returns a list of Parameter that are set for this algorithm.

Specified by:

getParameters in interface Algorithm

Overrides:

getParameters in class AbstractAlgorithm

Returns:

a collection of Parameter that are needed by the Algorithm.

setParameters

public void setParameters(Parameter[] params)

Description copied from interface: Algorithm

Sets the parameters for this algorithm. Must have the same types and order as the array returned by getParameter.

Specified by:

setParameters in interface Algorithm

Overrides:

setParameters in class AbstractAlgorithm

Parameters:

params - Parameter array

getDescriptionComponent

public JComponent getDescriptionComponent()

Specified by:

getDescriptionComponent in interface AlgorithmWithComponentDescription