oracle.spatial.network.lod

Class DefaultPairwiseShortestPaths

java.lang.Object

oracle.spatial.network.lod.DefaultPairwiseShortestPaths

All Implemented Interfaces:

PairwiseShortestPaths, XMLConfigurable

public class DefaultPairwiseShortestPaths
extends java.lang.Object
implements PairwiseShortestPaths, XMLConfigurable

This is the default pairwise shortest paths algorithm. It computes the pairwise shortest paths one by one using the input shortest path algorithm.

Since:

11gR2

Constructor Summary

Constructors

Constructor and Description
DefaultPairwiseShortestPaths(NetworkExplorer ne, LinkCostCalculator[] lccs, NodeCostCalculator[] nccs, ShortestPath spAlgorithm) Deprecated.
DefaultPairwiseShortestPaths(ShortestPath spAlgorithm) Construct a DefaultPairwiseShortestPaths instance.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getXMLSchema() Returns the XML schema for the input parameter.
void	init(org.w3c.dom.Element parameter) Initializes the XML configurable object with the input parameter.
void	setInitialAnalysisInfo(LODAnalysisInfo analysisInfo)
void	setNetworkAnalyst(NetworkAnalyst analyst) This method allows caller to pass the network analyst object to this pairwise shortest paths 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.
double[][]	shortestPathCosts(PointOnNet[][] startPoints, PointOnNet[][] endPoints, LODNetworkConstraint constraint, Matrix<java.lang.Integer> pairwiseMatrix, int direction) Returns the pair-wise shortest path cost between a set of candidate start points and end points.
Matrix<LogicalSubPath>	shortestPaths(PointOnNet[][] startPoints, PointOnNet[][] endPoints, LODNetworkConstraint constraint, Matrix<java.lang.Integer> pairwiseMatrix, int direction) Returns the pair-wise shortest paths between a set of candidate start points and end points.
Matrix<LogicalLightSubPath>	shortestPathsLight(PointOnNet[][] startPoints, PointOnNet[][] endPoints, LODNetworkConstraint constraint, Matrix<java.lang.Integer> pairwiseMatrix, int direction) Returns the pair-wise light weight shortest paths between a set of candidate start points and end points.
void	shortestPathsLight(PointOnNet[][] startPoints, PointOnNet[][] endPoints, LODNetworkConstraint constraint, Matrix<java.lang.Integer> pairwiseMatrix, int direction, PairwisePathResultIO pathIO) Computes the pair-wise light weight shortest paths between a set of candidate start points and end points, and outputs the light weight paths via PairwisePathResultIO.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPairwiseShortestPaths

public DefaultPairwiseShortestPaths(NetworkExplorer ne,
                                    LinkCostCalculator[] lccs,
                                    NodeCostCalculator[] nccs,
                                    ShortestPath spAlgorithm)

Deprecated.

Parameters:

ne -

lccs -

nccs -

spAlgorithm -

DefaultPairwiseShortestPaths

public DefaultPairwiseShortestPaths(ShortestPath spAlgorithm)

Construct a DefaultPairwiseShortestPaths instance.

Parameters:

spAlgorithm -

Method Detail

setInitialAnalysisInfo

public void setInitialAnalysisInfo(LODAnalysisInfo analysisInfo)

shortestPaths

public Matrix<LogicalSubPath> shortestPaths(PointOnNet[][] startPoints,
                                            PointOnNet[][] endPoints,
                                            LODNetworkConstraint constraint,
                                            Matrix<java.lang.Integer> pairwiseMatrix,
                                            int direction)
                                     throws LODNetworkException

Description copied from interface: PairwiseShortestPaths

Returns the pair-wise shortest paths between a set of candidate start points and end points.

Specified by:

shortestPaths in interface PairwiseShortestPaths

Parameters:

startPoints - array of start candidates

endPoints - array of end candidates

constraint - network constraint

pairwiseMatrix - a matrix that specifies for which pairs the shortest paths need to be computed. If the matrix element for pair (i, j) is set to 0, then the shortest path from i to j does not need to be computed; otherwise it must be computed. If this parameter is set to null, then the shortest paths for all pairs must be computed.

Returns:

Throws:

LODNetworkException

shortestPathsLight

public Matrix<LogicalLightSubPath> shortestPathsLight(PointOnNet[][] startPoints,
                                                      PointOnNet[][] endPoints,
                                                      LODNetworkConstraint constraint,
                                                      Matrix<java.lang.Integer> pairwiseMatrix,
                                                      int direction)
                                               throws LODNetworkException

Description copied from interface: PairwiseShortestPaths

Returns the pair-wise light weight shortest paths between a set of candidate start points and end points.

Specified by:

shortestPathsLight in interface PairwiseShortestPaths

Parameters:

startPoints - array of start candidates

endPoints - array of end candidates

constraint - network constraint

pairwiseMatrix - a matrix that specifies for which pairs the shortest paths need to be computed. If the matrix element for pair (i, j) is set to 0, then the shortest path from i to j does not need to be computed; otherwise it must be computed. If this parameter is set to null, then the shortest paths for all pairs must be computed.

Returns:

Throws:

LODNetworkException

setNetworkAnalyst

public void setNetworkAnalyst(NetworkAnalyst analyst)

Description copied from interface: PairwiseShortestPaths

This method allows caller to pass the network analyst object to this pairwise shortest paths 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 algorithm, the algorithm can choose to do nothing with this method.

Specified by:

setNetworkAnalyst in interface PairwiseShortestPaths

init

public void init(org.w3c.dom.Element parameter)

Description copied from interface: XMLConfigurable

Initializes the XML configurable object with the input parameter.

Specified by:

init in interface XMLConfigurable

Parameters:

parameter - an XML element containing the necessary information to initialize the object.

getXMLSchema

public java.lang.String getXMLSchema()

Description copied from interface: XMLConfigurable

Returns the XML schema for the input parameter.

Specified by:

getXMLSchema in interface XMLConfigurable

Returns:

shortestPathsLight

public void shortestPathsLight(PointOnNet[][] startPoints,
                               PointOnNet[][] endPoints,
                               LODNetworkConstraint constraint,
                               Matrix<java.lang.Integer> pairwiseMatrix,
                               int direction,
                               PairwisePathResultIO pathIO)
                        throws LODNetworkException

Description copied from interface: PairwiseShortestPaths

Computes the pair-wise light weight shortest paths between a set of candidate start points and end points, and outputs the light weight paths via PairwisePathResultIO.

Specified by:

shortestPathsLight in interface PairwiseShortestPaths

Parameters:

startPoints - array of start candidates

endPoints - array of end candidates

constraint - network constraint

pairwiseMatrix - a matrix that specifies for which pairs the shortest paths need to be computed. If the matrix element for pair (i, j) is set to 0, then the shortest path from i to j does not need to be computed; otherwise it must be computed. If this parameter is set to null, then the shortest paths for all pairs must be computed.

Throws:

LODNetworkException

shortestPathCosts

public double[][] shortestPathCosts(PointOnNet[][] startPoints,
                                    PointOnNet[][] endPoints,
                                    LODNetworkConstraint constraint,
                                    Matrix<java.lang.Integer> pairwiseMatrix,
                                    int direction)
                             throws LODNetworkException

Description copied from interface: PairwiseShortestPaths

Returns the pair-wise shortest path cost between a set of candidate start points and end points. This method can be used when the caller is only interested in path costs. the light path results.

Specified by:

shortestPathCosts in interface PairwiseShortestPaths

Parameters:

startPoints - array of start candidates

endPoints - array of end candidates

constraint - network constraint

pairwiseMatrix - a matrix that specifies for which pairs the shortest paths need to be computed. If the matrix element for pair (i, j) is set to 0, then the shortest path from i to j does not need to be computed; otherwise it must be computed. If this parameter is set to null, then the shortest paths for all pairs must be computed.

Returns:

Throws:

LODNetworkException