com.yworks.yfiles.layout

Class YGraphAdapter

java.lang.Object

com.yworks.yfiles.layout.YGraphAdapter

public class YGraphAdapter
extends Object

Converts an IGraph instance into a Graph instance.

This class creates a structural copy of a given IGraph and provides convenience methods to convert items from one graph instance to their corresponding item in the other graph instance.

The main use case of this class is executing one of the analysis algorithms on an IGraph, for example ShortestPaths, Cycles, and Centrality. For executing a layout algorithm, use the convenience class LayoutExecutor, the convenience methods IGraph.applyLayout(ILayoutAlgorithm, LayoutData) and GraphControl.morphLayout(ILayoutAlgorithm, java.time.Duration, com.yworks.yfiles.utils.IEventHandler), or LayoutGraphAdapter.

See Also:

LayoutGraphAdapter, LayoutExecutor, Bipartitions, Centrality, Cycles, GraphChecker, GraphConnectivity, Groups, IndependentSets, NetworkFlows, NodeOrders, Paths, RankAssignments, ShortestPaths, SpanningTrees, Transitivity, Trees

Constructor Summary

Constructors

Constructor and Description
YGraphAdapter(IGraph originalGraph) Initializes a new instance of the YGraphAdapter class.

Method Summary

Modifier and Type	Method and Description
<K,V> IDataMap	createDataMap(Class<K> kType, Class<V> vType, IMapper<K,V> mapper) Creates an IDataMap that delegates to the provided IMapper when queried for items in the YGraph.
<K,V> IDataProvider	createDataProvider(Class<K> kType, Function<K,V> getter) Creates an IDataProvider that delegates to the provided delegate when queried for items in the YGraph.
<K,V> IDataProvider	createDataProvider(Class<K> kType, IMapper<K,V> mapper) Creates an IDataProvider that delegates to the provided IMapper when queried for items in the YGraph.
IListEnumerable<IEdge>	createEdgeEnumerable(EdgeList edges) Creates an enumerable of edges that maps the edges from the EdgeList to their original ones.
EdgeList	createEdgeList(Iterable<IEdge> edges) Creates an EdgeList that maps the edges from the Iterable to their copied ones.
<V> IEdgeMap	createEdgeMap(Function<IEdge,V> getter) Creates an IEdgeMap that delegates to the provided delegate when queried for Edges in the YGraph.
<V> IEdgeMap	createEdgeMap(IMapper<IEdge,V> mapper) Creates an IEdgeMap that delegates to the provided IMapper when queried for Edges in the YGraph.
<T> IMapper<IModelItem,T>	createMapper(IDataProvider dataProvider) Creates an IMapper that delegates to the provided IDataProvider when queried for items in the IGraph.
<T> IMapper<IEdge,T>	createMapper(IEdgeMap edgeMap) Creates an IMapper that delegates to the provided IEdgeMap when queried for items in the IGraph.
<T> IMapper<INode,T>	createMapper(INodeMap nodeMap) Creates an IMapper that delegates to the provided INodeMap when queried for items in the IGraph.
IListEnumerable<INode>	createNodeEnumerable(NodeList nodes) Creates an enumerable of nodes that maps the nodes from the NodeList to their original ones.
NodeList	createNodeList(Iterable<INode> nodes) Creates a NodeList that maps the nodes from the Iterable to their copied ones.
<V> INodeMap	createNodeMap(Function<INode,V> getter) Creates an INodeMap that delegates to the provided delegate when queried for Nodes in the YGraph.
<V> INodeMap	createNodeMap(IMapper<INode,V> mapper) Creates an INodeMap that delegates to the provided IMapper when queried for Nodes in the YGraph.
Edge	getCopiedEdge(IEdge edge) Yields the edge that has been created as a copy in YGraph to represent the given edge.
Node	getCopiedNode(INode node) Yields the node that has been created as a copy in YGraph to represent the given node.
IEdge	getOriginalEdge(Edge edge) Yields the original edge from the original IGraph that the given edge has been created for.
IGraph	getOriginalGraph() Gets the original graph instance.
INode	getOriginalNode(Node node) Yields the original node from the original IGraph that the given node has been created for.
Graph	getYGraph() Gets the graph instance that is created during the constructor call.

Methods inherited from class java.lang.Object

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

Constructor Detail

YGraphAdapter

public YGraphAdapter(IGraph originalGraph)

Initializes a new instance of the YGraphAdapter class.

This will create a copy of the originalGraph that has the same structure and makes it available via the YGraph property.

Parameters:

originalGraph - The original graph whose structure will be copied.

Method Detail

createDataMap

public final <K,V> IDataMap createDataMap(Class<K> kType,
                                          Class<V> vType,
                                          IMapper<K,V> mapper)

Creates an IDataMap that delegates to the provided IMapper when queried for items in the YGraph.

This method is useful where algorithms require IDataMaps as input and that input can be obtained from IMapper instances that provide and accept values for the original nodes and edges.

Type Parameters:

K - The type of the keys in the mapper.

V - The type of the values in the mapper.

Parameters:

vType - The type of the values in the mapper.

kType - The type of the keys in the mapper.

mapper - The mapper to direct requests to.

Returns:

An IDataMap that will delegate the functionality to the mapper.

See Also:

createDataProvider(Class, IMapper)

createDataProvider

public final <K,V> IDataProvider createDataProvider(Class<K> kType,
                                                    Function<K,V> getter)

Creates an IDataProvider that delegates to the provided delegate when queried for items in the YGraph.

This method is useful where algorithms require IDataProviders as input and that input can be through a dynamic callback that provides the values for the original nodes and edges.

Type Parameters:

K - The type of the keys in the mapper.

V - The type of the values in the mapper.

Parameters:

kType - The type of the keys in the mapper.

getter - The mapper delegate to direct requests to.

Returns:

A DataProvider that will delegate requests to the getter.

createDataProvider

public final <K,V> IDataProvider createDataProvider(Class<K> kType,
                                                    IMapper<K,V> mapper)

Creates an IDataProvider that delegates to the provided IMapper when queried for items in the YGraph.

This method is useful where algorithms require IDataProviders as input and that input can be obtained from IMapper instances that provide the values for the original nodes and edges.

Type Parameters:

K - The type of the keys in the mapper.

V - The type of the values in the mapper.

Parameters:

kType - The type of the keys in the mapper.

mapper - The mapper to direct requests to.

Returns:

A DataProvider that will delegate requests to the mapper.

createEdgeEnumerable

public final IListEnumerable<IEdge> createEdgeEnumerable(EdgeList edges)

Creates an enumerable of edges that maps the edges from the EdgeList to their original ones.

This method is useful where algorithms yield EdgeList instances as results and the result needs to be interpreted in terms of the OriginalGraph.

Parameters:

edges - The edge list.

Returns:

An enumerable that contains the original edges for the ones in the list.

createEdgeList

public final EdgeList createEdgeList(Iterable<IEdge> edges)

Creates an EdgeList that maps the edges from the Iterable to their copied ones.

This method is useful where algorithms require EdgeList instances as input and those edges are available as Iterables in the OriginalGraph.

Parameters:

edges - The edges from the OriginalGraph.

Returns:

An EdgeList that contains the copied edges for the ones in the enumerable.

createEdgeMap

public final <V> IEdgeMap createEdgeMap(Function<IEdge,V> getter)

Creates an IEdgeMap that delegates to the provided delegate when queried for Edges in the YGraph.

This method is useful where algorithms require IEdgeMaps as input and this can be mapped to a corresponding dynamic callback that provides the values for the original edges.

Type Parameters:

V - The type of the values in the mapper.

Parameters:

getter - The mapper delegate to direct read requests to.

Returns:

An INodeMap that will delegate reads to the getter.

createEdgeMap

public final <V> IEdgeMap createEdgeMap(IMapper<IEdge,V> mapper)

Creates an IEdgeMap that delegates to the provided IMapper when queried for Edges in the YGraph.

This method is useful where algorithms require IEdgeMaps as input and this can be mapped to corresponding IMapper instances that provide and accept the values for the original edges.

Type Parameters:

V - The type of the values in the mapper.

Parameters:

mapper - The mapper to direct requests to.

Returns:

An IEdgeMap that will delegate reads and writes to the mapper.

createMapper

public final <T> IMapper<IModelItem,T> createMapper(IDataProvider dataProvider)

Creates an IMapper that delegates to the provided IDataProvider when queried for items in the IGraph.

This method is useful where algorithms yield IDataProviders and their values should be provided using IMapper instances that use the original edges and the original nodes.

Type Parameters:

T - The type of the values in the mapper.

Parameters:

dataProvider - The provider to direct requests to.

Returns:

A mapper that will delegate requests to the dataProvider.

createMapper

public final <T> IMapper<IEdge,T> createMapper(IEdgeMap edgeMap)

Creates an IMapper that delegates to the provided IEdgeMap when queried for items in the IGraph.

This method is useful where algorithms yield IDataProviders and their values should be provided using IMapper instances that use the original edges.

Type Parameters:

T - The type of the values in the mapper.

Parameters:

edgeMap - The map to direct requests to.

Returns:

A mapper that will delegate requests to the edgeMap.

createMapper

public final <T> IMapper<INode,T> createMapper(INodeMap nodeMap)

Creates an IMapper that delegates to the provided INodeMap when queried for items in the IGraph.

This method is useful where algorithms yield INodeMaps and their values should be provided using IMapper instances that use the original nodes.

Type Parameters:

T - The type of the values in the mapper.

Parameters:

nodeMap - The map to direct requests to.

Returns:

A mapper that will delegate requests to the nodeMap.

createNodeEnumerable

public final IListEnumerable<INode> createNodeEnumerable(NodeList nodes)

Creates an enumerable of nodes that maps the nodes from the NodeList to their original ones.

This method is useful where algorithms yield NodeList instances as results and the result needs to be interpreted in terms of the OriginalGraph.

Parameters:

nodes - The node list.

Returns:

An enumerable that contains the original nodes for the ones in the list.

createNodeList

public final NodeList createNodeList(Iterable<INode> nodes)

Creates a NodeList that maps the nodes from the Iterable to their copied ones.

This method is useful where algorithms require NodeList instances as input and those nodes are available as Iterables in the OriginalGraph.

Parameters:

nodes - The nodes from the OriginalGraph.

Returns:

A NodeList that contains the copied nodes for the ones in the enumerable.

createNodeMap

public final <V> INodeMap createNodeMap(Function<INode,V> getter)

Creates an INodeMap that delegates to the provided delegate when queried for Nodes in the YGraph.

This method is useful where algorithms require INodeMaps as input and this can be mapped to a corresponding dynamic callback that provides the values for the original nodes.

Type Parameters:

V - The type of the values in the mapper.

Parameters:

getter - The mapper delegate to direct read requests to.

Returns:

An INodeMap that will delegate reads to the getter.

createNodeMap

public final <V> INodeMap createNodeMap(IMapper<INode,V> mapper)

Creates an INodeMap that delegates to the provided IMapper when queried for Nodes in the YGraph.

This method is useful where algorithms require INodeMaps as input and this can be mapped to corresponding IMapper instances that provide and accept the values for the original nodes.

Type Parameters:

V - The type of the values in the mapper.

Parameters:

mapper - The mapper to direct requests to.

Returns:

An INodeMap that will delegate reads and writes to the mapper.

getCopiedEdge

public final Edge getCopiedEdge(IEdge edge)

Yields the edge that has been created as a copy in YGraph to represent the given edge.

Parameters:

edge - The edge for which the representation is returned.

Returns:

The edge that represents edge in YGraph.

getCopiedNode

public final Node getCopiedNode(INode node)

Yields the node that has been created as a copy in YGraph to represent the given node.

Parameters:

node - The node for which the representation is returned.

Returns:

The node that represents node in YGraph.

getOriginalEdge

public final IEdge getOriginalEdge(Edge edge)

Yields the original edge from the original IGraph that the given edge has been created for.

Parameters:

edge - The edge for which the original instance will be returned.

Returns:

The original instance.

getOriginalGraph

public final IGraph getOriginalGraph()

Gets the original graph instance.

Returns:

The original graph.

getOriginalNode

public final INode getOriginalNode(Node node)

Yields the original node from the original IGraph that the given node has been created for.

Parameters:

node - The node for which the original instance will be returned.

Returns:

The original instance.

getYGraph

public final Graph getYGraph()

Gets the graph instance that is created during the constructor call.

Returns:

The graph instance that can be used for the algorithms.