Class PajekClusterColor
java.lang.Object
org.graffiti.plugin.algorithm.AbstractAlgorithm
de.ipk_gatersleben.ag_nw.graffiti.plugins.layouters.pattern_springembedder.clusterCommands.PajekClusterColor
- All Implemented Interfaces:
UndoableEdit
,Algorithm
public class PajekClusterColor extends AbstractAlgorithm
- Author:
- Christian Klukas (c) 2004 IPK-Gatersleben
-
Constructor Summary
Constructors Constructor Description PajekClusterColor()
-
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.static void
executeClusterColoringOnGraph(Graph g)
Colour clusters based on the stored ClusterColorAttribute for the graph.static void
executeClusterColoringOnGraph(Graph g, ClusterColorAttribute cca)
static void
executeClusterColoringOnGraph(Graph g, Collection<String> clusters, ClusterColorAttribute cca)
String
getCategory()
Returns the category an algorithm should assigned to.String
getDescription()
The algorithm description.String
getName()
Returns the name (ID) of the algorithm.Parameter[]
getParameters()
Returns a list ofParameter
that are set for this algorithm.Set<Category>
getSetCategory()
Returns a set of categories to classify this algorithm .boolean
mayWorkOnMultipleGraphs()
static void
removeClusterColoringOnGraph(Graph g)
Re-colours graph elements to their default fill and outline colours.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, isLayoutAlgorithm, isSignificant, markExecutionDone, markRedoDone, markUndoDone, redo, replaceEdit, reset, setActionEvent, showMenuIcon, undo
-
Constructor Details
-
PajekClusterColor
public PajekClusterColor()
-
-
Method Details
-
getName
Description copied from interface:Algorithm
Returns the name (ID) of the algorithm.- Returns:
- DOCUMENT ME!
-
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 interfaceAlgorithm
- Overrides:
getSetCategory
in classAbstractAlgorithm
- Returns:
- Set of Category Enums that classify this algorithm.
-
check
Description copied from interface:Algorithm
Checks whether all preconditions of the current graph are satisfied.- Specified by:
check
in interfaceAlgorithm
- Overrides:
check
in classAbstractAlgorithm
- Throws:
PreconditionException
- if the preconditions of the current graph are not satisfied.
-
getParameters
Description copied from interface:Algorithm
Returns a list ofParameter
that are set for this algorithm.- Specified by:
getParameters
in interfaceAlgorithm
- Overrides:
getParameters
in classAbstractAlgorithm
- Returns:
- a collection of
Parameter
that are needed by theAlgorithm
.
-
setParameters
Description copied from interface:Algorithm
Sets the parameters for this algorithm. Must have the same types and order as the array returned bygetParameter
.- Specified by:
setParameters
in interfaceAlgorithm
- Overrides:
setParameters
in classAbstractAlgorithm
- Parameters:
params
- Parameter array
-
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 interfaceAlgorithm
- Overrides:
getCategory
in classAbstractAlgorithm
- Returns:
- The category an algorithm should assigned to.
-
getDescription
Description copied from class:AbstractAlgorithm
The algorithm description.- Specified by:
getDescription
in interfaceAlgorithm
- Overrides:
getDescription
in classAbstractAlgorithm
- Returns:
- String, could be HTML-styled.
-
execute
public void execute()Description copied from interface:Algorithm
Executes the whole algorithm. -
executeClusterColoringOnGraph
Colour clusters based on the stored ClusterColorAttribute for the graph.- Parameters:
g
- graph Graph- Since:
- 2.7.0
-
executeClusterColoringOnGraph
-
executeClusterColoringOnGraph
public static void executeClusterColoringOnGraph(Graph g, Collection<String> clusters, ClusterColorAttribute cca) -
removeClusterColoringOnGraph
Re-colours graph elements to their default fill and outline colours. Colouring attribute values are preserved.- Parameters:
g
-- Since:
- 2.7.0
-
mayWorkOnMultipleGraphs
public boolean mayWorkOnMultipleGraphs()- Specified by:
mayWorkOnMultipleGraphs
in interfaceAlgorithm
- Overrides:
mayWorkOnMultipleGraphs
in classAbstractAlgorithm
-