com.yworks.yfiles.layout.router.polyline

Class PathSearchResult

java.lang.Object

com.yworks.yfiles.layout.router.polyline.PathSearchResult

public class PathSearchResult
extends Object

This class manages the best Paths found for each edge and provides according EdgeInfos.

These are used by the ChannelBasedPathRouting algorithm to calculate the final segment locations for the segments of an edge path.

Constructor Summary

Constructors

Constructor and Description
PathSearchResult(PathSearchConfiguration configuration) Creates a new instance of PathSearchResult.

Method Summary

Modifier and Type	Method and Description
EdgeInfo	getEdgeInfo(Edge edge) Returns an EdgeInfo for the given edge.
EdgeInfo	getEdgeInfo(Path path) Returns an EdgeInfo for the given path.
Path	getPath(Edge edge) Returns the previously registered path found for the edge.
void	setPath(Edge edge, Path path) Specifies a found path for an edge.

Methods inherited from class java.lang.Object

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

Constructor Detail

PathSearchResult

public PathSearchResult(PathSearchConfiguration configuration)

Creates a new instance of PathSearchResult.

Parameters:

configuration - the configuration used for the path search

Method Detail

getEdgeInfo

public EdgeInfo getEdgeInfo(Edge edge)

Returns an EdgeInfo for the given edge.

If the given edge shall be routed but no path has been set for it, yet, null is returned. If no EdgeInfo has been created for the path by this context before, a new one is instantiated, otherwise the stored one is returned.

Parameters:

edge - the edge for which the EdgeInfo will be returned

Returns:

an EdgeInfo describing the path of the edge

See Also:

setPath(Edge, Path)

getEdgeInfo

public EdgeInfo getEdgeInfo(Path path)

Returns an EdgeInfo for the given path.

If no EdgeInfo has been created for this path by this context before, a new one is instantiated, otherwise the stored one is returned.

Parameters:

path - the path for which the EdgeInfo will be returned

Returns:

an EdgeInfo describing the given path

getPath

public Path getPath(Edge edge)

Returns the previously registered path found for the edge.

Parameters:

edge - the edge for which the path is provided

Returns:

the previously registered path found for the edge or null if no path has been registered, yet

setPath

public void setPath(Edge edge,
                    Path path)

Specifies a found path for an edge.

Parameters:

edge - the edge for which the path is set

path - the found path