oracle.spatial.network.lod

Interface ShortestPath

All Known Implementing Classes:

AStar, BidirectionalBfs, BidirectionalDijkstra, BreadthFirstSearch, Dijkstra

public interface ShortestPath

This interface defines methods supported by a shortest path algorithm.

Since:

11gR2

Method Summary

Modifier and Type	Method and Description
ShortestPath	clone()
LinkCostCalculator[]	getLinkCostCalculators() Returns the link cost calculators.
LinkLevelSelector	getLinkLevelSelector() Returns the link level selector.
NodeCostCalculator[]	getNodeCostCalculators() Returns the node cost calculators.
void	setInitialAnalysisInfo(LODAnalysisInfo analysisInfo) Sets the initial analysis info.
void	setLinkCostCalculators(LinkCostCalculator[] lccs) Sets the link cost calculators.
void	setLinkLevelSelector(LinkLevelSelector lls) Sets the link level selector.
void	setNetworkAnalyst(NetworkAnalyst analyst) This method allows caller to pass the network analyst object to this shortest path algorithm implementation, so that the algorithm can call the analysis functions provided by the network analyst, or access the network explorer associated with the network analyst.
void	setNodeCostCalculators(NodeCostCalculator[] nccs) Sets the node cost calculators.
LogicalSubPath	shortestPath(PointOnNet[] startPoints, PointOnNet[] endPoints, LODNetworkConstraint constraint, int direction) Returns the shortest path between a set of candidate start points and a set of end points.

Method Detail

setInitialAnalysisInfo

void setInitialAnalysisInfo(LODAnalysisInfo analysisInfo)

Sets the initial analysis info. This method allows analysis info to be passed to subsequent analysis.

Parameters:

analysisInfo - analysis information

shortestPath

LogicalSubPath shortestPath(PointOnNet[] startPoints,
                            PointOnNet[] endPoints,
                            LODNetworkConstraint constraint,
                            int direction)
                     throws LODNetworkException

Returns the shortest path between a set of candidate start points and a set of end points.

Parameters:

startPoints - start candidates

endPoints - end candidates

constraint - network constraint

direction - NetworkExplorer.DIRECTION_FORWARD or NetworkExplorer.DIRECTION_BACKWARD

Returns:

Throws:

LODNetworkException

getLinkLevelSelector

LinkLevelSelector getLinkLevelSelector()

Returns the link level selector.

Returns:

setLinkLevelSelector

void setLinkLevelSelector(LinkLevelSelector lls)

Sets the link level selector.

Parameters:

lls - link level selector

getLinkCostCalculators

LinkCostCalculator[] getLinkCostCalculators()

Returns the link cost calculators.

Returns:

setLinkCostCalculators

void setLinkCostCalculators(LinkCostCalculator[] lccs)

Sets the link cost calculators.

Parameters:

lccs -

getNodeCostCalculators

NodeCostCalculator[] getNodeCostCalculators()

Returns the node cost calculators.

Returns:

setNodeCostCalculators

void setNodeCostCalculators(NodeCostCalculator[] nccs)

Sets the node cost calculators.

Parameters:

nccs -

setNetworkAnalyst

void setNetworkAnalyst(NetworkAnalyst analyst)

This method allows caller to pass the network analyst object to this shortest path algorithm implementation, so that the algorithm can call the analysis functions provided by the network analyst, or access the network explorer associated with the network analyst. If network analyst is not needed by the shortest path algorithm, the algorithm can choose to do nothing with this method.

clone

ShortestPath clone()