Package de.ipk_gatersleben.ag_nw.graffiti.plugins.gui.dbe.database_processing.go_cluster_histogram

Class CreateGOchildrenClustersHistogramAlgorithm

java.lang.Object

org.graffiti.plugin.algorithm.AbstractAlgorithm

de.ipk_gatersleben.ag_nw.graffiti.plugins.gui.dbe.database_processing.go_cluster_histogram.CreateGOchildrenClustersHistogramAlgorithm

All Implemented Interfaces:

UndoableEdit, Algorithm, AlgorithmWithComponentDescription

public class CreateGOchildrenClustersHistogramAlgorithm
extends AbstractAlgorithm
implements AlgorithmWithComponentDescription

Author:

Christian Klukas (c) 2006 IPK Gatersleben, Group Network Analysis

Constructor Summary

Constructors

Constructor	Description
CreateGOchildrenClustersHistogramAlgorithm()

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the whole algorithm.
String	getCategory()	Returns the category an algorithm should assigned to.
String	getDescription()	The algorithm description.
JComponent	getDescriptionComponent()
static Collection<String>	getLeafNodesClusterIDs(HashSet<Node> processedNodes, NodeHelper nh)
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	processUpstreamNodes(Node n, HashSet<Node> processedNodes)
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, 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

CreateGOchildrenClustersHistogramAlgorithm

public CreateGOchildrenClustersHistogramAlgorithm()

Method Details

getName

public String getName()

Description copied from interface: Algorithm

Returns the name (ID) of the algorithm.

Specified by:

getName in interface Algorithm

Returns:

DOCUMENT ME!

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.

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.

getDescriptionComponent

public JComponent getDescriptionComponent()

Specified by:

getDescriptionComponent in interface AlgorithmWithComponentDescription

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.

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.

Specified by:

execute in interface Algorithm

getLeafNodesClusterIDs

public static Collection<String> getLeafNodesClusterIDs(HashSet<Node> processedNodes,
NodeHelper nh)

processUpstreamNodes

public void processUpstreamNodes(Node n,
HashSet<Node> processedNodes)