agi.foundation.access

(agi.foundation.core-2024r3.jar)

Class LinkGraph

java.lang.Object

agi.foundation.access.LinkGraph

public class LinkGraph
extends Object

A graph of links (IServiceProvider instances providing ILinkService) represented as an adjacency list.

Constructor Summary

Constructors

Constructor and Description
LinkGraph() Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
void	addLink(IServiceProvider link) Adds a link to the graph.
boolean	contains(IServiceProvider link) Determines whether the given link is in the graph.
IServiceProvider[]	findAllLinksAtNode(IServiceProvider node, LinkGraphDirection direction) Find all the links which contain the given node and are in the correct direction.
LinkPath[]	findAllPaths(IServiceProvider initial, IServiceProvider _final, LinkGraphDirection direction) Finds all paths between two objects.
LinkPath[]	findAllPaths(IServiceProvider initial, IServiceProvider _final, LinkGraphDirection direction, int maximumLength) Finds all paths between two objects.
LinkPath	findShortestPath(IServiceProvider initial, IServiceProvider _final, LinkGraphDirection direction) Finds the shortest path between an initial object and a final object.

Methods inherited from class java.lang.Object

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

Constructor Detail

LinkGraph

public LinkGraph()

Initializes a new instance.

Method Detail

addLink

public final void addLink(@Nonnull
                          IServiceProvider link)

Adds a link to the graph.

Parameters:

link - The link to add.

findShortestPath

@Nullable
public final LinkPath findShortestPath(IServiceProvider initial,
                                                  IServiceProvider _final,
                                                  @Nonnull
                                                  LinkGraphDirection direction)

Finds the shortest path between an initial object and a final object.

Parameters:

initial - The initial object.

_final - The final object.

direction - The direction of the signal. If this parameter is LinkGraphDirection.TRANSMIT, the initial object is transmitting to the _final object and all links along the way must be in the transmit direction. If this parameter is LinkGraphDirection.RECEIVE, the _final object is receiving from the _final object and all links along the way must be in the receive direction. If this parameter is LinkGraphDirection.IGNORE, the signal direction is ignored and links in either direction can be traversed.

Returns:

A list of links traversed along the shortest path from initial to _final. If a path does not exist, null is returned. If the initial and final objects are the same an empty array is returned.

findAllPaths

@Nullable
public final LinkPath[] findAllPaths(IServiceProvider initial,
                                                IServiceProvider _final,
                                                @Nonnull
                                                LinkGraphDirection direction)

Finds all paths between two objects. The first returned path is the shortest and successive paths are arranged in increasing order of distance.

Parameters:

initial - The source object.

_final - The destination object.

direction - The direction of the signal. If this parameter is LinkGraphDirection.TRANSMIT, the initial object is transmitting to the _final object and all links along the way must be in the transmit direction. If this parameter is LinkGraphDirection.RECEIVE, the _final object is receiving from the _final object and all links along the way must be in the receive direction. If this parameter is LinkGraphDirection.IGNORE, the signal direction is ignored and links in either direction can be traversed.

Returns:

A list of paths between the objects, or null if either object is not in the graph. Each path is a list of links that are traversed along the path.

findAllPaths

@Nullable
public final LinkPath[] findAllPaths(IServiceProvider initial,
                                                IServiceProvider _final,
                                                @Nonnull
                                                LinkGraphDirection direction,
                                                int maximumLength)

Finds all paths between two objects. The first returned path is the shortest and successive paths are arranged in increasing order of distance.

Parameters:

initial - The source object.

_final - The destination object.

direction - The direction of the signal. If this parameter is LinkGraphDirection.TRANSMIT, the initial object is transmitting to the _final object and all links along the way must be in the transmit direction. If this parameter is LinkGraphDirection.RECEIVE, the _final object is receiving from the _final object and all links along the way must be in the receive direction. If this parameter is LinkGraphDirection.IGNORE, the signal direction is ignored and links in either direction can be traversed.

maximumLength - The maximum length of paths to explore. The length of a path is the number of links in the path.

Returns:

A list of paths between the objects, or null if either object is not in the graph. Each path is a list of links that are traversed along the path.

findAllLinksAtNode

@Nonnull
public final IServiceProvider[] findAllLinksAtNode(IServiceProvider node,
                                                             @Nonnull
                                                             LinkGraphDirection direction)

Find all the links which contain the given node and are in the correct direction.

Parameters:

node - The node for which to search.

direction - The direction for which to search.

Returns:

A list of links containing the given node and with the node at the correct end.

contains

public final boolean contains(IServiceProvider link)

Determines whether the given link is in the graph.

Parameters:

link - The link to locate in the graph.

Returns:

true if the link is in the graph; otherwise false.