Skip navigation links

oracle.spatial.network.lod
Interface LogicalPath

All Superinterfaces:

LogicalLightPath

All Known Subinterfaces:

SpatialPath

public interface LogicalPath

extends LogicalLightPath

A LogicalPath is defined by an array of link IDs, array of node IDs, and the costs for traversing through this path. The cost of a path is the sum of the costs of the the links and nodes on the path, excluding that of the end node. The costs of the links and nodes are defined by LinkCostCalculator and NodeCostCalculator.

Since:

11gR1

Method Summary

LogicalPath	append(LogicalPath path) Appends a path to the end this path.
LogicalPath	append(LogicalPath path, double connectorNodeCost) Deprecated. use append(LogicalPath path);
LogicalPath	append(long nextLinkId, double[] nextLinkCosts, long nextNodeId, double[] connectorNodeCosts) Append a link to this path.
LogicalPath	append(long nextLinkId, double nextLinkCost, long nextNodeId, double connectorNodeCosts) Deprecated. use append(long nextLinkId, double[] nextLinkCosts, long nextNodeId, double[] connectorNodeCosts);
CategorizedUserData	getCategorizedUserData() Returns categorized user data.
long[]	getLinkIds() Returns the array of link IDs on this path.
long[]	getNodeIds() Returns the array of node IDs on this path.
java.util.Map<java.lang.String,java.lang.Object>	getUserData() Deprecated.
UserData	getUserData(int category) Returns user data for the specified category.
java.lang.Object	getUserData(java.lang.String dataName) Deprecated.
int	indexOfLink(long linkId) Returns the index of the specified link in this path.
int	indexOfNode(long nodeId) Returns the index of the specified node in this path.
boolean	isSimple() Checks whether this path is simple or not.
LogicalPath	prepend(LogicalPath path) Appends a path to the beginning of this path.
LogicalPath	prepend(LogicalPath path, double connectorNodeCost) Deprecated. use prepend(LogicalPath path);
LogicalPath	prepend(long prevLinkId, double[] prevLinkCosts, long prevNodeId, double[] prevNodeCosts) Prepend a link to this path.
LogicalPath	prepend(long prevLinkId, double prevLinkCost, long prevNodeId, double prevNodeCost) Deprecated. use prepend(long prevLinkId, double[] prevLinkCosts, long prevNodeId, double[] connectorNodeCosts);
void	setCategorizedUserData(CategorizedUserData userData) Sets categorized user data.
void	setUserData(int category, UserData userData) Sets user data for the specified category.
void	setUserData(java.util.Map<java.lang.String,java.lang.Object> userData) Deprecated.
void	setUserData(java.lang.String dataName, java.lang.Object dataValue) Deprecated.

Methods inherited from interface oracle.spatial.network.lod.LogicalLightPath

getCost, getCosts, getEndNodeId, getFirstLinkId, getLastLinkId, getNumberOfLinks, getNumberOfNodes, getStartNodeId

Method Detail

getLinkIds

long[] getLinkIds()

Returns the array of link IDs on this path.

Returns:

array of link IDs

getNodeIds

long[] getNodeIds()

Returns the array of node IDs on this path.

Returns:

array of node IDs

isSimple

boolean isSimple()

Checks whether this path is simple or not. A path is simple if no node is visited twice on this path, i.e., no loop exists on this path.

Returns:

true, if the path is simple; false, otherwise.

append

LogicalPath append(long nextLinkId,
                   double nextLinkCost,
                   long nextNodeId,
                   double connectorNodeCosts)

Deprecated. use append(long nextLinkId, double[] nextLinkCosts, long nextNodeId, double[] connectorNodeCosts);

Append a link to this path.

Parameters:

nextLinkId - ID of the next link

nextLinkCost - cost of the next link

nextNodeId - ID of the next node

connectorNodeCosts - cost of the connector node

append

LogicalPath append(long nextLinkId,
                   double[] nextLinkCosts,
                   long nextNodeId,
                   double[] connectorNodeCosts)

Append a link to this path.

Parameters:

nextLinkId - ID of the next link

nextLinkCosts - costs of the next link

nextNodeId - ID of the next node

connectorNodeCosts - costs of the connector node

prepend

LogicalPath prepend(long prevLinkId,
                    double prevLinkCost,
                    long prevNodeId,
                    double prevNodeCost)

Deprecated. use prepend(long prevLinkId, double[] prevLinkCosts, long prevNodeId, double[] connectorNodeCosts);

Prepend a link to this path.

Parameters:

prevLinkId - ID of the previous link

prevLinkCost - cost of the previous link

prevNodeId - ID of the previous node

prevNodeCost - costs of the node to be prepended

prepend

LogicalPath prepend(long prevLinkId,
                    double[] prevLinkCosts,
                    long prevNodeId,
                    double[] prevNodeCosts)

Prepend a link to this path.

Parameters:

prevLinkId - ID of the previous link

prevLinkCosts - costs of the previous link

prevNodeId - ID of the previous node

prevNodeCosts - costs of the node to be prepended

append

LogicalPath append(LogicalPath path,
                   double connectorNodeCost)

Deprecated. use append(LogicalPath path);

Appends a path to the end this path.

Parameters:

path - path to append to the end

connectorNodeCost - cost of the connector node

Returns:

append

LogicalPath append(LogicalPath path)

Appends a path to the end this path.

Parameters:

path - path to append to the end

Returns:

prepend

LogicalPath prepend(LogicalPath path,
                    double connectorNodeCost)

Deprecated. use prepend(LogicalPath path);

Appends a path to the beginning of this path.

Parameters:

path - path to append at the beginning

connectorNodeCost - cost of the connector node

Returns:

prepend

LogicalPath prepend(LogicalPath path)

Appends a path to the beginning of this path.

Parameters:

path - path to append at the beginning

Returns:

indexOfNode

int indexOfNode(long nodeId)

Returns the index of the specified node in this path.

Parameters:

nodeId - node id

Returns:

the index of the node, if the path contains the node; -1, otherwise.

indexOfLink

int indexOfLink(long linkId)

Returns the index of the specified link in this path.

Parameters:

linkId - link id

Returns:

the index of the link, if the path contains the link; -1, otherwise.

getUserData

java.lang.Object getUserData(java.lang.String dataName)

Deprecated.

Returns the user data object for the specified data name.

Parameters:

dataName - name of the user data

Returns:

value of the user data

setUserData

void setUserData(java.lang.String dataName,
                 java.lang.Object dataValue)

Deprecated.

Sets the value of the user data. No verification of the validity of the data name is done inside this method, therefore, the caller must ensure that the input data name is valid.

Parameters:

dataName - name of the user data

dataValue - value of the user data

getCategorizedUserData

CategorizedUserData getCategorizedUserData()

Returns categorized user data.

Returns:

setCategorizedUserData

void setCategorizedUserData(CategorizedUserData userData)

Sets categorized user data.

Parameters:

userData -

getUserData

UserData getUserData(int category)

Returns user data for the specified category.

Returns:

setUserData

void setUserData(int category,
                 UserData userData)

Sets user data for the specified category.

Parameters:

userData -

getUserData

java.util.Map<java.lang.String,java.lang.Object> getUserData()

Deprecated.

Returns user data.

Returns:

user data

setUserData

void setUserData(java.util.Map<java.lang.String,java.lang.Object> userData)

Deprecated.

Sets user data.

Parameters:

userData - user Data

Skip navigation links