suvi.api.alg
Interface GraphLayoutAlgProgressPolicy

All Known Implementing Classes:

BasicGraphLayoutAlgProgressPolicy

public interface GraphLayoutAlgProgressPolicy

Allows the progress of layout computation to be reported and the layout computation to be cancelled.

See Also:

BasicGraphLayoutAlgProgressPolicy

Field Summary

static GraphLayoutAlgProgressPolicy

NULL_PROGRESS_POLICY Null Object [PLOP3, Fowler1999] progress policy that simply does nothing.

Method Summary

void	layoutBegin() Called once just after the layout-method is entered before any layoutProgress calls are made.
void	layoutCancelled(java.lang.Throwable cause) Called once before layoutFinish if the layout computation was cancelled due to an exception.
void	layoutFinish() Called once just before the layout-method is about to return, either normally or as the result of an exception, and after all the layoutProgress calls have been made.
void	layoutProgress(double percentage) Called by the layout algorithm to report progress percentages, between 0.0 and 1.0 at appropriate moments in the computation.

Field Detail

NULL_PROGRESS_POLICY

public static final GraphLayoutAlgProgressPolicy NULL_PROGRESS_POLICY

Null Object [PLOP3, Fowler1999] progress policy that simply does nothing.

Method Detail

layoutBegin

public void layoutBegin()

Called once just after the layout-method is entered before any layoutProgress calls are made.

layoutProgress

public void layoutProgress(double percentage)

Called by the layout algorithm to report progress percentages, between 0.0 and 1.0 at appropriate moments in the computation.

The percentages will not be highly accurate, but should be useful for a simple progress display.

Called first just after the layout-method is entered, with value 0.0, and last just before the layout-method is about to return, with value 1.0. Other call points are not specified and may vary depending on algorithm.

This method is always called from an environment that allows this method to throw any unchecked exception to effectively terminate the layout computation.

layoutCancelled

public void layoutCancelled(java.lang.Throwable cause)

Called once before layoutFinish if the layout computation was cancelled due to an exception.

layoutFinish

public void layoutFinish()

Called once just before the layout-method is about to return, either normally or as the result of an exception, and after all the layoutProgress calls have been made.