Package oracle.spatial.network.lod

Interface LogicalHeavyPath

All Known Subinterfaces:

SpatialHeavyPath

public interface LogicalHeavyPath

A LogicalHeavyPath is a logical path with detailed node and link information.

Since:

11gR1

Method Summary

Modifier and Type	Method	Description
LogicalHeavyPath	append(LogicalHeavyPath path)	Appends a path after this path.
LogicalHeavyPath	append(LogicalLink nextLink, LogicalNode nextNode, double[] nextLinkCosts, double[] nextNodeCosts)	Appends a link at the end of this path.
java.lang.Object	clone()	Support cloneable
CategorizedUserData	getCategorizedUserData()	Returns categorized user data.
double	getCost()	Deprecated. use getCosts();
double[]	getCosts()	Returns the costs of this path.
LogicalNode	getEndNode()	Returns the last node on this path.
LogicalLink	getFirstLink()	Returns the first link on this path.
LogicalLink	getLastLink()	Returns the last link on this path.
LogicalLink[]	getLinks()	Returns the logical links on this path.
LogicalNode[]	getNodes()	Returns the logical nodes on this path.
LogicalNode	getStartNode()	Returns the first node 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.
boolean	isReverse()	Returns whether the path is reverse path or not.
LogicalHeavyPath	prepend(LogicalHeavyPath path)	Appends a path before this path.
LogicalHeavyPath	prepend(LogicalLink prevLink, LogicalNode prevNode, double[] prevLinkCosts, double[] connectorNodeCosts)	Appends a link at the beginning of this path.
void	setCategorizedUserData(CategorizedUserData userData)	Sets categorized user data.
void	setCost(double cost)	Deprecated. use setCosts(double[] costs);
void	setCosts(double[] costs)	Sets the costs of this path.
void	setUserData(int category, UserData userData)	Sets user data for the specified category.
void	setUserData(java.lang.String dataName, java.lang.Object dataValue)	Deprecated.
void	setUserData(java.util.Map<java.lang.String,java.lang.Object> userDataMap)	Deprecated.
LogicalPath	toLogicalPath()	Converts the heavy-weight path to a light-weight path.

Method Detail

getLinks

LogicalLink[] getLinks()

Returns the logical links on this path.

Returns:

logical links

getNodes

LogicalNode[] getNodes()

Returns the logical nodes on this path.

Returns:

logical nodes

getStartNode

LogicalNode getStartNode()

Returns the first node on this path.

Returns:

first node

getEndNode

LogicalNode getEndNode()

Returns the last node on this path.

Returns:

last node

getFirstLink

LogicalLink getFirstLink()

Returns the first link on this path.

Returns:

first link

getLastLink

LogicalLink getLastLink()

Returns the last link on this path.

Returns:

last link

getCost

double getCost()

Deprecated.

use getCosts();

Returns the cost of this path.

Returns:

cost of this path

setCost

void setCost(double cost)

Deprecated.

use setCosts(double[] costs);

Sets the cost of this path.

Parameters:

cost - path cost

getCosts

double[] getCosts()

Returns the costs of this path.

Returns:

costs of this path

setCosts

void setCosts(double[] costs)

Sets the costs of this path.

Parameters:

costs - path costs

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

getUserData

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

Deprecated.

Returns all the user data name value pairs.

Returns:

user data name value pairs

setUserData

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

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:

userDataMap - a map of userdata name value pairs

append

LogicalHeavyPath append(LogicalLink nextLink,
                        LogicalNode nextNode,
                        double[] nextLinkCosts,
                        double[] nextNodeCosts)

Appends a link at the end of this path.

Parameters:

nextLink - next link

nextNode - next node

nextLinkCosts - costs of the next link

nextNodeCosts - costs of the next node

append

LogicalHeavyPath append(LogicalHeavyPath path)

Appends a path after this path.

Parameters:

path - path to append after this path

prepend

LogicalHeavyPath prepend(LogicalLink prevLink,
                         LogicalNode prevNode,
                         double[] prevLinkCosts,
                         double[] connectorNodeCosts)

Appends a link at the beginning of this path.

Parameters:

prevLink - previous link

prevNode - previous node

prevLinkCosts - costs of the previous link

connectorNodeCosts - costs of the previous node

Returns:

prepend

LogicalHeavyPath prepend(LogicalHeavyPath path)

Appends a path before this path.

Parameters:

path - path to append before this path

toLogicalPath

LogicalPath toLogicalPath()

Converts the heavy-weight path to a light-weight path.

Returns:

the light-weight path

isReverse

boolean isReverse()

Returns whether the path is reverse path or not.

Returns:

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 -

clone

java.lang.Object clone()
                throws java.lang.CloneNotSupportedException

Support cloneable

Returns:

cloned object

Throws:

java.lang.CloneNotSupportedException