com.yworks.yfiles.layout

Class CopiedLayoutGraph

java.lang.Object

com.yworks.yfiles.algorithms.Graph

com.yworks.yfiles.layout.LayoutGraph

com.yworks.yfiles.layout.CopiedLayoutGraph

All Implemented Interfaces:

com.yworks.yfiles.algorithms.IGraphInterface, com.yworks.yfiles.layout.IGraphLayout

public class CopiedLayoutGraph
extends LayoutGraph

A CopiedLayoutGraph is a LayoutGraph that serves as a copy of another graph with layout information.

A CopiedLayoutGraph comes to use if a layout algorithm should not run directly on the original graph. Using a copy, the calculated layout will not be applied to the original graph before the layout algorithm finished successfully. This can prevent inconsistencies in case something goes wrong during layout calculations.

Concept

CopiedLayoutGraph contains corresponding nodes and edges for each node and edge in the original graph and copies the labels of the original nodes and edges. It also delegates all IDataProviders registered with the original graph.

To preserve the relations between the original elements and the copied elements in this graph, CopiedLayoutGraph updates mappings between those elements.

If there are structural changes to the original graph, they can be transferred to this copied graph using syncStructure(). Then the copied graph will be altered, adding and removing elements, until it corresponds to the original again.

Method commitLayoutToOriginalGraph() will transfer updated layout information to the original graph. The original graph will stay unchanged until this method is called.

See Also:

BufferedLayout

Constructor Summary

Constructors

Constructor and Description
CopiedLayoutGraph(LayoutGraph graph) Creates a new CopiedLayoutGraph instance which is a copy of the given graph.

Method Summary

Modifier and Type	Method and Description
void	commitLayoutToOriginalGraph() Writes the current layout information of all elements of this copied graph to the original graph.
Edge	createEdge(Object originalEdge) Creates an edge in the copied graph that corresponds to the given original edge.
protected ILabelLayoutFactory	createLabelFactory() Creates a new ILabelLayoutFactory for this CopiedLayoutGraph.
Node	createNode(Object originalNode) Creates a node in the copied graph that corresponds to the given original node.
Edge	getCopiedEdge(Object originalEdge) Returns the copied edge that corresponds to the given original edge.
Node	getCopiedNode(Object originalNode) Returns the copied node that corresponds to the given original node.
IEdgeLabelLayout[]	getLabelLayout(Edge copiedEdge) Returns the layout information for all labels associated with the given edge of the copied graph.
INodeLabelLayout[]	getLabelLayout(Node copiedNode) Returns the layout information for all labels associated with the given node of the copied graph.
IEdgeLayout	getLayout(Edge copiedEdge) Returns the layout information for the given edge of the copied graph.
INodeLayout	getLayout(Node copiedNode) Returns the layout information for the given node of the copied graph.
Object	getOriginalEdge(Edge copiedEdge) Returns the original edge that corresponds to the given copied edge.
Object	getOriginalNode(Node copiedNode) Returns the original node that corresponds to the given copied node.
Edge	getOwner(IEdgeLabelLayout labelLayout) Returns the edge of the copied graph to which the given IEdgeLabelLayout belongs.
Node	getOwner(INodeLabelLayout labelLayout) Returns the edge of the copied graph to which the given IEdgeLabelLayout belongs.
void	syncStructure() Synchronizes the structure of the CopiedLayoutGraph with the actual structure of the underlying original graph.

Methods inherited from class com.yworks.yfiles.layout.LayoutGraph

getBoundingBox, getBoundingBox, getCenter, getCenterX, getCenterY, getEdgeList, getHeight, getLocation, getPath, getPathList, getPointList, getPoints, getSize, getSourcePointAbs, getSourcePointRel, getTargetPointAbs, getTargetPointRel, getWidth, getX, getY, moveBy, setCenter, setCenter, setEndPointsAbs, setLocation, setLocation, setPath, setPath, setPoints, setPoints, setSize, setSize, setSourcePointAbs, setSourcePointRel, setTargetPointAbs, setTargetPointRel

Methods inherited from class com.yworks.yfiles.algorithms.Graph

addDataProvider, changeEdge, changeEdge, changeEdge, clear, contains, contains, containsEdge, createCopy, createEdge, createEdge, createEdgeMap, createGraph, createNode, createNodeMap, disposeEdgeMap, disposeNodeMap, edgeCount, edgeObjects, firstEdge, firstNode, firstOutEdge, getDataProvider, getDataProviderKeys, getEdgeArray, getEdgeCursor, getEdges, getNodeArray, getNodeCursor, getNodes, getRegisteredEdgeMaps, getRegisteredNodeMaps, getSource, getTarget, hasListeners, hide, hide, isEmpty, lastEdge, lastNode, moveToFirst, moveToFirst, moveToLast, moveToLast, nodeCount, nodeObjects, printNodeSlotSize, reInsertEdge, reInsertNode, removeDataProvider, removeEdge, removeNode, reverseEdge, sortEdges, sortEdges, sortNodes, toString, unhide, unhide

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yworks.yfiles.layout.IGraphLayout

getEdgeLabelLayout, getEdgeLayout, getNodeLabelLayout, getNodeLayout

Constructor Detail

CopiedLayoutGraph

public CopiedLayoutGraph(LayoutGraph graph)

Creates a new CopiedLayoutGraph instance which is a copy of the given graph.

Parameters:

graph - the original graph

Method Detail

commitLayoutToOriginalGraph

public void commitLayoutToOriginalGraph()

Writes the current layout information of all elements of this copied graph to the original graph.

This works only if the original graph structure was not changed.

createEdge

public Edge createEdge(Object originalEdge)

Creates an edge in the copied graph that corresponds to the given original edge.

The edge will connect to the copies of the source and target of the original edge. All labels of the original edge will be also copied and assigned to this edge.

The mappings are updated. Hence, it is possible to look up the newly created edge by using getCopiedEdge(Object) or the original edge by using getOriginalEdge(Edge).

This method can be used for keeping the CopiedLayoutGraph in sync with the original graph.

Parameters:

originalEdge - the original edge

Returns:

the copy of the original edge

createLabelFactory

protected ILabelLayoutFactory createLabelFactory()

Creates a new ILabelLayoutFactory for this CopiedLayoutGraph.

Subclasses overriding this method must provide an instance that manages the mapping between copied and original ILabelLayouts.

Specified by:

createLabelFactory in class LayoutGraph

Returns:

the new label layout factory

createNode

public Node createNode(Object originalNode)

Creates a node in the copied graph that corresponds to the given original node.

All labels of the original node will be copied and assigned to this node.

The mappings are updated. Hence, it is possible to look up the newly created node by using getCopiedNode(Object) or the original node by using getOriginalNode(Node).

This method can be used for keeping the CopiedLayoutGraph in sync with the original graph.

Parameters:

originalNode - the original node

Returns:

the copy of the original node

getCopiedEdge

public Edge getCopiedEdge(Object originalEdge)

Returns the copied edge that corresponds to the given original edge.

Parameters:

originalEdge - an edge of the original graph whose copy resides in this graph

Returns:

an edge in this graph that is the copy of the given original edge

getCopiedNode

public Node getCopiedNode(Object originalNode)

Returns the copied node that corresponds to the given original node.

Parameters:

originalNode - a node of the original graph whose copy resides in this graph

Returns:

a node in this graph that is the copy of the given original node

getLabelLayout

public IEdgeLabelLayout[] getLabelLayout(Edge copiedEdge)

Returns the layout information for all labels associated with the given edge of the copied graph.

If there is no layout information for a label, yet, a new implementation of IEdgeLabelLayout is created.

Specified by:

getLabelLayout in class LayoutGraph

Parameters:

copiedEdge - the edge

Returns:

the label layout information for all labels of the given edge

getLabelLayout

public INodeLabelLayout[] getLabelLayout(Node copiedNode)

Returns the layout information for all labels associated with the given node of the copied graph.

If there is no layout information for a label, yet, a new implementation of INodeLabelLayout is created.

Specified by:

getLabelLayout in class LayoutGraph

Parameters:

copiedNode - the node

Returns:

the label layout information for all labels of the given node

getLayout

public IEdgeLayout getLayout(Edge copiedEdge)

Returns the layout information for the given edge of the copied graph.

If there is no layout information for this edge, yet, a new implementation of IEdgeLayout is returned.

Specified by:

getLayout in class LayoutGraph

Parameters:

copiedEdge - the edge

Returns:

the layout information for the edge

getLayout

public INodeLayout getLayout(Node copiedNode)

Returns the layout information for the given node of the copied graph.

If there is no layout information for this node, yet, a new implementation of INodeLayout is returned.

Specified by:

getLayout in class LayoutGraph

Parameters:

copiedNode - the node

Returns:

the layout information for the node

getOriginalEdge

public Object getOriginalEdge(Edge copiedEdge)

Returns the original edge that corresponds to the given copied edge.

Parameters:

copiedEdge - the edge in this graph that is a copy of the returned edge

Returns:

the edge in the original graph whose copy is the given edge

getOriginalNode

public Object getOriginalNode(Node copiedNode)

Returns the original node that corresponds to the given copied node.

Parameters:

copiedNode - the node in this graph that is a copy of the returned node

Returns:

the node in the original graph whose copy is the given node

getOwner

public Edge getOwner(IEdgeLabelLayout labelLayout)

Returns the edge of the copied graph to which the given IEdgeLabelLayout belongs.

Specified by:

getOwner in class LayoutGraph

Parameters:

labelLayout - a label layout information of an edge in the copied graph

Returns:

the edge that belongs to the given label layout

getOwner

public Node getOwner(INodeLabelLayout labelLayout)

Returns the edge of the copied graph to which the given IEdgeLabelLayout belongs.

Specified by:

getOwner in class LayoutGraph

Parameters:

labelLayout - a label layout information of a node in the copied graph

Returns:

the node that belongs to the given label layout

syncStructure

public void syncStructure()

Synchronizes the structure of the CopiedLayoutGraph with the actual structure of the underlying original graph.