Package de.ipk_gatersleben.ag_nw.graffiti.plugins.layouters.pattern_springembedder.clusterCommands

Class SortIntoCluster

java.lang.Object

org.graffiti.plugin.algorithm.AbstractAlgorithm

de.ipk_gatersleben.ag_nw.graffiti.plugins.layouters.pattern_springembedder.clusterCommands.SortIntoCluster

All Implemented Interfaces:

UndoableEdit, Algorithm

public class SortIntoCluster
extends AbstractAlgorithm

Sorts graph elements into cluster. It takes the information to sort into clusters from a selected attribute, that all graph elements have in common. This can be e.g. the average value of experimental data or the correlation coefficient value. The user can select the attribute in the dialog box when the algorithm is executed.

Author:

matthiak

Recent revisions:

2.7.0 Moved to Set Cluster ID LaunchGui window, Java 8 Minimum Compat; Undo/Redo

Constructor Summary

Constructors

Constructor	Description
SortIntoCluster()

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the whole algorithm.
String	getDescription()	The algorithm description.
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 .
void	setParameters(Parameter[] params)	Sets the parameters for this algorithm.

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

addEdit, attach, canRedo, canUndo, check, die, doesUndo, getAcceleratorKeyStroke, getActionEvent, getCategory, getMenuCategory, getPresentationName, getRedoPresentationName, getUndoPresentationName, isAlwaysExecutable, isLayoutAlgorithm, 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

Constructor Details

SortIntoCluster

public SortIntoCluster()

Method Details

getName

public String getName()

Description copied from interface: Algorithm

Returns the name (ID) of the algorithm.

Returns:

DOCUMENT ME!

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

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.

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.

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.

execute

public void execute()

Description copied from interface: Algorithm

Executes the whole algorithm.