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

Class WeightedShortestPathSelectionAlgorithm

java.lang.Object

org.graffiti.plugin.algorithm.AbstractAlgorithm

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

All Implemented Interfaces:

UndoableEdit, Algorithm

public class WeightedShortestPathSelectionAlgorithm
extends AbstractAlgorithm

Author:

klukas

Constructor Summary

Constructors

Constructor	Description
WeightedShortestPathSelectionAlgorithm()	Constructs a new instance.

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.
KeyStroke	getAcceleratorKeyStroke()	Default: no accelerator for the menu item, created for this algorithm.
String	getCategory()	Returns the category an algorithm should assigned to.
String	getDescription()	The algorithm description.
String	getMenuCategory()	For backwards compatibility the standard implementation will return the Category
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 .
static Collection<GraphElement>	getShortestPathElements(Collection<GraphElement> validGraphElements, GraphElement startGraphElement, org.apache.commons.collections.set.ListOrderedSet targetGraphElements, boolean directed, boolean considerNodeWeight, boolean considerEdgeWeight, double maxDistance, AttributePathNameSearchType weightattribute, boolean putWeightOnEdges, boolean setAttribute, boolean setLabel)
boolean	mayWorkOnMultipleGraphs()
void	reset()	Resets the internal state of the algorithm.
void	setParameters(Parameter[] params)	Sets the parameters for this algorithm.
void	setSelection(Selection selection)

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

WeightedShortestPathSelectionAlgorithm

public WeightedShortestPathSelectionAlgorithm()

Constructs a new instance.

Method Details

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.

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()

getShortestPathElements

public static Collection<GraphElement> getShortestPathElements(Collection<GraphElement> validGraphElements,
GraphElement startGraphElement,
org.apache.commons.collections.set.ListOrderedSet targetGraphElements,
boolean directed,
boolean considerNodeWeight,
boolean considerEdgeWeight,
double maxDistance,
AttributePathNameSearchType weightattribute,
boolean putWeightOnEdges,
boolean setAttribute,
boolean setLabel)

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()

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.

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.

getMenuCategory

public String getMenuCategory()

Description copied from class: AbstractAlgorithm

For backwards compatibility the standard implementation will return the Category

Specified by:

getMenuCategory in interface Algorithm

Overrides:

getMenuCategory in class AbstractAlgorithm

Returns:

setSelection

public void setSelection(Selection selection)

mayWorkOnMultipleGraphs

public boolean mayWorkOnMultipleGraphs()

Specified by:

mayWorkOnMultipleGraphs in interface Algorithm

Overrides:

mayWorkOnMultipleGraphs in class AbstractAlgorithm