Package edu.uci.ics.jung.visualization.layout

Class PersistentLayoutImpl<V,E>

java.lang.Object

edu.uci.ics.jung.algorithms.layout.LayoutDecorator<V,E>

edu.uci.ics.jung.visualization.layout.ObservableCachingLayout<V,E>

edu.uci.ics.jung.visualization.layout.PersistentLayoutImpl<V,E>

All Implemented Interfaces:

com.google.common.base.Function<V,java.awt.geom.Point2D>, Layout<V,E>, IterativeContext, LayoutEventSupport<V,E>, PersistentLayout<V,E>, Caching, ChangeEventSupport, java.util.function.Function<V,java.awt.geom.Point2D>

public class PersistentLayoutImpl<V,E>
extends ObservableCachingLayout<V,E>
implements PersistentLayout<V,E>, ChangeEventSupport, Caching

Implementation of PersistentLayout. Defers to another layout until 'restore' is called, then it uses the saved vertex locations

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PersistentLayoutImpl.RandomPointFactory<V>

Nested classes/interfaces inherited from interface edu.uci.ics.jung.visualization.layout.PersistentLayout

PersistentLayout.Point

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.Set<V>	dontmove	a collection of Vertices that should not move
protected java.util.Map<V,PersistentLayout.Point>	locations	a container for Vertices
protected boolean	locked	whether the graph is locked (stops the VisualizationViewer rendering thread)

Fields inherited from class edu.uci.ics.jung.visualization.layout.ObservableCachingLayout

changeSupport

Fields inherited from class edu.uci.ics.jung.algorithms.layout.LayoutDecorator

delegate

Constructor Summary

Constructors

Constructor	Description
PersistentLayoutImpl(Layout<V,E> layout)	create an instance with a passed layout create containers for graph components

Method Summary

Modifier and Type	Method	Description
boolean	done()
protected void	initializeLocation(V v, java.awt.geom.Point2D coord)	Sets persisted location for a vertex within the dimensions of the space.
protected void	initializeLocations()	This method calls initialize_local_vertex for each vertex, and also adds initial coordinate information for each vertex.
void	lock(boolean locked)
void	lock(V v, boolean state)	Locks or unlocks the specified vertex.
void	persist(java.lang.String fileName)	save the Vertex locations to a file
void	restore(java.lang.String fileName)	Restore the graph Vertex locations from a file

Methods inherited from class edu.uci.ics.jung.visualization.layout.ObservableCachingLayout

addChangeListener, addLayoutChangeListener, apply, clear, fireStateChanged, getChangeListeners, init, initialize, removeChangeListener, removeLayoutChangeListener, setGraph, setLocation, step

Methods inherited from class edu.uci.ics.jung.algorithms.layout.LayoutDecorator

getDelegate, getGraph, getSize, isLocked, reset, setDelegate, setInitializer, setSize, transform

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.uci.ics.jung.visualization.util.Caching

clear, init

Methods inherited from interface edu.uci.ics.jung.visualization.util.ChangeEventSupport

addChangeListener, fireStateChanged, getChangeListeners, removeChangeListener

Methods inherited from interface com.google.common.base.Function

apply, equals

Methods inherited from interface java.util.function.Function

andThen, compose

Methods inherited from interface edu.uci.ics.jung.algorithms.layout.Layout

getGraph, getSize, initialize, isLocked, reset, setGraph, setInitializer, setLocation, setSize

Field Detail

locations

protected java.util.Map<V,PersistentLayout.Point> locations

a container for Vertices

dontmove

protected java.util.Set<V> dontmove

a collection of Vertices that should not move

locked

protected boolean locked

whether the graph is locked (stops the VisualizationViewer rendering thread)

Constructor Detail

PersistentLayoutImpl

public PersistentLayoutImpl(Layout<V,E> layout)

create an instance with a passed layout create containers for graph components

Parameters:

layout - the layout whose positions are to be persisted

Method Detail

initializeLocations

protected void initializeLocations()

This method calls initialize_local_vertex for each vertex, and also adds initial coordinate information for each vertex. (The vertex's initial location is set by calling initializeLocation.

initializeLocation

protected void initializeLocation(V v,
                                  java.awt.geom.Point2D coord)

Sets persisted location for a vertex within the dimensions of the space. If the vertex has not been persisted, sets a random location. If you want to initialize in some different way, override this method.

Parameters:

v - the vertex whose location is to be initialized

coord - the location

persist

public void persist(java.lang.String fileName)
             throws java.io.IOException

save the Vertex locations to a file

Specified by:

persist in interface PersistentLayout<V,E>

Parameters:

fileName - the file to save to

Throws:

java.io.IOException - if the file cannot be used

restore

public void restore(java.lang.String fileName)
             throws java.io.IOException,
                    java.lang.ClassNotFoundException

Restore the graph Vertex locations from a file

Specified by:

restore in interface PersistentLayout<V,E>

Parameters:

fileName - the file to use

Throws:

java.io.IOException - for file problems

java.lang.ClassNotFoundException - for classpath problems

lock

public void lock(boolean locked)

Specified by:

lock in interface PersistentLayout<V,E>

done

public boolean done()

Specified by:

done in interface IterativeContext

Overrides:

done in class ObservableCachingLayout<V,E>

Returns:

true if this iterative process is finished, and false otherwise.

lock

public void lock(V v,
                 boolean state)

Description copied from interface: Layout

Locks or unlocks the specified vertex. Locking the vertex fixes it at its current position, so that it will not be affected by the layout algorithm. Unlocking it allows the layout algorithm to change the vertex's position.

Specified by:

lock in interface Layout<V,E>

Overrides:

lock in class LayoutDecorator<V,E>

Parameters:

v - the vertex to lock/unlock

state - true to lock the vertex, false to unlock it