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

Class AllPathsSelectionAlgorithm

java.lang.Object

org.graffiti.plugin.algorithm.AbstractAlgorithm

de.ipk_gatersleben.ag_nw.graffiti.plugins.algorithms.shortest_paths.AllPathsSelectionAlgorithm

All Implemented Interfaces:

UndoableEdit, Algorithm

public class AllPathsSelectionAlgorithm
extends AbstractAlgorithm

Constructor Summary

Constructors

Constructor	Description
AllPathsSelectionAlgorithm()	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the whole algorithm.
KeyStroke	getAcceleratorKeyStroke()	Default: no accelerator for the menu item, created for this algorithm.
String	getCategory()	Returns the category an algorithm should assigned to.
String	getName()	Returns the name (ID) of the algorithm.
Parameter[]	getParameters()	Returns a list of Parameter that are set for this algorithm.
static Collection<GraphElement>	getPathElements(Collection<Node> validNodes, Node sourceNode, Collection<Node> targetNodes, boolean includeInnerEdges, boolean directed, boolean includeEdges, int maxDistance)
Set<Category>	getSetCategory()	Returns a set of categories to classify this algorithm .
void	reset()	Resets the internal state of the algorithm.
void	setParameters(Parameter[] params)	Sets the parameters for this algorithm.
void	setSelection(Selection selection)	Sets the selection on which the algorithm works.

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

AllPathsSelectionAlgorithm

public AllPathsSelectionAlgorithm()

Constructs a new instance.

Method Details

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.

See Also:

Algorithm.getParameters()

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

execute

public void execute()

Description copied from interface: Algorithm

Executes the whole algorithm.

See Also:

Algorithm.execute()

getPathElements

public static Collection<GraphElement> getPathElements(Collection<Node> validNodes,
Node sourceNode,
Collection<Node> targetNodes,
boolean includeInnerEdges,
boolean directed,
boolean includeEdges,
int maxDistance)

reset

public void reset()

Description copied from interface: Algorithm

Resets the internal state of the algorithm.

Specified by:

reset in interface Algorithm

Overrides:

reset in class AbstractAlgorithm

See Also:

Algorithm.reset()

getName

public String getName()

Description copied from interface: Algorithm

Returns the name (ID) of the algorithm.

Returns:

DOCUMENT ME!

See Also:

Algorithm.getName()

getAcceleratorKeyStroke

public KeyStroke getAcceleratorKeyStroke()

Description copied from class: AbstractAlgorithm

Default: no accelerator for the menu item, created for this algorithm.

Specified by:

getAcceleratorKeyStroke in interface Algorithm

Overrides:

getAcceleratorKeyStroke in class AbstractAlgorithm

Returns:

NULL (default) if no accelerator should be assigned for this algorithm.

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.

setSelection

public void setSelection(Selection selection)

Sets the selection on which the algorithm works.

Parameters:

selection - the selection