Package de.ipk_gatersleben.ag_nw.graffiti.plugins.misc.scripting

Class BeanShellDesktopAlgorithm

java.lang.Object

org.graffiti.plugin.algorithm.AbstractAlgorithm

de.ipk_gatersleben.ag_nw.graffiti.plugins.misc.scripting.BeanShellDesktopAlgorithm

All Implemented Interfaces:

UndoableEdit, Algorithm

public class BeanShellDesktopAlgorithm
extends AbstractAlgorithm

Provides a Bean Shell Desktop for the execution of Bean Shell Scripts.

Author:

Dirk Koschützki, Christian Klukas

Constructor Summary

Constructors

Constructor	Description
BeanShellDesktopAlgorithm()	Creates a new BeanShellDesktopAlgorithm object.

Method Summary

Modifier and Type	Method	Description
void	check()	No special checks implemented.
void	execute()	Starts the Bean Shell Desktop.
String	getCategory()	Returns the category an algorithm should assigned to.
String	getName()	Returns the algorithms name.
Set<Category>	getSetCategory()	Returns a set of categories to classify this algorithm .
void	reset()	No special reset implemented.

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

BeanShellDesktopAlgorithm

public BeanShellDesktopAlgorithm()

Creates a new BeanShellDesktopAlgorithm object.

Method Details

getName

public String getName()

Returns the algorithms name.

Returns:

the algorithms name

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.

check

public void check()
           throws PreconditionException

No special checks implemented.

Specified by:

check in interface Algorithm

Overrides:

check in class AbstractAlgorithm

Throws:

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

execute

public void execute()

Starts the Bean Shell Desktop.

reset

public void reset()

No special reset implemented.

Specified by:

reset in interface Algorithm

Overrides:

reset in class AbstractAlgorithm