PersistentLayoutImpl

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:

edu.uci.ics.jung.algorithms.layout.Layout<V,E>, edu.uci.ics.jung.algorithms.util.IterativeContext, PersistentLayout<V,E>, Caching, ChangeEventSupport, org.apache.commons.collections4.Transformer<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 and Description

static class PersistentLayoutImpl.RandomPointFactory
- Nested classes/interfaces inherited from interface edu.uci.ics.jung.visualization.layout.PersistentLayout
  PersistentLayout.Point

Nested Classes
Modifier and Type	Class and Description
`static class`	`PersistentLayoutImpl.RandomPointFactory`

Field Summary

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

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

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

Constructor Summary

Constructors
Constructor and Description
`PersistentLayoutImpl(edu.uci.ics.jung.algorithms.layout.Layout<V,E> layout)` create an instance with a passed layout create containers for graph components

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`done()`
`protected void`	`initializeLocation(V v, java.awt.geom.Point2D coord, java.awt.Dimension d)` 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)`
`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, clear, fireStateChanged, getChangeListeners, init, initialize, removeChangeListener, setGraph, setLocation, step, transform

Methods inherited from class edu.uci.ics.jung.algorithms.layout.LayoutDecorator
getDelegate, getGraph, getSize, isLocked, reset, setDelegate, setInitializer, setSize

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.algorithms.layout.Layout
getGraph, getSize, initialize, isLocked, reset, setGraph, setInitializer, setLocation, setSize

Methods inherited from interface org.apache.commons.collections4.Transformer
transform

Methods inherited from interface edu.uci.ics.jung.visualization.util.ChangeEventSupport
addChangeListener, fireStateChanged, getChangeListeners, removeChangeListener

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

- Field Detail
  - map
```
protected java.util.Map<V,PersistentLayout.Point> map
```
    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(edu.uci.ics.jung.algorithms.layout.Layout<V,E> layout)
```
    create an instance with a passed layout create containers for graph components
    
    Parameters:
    layout -
- 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,
                      java.awt.Dimension d)
```
    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 -
    coord -
    d -
  - 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:
    
    an - IOException if the file cannot be used
    
    java.io.IOException
  - 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 edu.uci.ics.jung.algorithms.util.IterativeContext
    
    Overrides:
    
    done in class ObservableCachingLayout<V,E>
    
    See Also:
    IterativeContext.done()
  - lock
```
public void lock(V v,
        boolean state)
```
    Specified by:
    
    lock in interface edu.uci.ics.jung.algorithms.layout.Layout<V,E>
    
    Overrides:
    
    lock in class edu.uci.ics.jung.algorithms.layout.LayoutDecorator<V,E>

Class PersistentLayoutImpl<V,E>

Nested Class Summary

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

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.commons.collections4.Transformer

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

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

Field Detail

map

dontmove

locked

Constructor Detail

PersistentLayoutImpl

Method Detail

initializeLocations

initializeLocation

persist

restore

lock

done

lock