org.eth.cyril.graphdrawing.graph.drawing

Class GraphDrawingAlgorithm<T extends EmptyConfiguration>

java.lang.Object

org.eth.cyril.graphdrawing.graph.drawing.GraphDrawingAlgorithm<T>

Direct Known Subclasses:

SugiyamaDrawingAlgorithm

public abstract class GraphDrawingAlgorithm<T extends EmptyConfiguration>
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
GraphDrawingAlgorithm()

Method Summary

Modifier and Type	Method and Description
void	addProgressMonitor(ProgressMonitor monitor) Add a new progress monitor to the algorithm.
abstract T	defaultConfiguration() Returns the default configuration of the generic type.
java.util.concurrent.Future<DrawingFrame>	determinePositions(Graph graph, DrawingFrame frame) Let the algorithm determine the positions of the nodes in the graph within the given frame using the default configuration.
java.util.concurrent.Future<DrawingFrame>	determinePositions(Graph graph, DrawingFrame frame, EmptyConfiguration configuration) Let the algorithm determine the positions of the nodes in the given graph within the given frame using the given configuration.
java.util.concurrent.Future<DrawingFrame>	determinePositionsTyped(Graph graph, DrawingFrame frame, T configuration) Let the algorithm determine the positions of the nodes in the given graph within the given frame using the given configuration.
protected abstract DrawingFrame	determinePositionsTypedImpl(Graph graph, DrawingFrame frame, T configuration)
abstract java.lang.Class<? extends T>	getConfigurationClass() The class of which the configuration object should be.
protected void	notifyProgressMonitors(ProgressMonitor.Progress progress)
void	removeProgressMonitor(ProgressMonitor monitor) Remove the progress monitor.

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphDrawingAlgorithm

public GraphDrawingAlgorithm()

Method Detail

defaultConfiguration

public abstract T defaultConfiguration()

Returns the default configuration of the generic type. This configuration should be a new object, if it can be changed. Otherwise it may be a shared object.

Returns:

The default configuration to use for this algorithm.

determinePositions

public java.util.concurrent.Future<DrawingFrame> determinePositions(Graph graph,
                                                                    DrawingFrame frame)

Let the algorithm determine the positions of the nodes in the graph within the given frame using the default configuration.

Parameters:

graph - The graph with the nodes at their initial positions.

frame - The drawing frame within which the nodes should be contained. This is considered as a suggestion only.

Returns:

The new drawing frame where the graph was drawn into.

determinePositions

public java.util.concurrent.Future<DrawingFrame> determinePositions(Graph graph,
                                                                    DrawingFrame frame,
                                                                    EmptyConfiguration configuration)

Let the algorithm determine the positions of the nodes in the given graph within the given frame using the given configuration.

Parameters:

graph - The graph with the nodes at their initial positions.

frame - The drawing frame within which the nodes should be contained. This is considered as a suggestion only.

configuration - The algorithm configuration. If this doesn't conform to the expected type T, the default configuration is used.

Returns:

The new drawing frame where the graph was drawn into.

determinePositionsTyped

public java.util.concurrent.Future<DrawingFrame> determinePositionsTyped(Graph graph,
                                                                         DrawingFrame frame,
                                                                         T configuration)

Let the algorithm determine the positions of the nodes in the given graph within the given frame using the given configuration. This version of the method assumes that the client knows the type T and can therefore call this method directly.

Parameters:

graph - The graph with the nodes at their initial positions.

frame - The drawing frame within which the nodes should be contained. This is considered as a suggestion only.

configuration - The algorithm configuration.

Returns:

The new drawing frame where the graph was drawn into.

determinePositionsTypedImpl

protected abstract DrawingFrame determinePositionsTypedImpl(Graph graph,
                                                            DrawingFrame frame,
                                                            T configuration)

getConfigurationClass

public abstract java.lang.Class<? extends T> getConfigurationClass()

The class of which the configuration object should be.

Returns:

The class of which the configuration object should be.

addProgressMonitor

public void addProgressMonitor(ProgressMonitor monitor)

Add a new progress monitor to the algorithm. Not all algorithms notify their monitors about progress. However, long-running algorithms should have the aim of doing so.

Parameters:

monitor - The monitor to be notified about progress.

removeProgressMonitor

public void removeProgressMonitor(ProgressMonitor monitor)

Remove the progress monitor. Does nothing if it doesn't exist.

Parameters:

monitor - The monitor to remove.

notifyProgressMonitors

protected void notifyProgressMonitors(ProgressMonitor.Progress progress)