com.sparsity.sparksee.algorithms
Class ShortestPath

java.lang.Object
  extended by com.sparsity.sparksee.algorithms.ShortestPath
All Implemented Interfaces:
java.io.Closeable
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
 void addAllEdgeTypes(EdgesDirection d)
          Allows for traversing all edge types of the graph.
 void addAllNodeTypes()
          Allows for traversing all node types of the graph.
 void addEdgeType(int t, EdgesDirection d)
          Allows for traversing edges of the given type.
 void addNodeType(int t)
          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 t,
                        EdgesDirection d)
Allows for traversing edges of the given type.

Parameters:
t - [in] Edge type.
d - [in] Edge direction.

addAllNodeTypes

public void addAllNodeTypes()
Allows for traversing all node types of the graph.


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.

addNodeType

public void addNodeType(int t)
Allows for traversing nodes of the given type.

Parameters:
t - null

addAllEdgeTypes

public void addAllEdgeTypes(EdgesDirection d)
Allows for traversing all edge types of the graph.

Parameters:
d - [in] Edge direction.

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.

setMaximumHops

public void setMaximumHops(int maxhops)
Sets the maximum hops restriction.

All paths longer than the maximum hops restriction will be ignored. m[in] The maximum hops restriction. It must be positive or zero. Zero, the default value, means unlimited.

Parameters:
maxhops - null

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()

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