com.sparsity.sparksee.algorithms

Class ShortestPath

java.lang.Object

com.sparsity.sparksee.algorithms.ShortestPath

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

SinglePairShortestPath

public class ShortestPath
extends java.lang.Object
implements java.io.Closeable

ShortestPath class.

Classes implementing this abstract class solve the shortest path problem in a graph.

The user must set which node and edge types can be used for the traversal.

Check out the 'Algorithms' section in the SPARKSEE User Manual for more details on this.

Author:

Sparsity Technologies http://www.sparsity-technologies.com

Method Summary

Modifier and Type	Method and Description
void	addAllEdgeTypes(EdgesDirection dir) Allows for traversing all edge types of the graph.
void	addAllNodeTypes() Allows for traversing all node types of the graph.
void	addEdgeType(int type, EdgesDirection dir) Allows for traversing edges of the given type.
void	addNodeType(int type) Allows for traversing nodes of the given type.
void	close() Closes the ShortestPath instance.
void	excludeEdges(Objects edges) Set which edges can't be used.
void	excludeNodes(Objects nodes) Set which nodes can't be used.
boolean	isClosed() Gets if ShortestPath instance has been closed or not.
void	run() Runs the algorithm.
void	setMaximumHops(int maxhops) Sets the maximum hops restriction.

Methods inherited from class java.lang.Object

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

Method Detail

addEdgeType

public void addEdgeType(int type,
                        EdgesDirection dir)

Allows for traversing edges of the given type.

Parameters:

type - [in] Edge type.

dir - [in] Edge direction.

run

public void run()

Runs the algorithm.

This method can only be called once.

excludeNodes

public void excludeNodes(Objects nodes)

Set which nodes can't be used.

This will replace any previously specified set of excluded nodes. Should only be used to exclude the usage of specific nodes from allowed node types because it's less efficient than not allowing a node type.

Parameters:

nodes - [in] A set of node identifiers that must be kept intact until the destruction of the class.

isClosed

public boolean isClosed()

Gets if ShortestPath instance has been closed or not.

Returns:

TRUE if the ShortestPath instance has been closed, FALSE otherwise.

See Also:

close()

addAllEdgeTypes

public void addAllEdgeTypes(EdgesDirection dir)

Allows for traversing all edge types of the graph.

Parameters:

dir - [in] Edge direction.

addNodeType

public void addNodeType(int type)

Allows for traversing nodes of the given type.

Parameters:

type - null

excludeEdges

public void excludeEdges(Objects edges)

Set which edges can't be used.

This will replace any previously specified set of excluded edges. Should only be used to exclude the usage of specific edges from allowed edge types because it's less efficient than not allowing an edge type.

Parameters:

edges - [in] A set of edge identifiers that must be kept intact until the destruction of the class.

close

public void close()

Closes the ShortestPath instance.

It must be called to ensure the integrity of all data.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

setMaximumHops

public void setMaximumHops(int maxhops)

Sets the maximum hops restriction.

All paths longer than the maximum hops restriction will be ignored.

Parameters:

maxhops - [in] The maximum hops restriction. It must be positive or zero. Zero, the default value, means unlimited.

addAllNodeTypes

public void addAllNodeTypes()

Allows for traversing all node types of the graph.