Skip navigation links

Oracle® Spatial Java API Reference
11g Release 1 (11.1)

B28401-02


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
 LogicalHeavyPath append(LogicalHeavyPath path)
          Appends a path after this path.
 LogicalHeavyPath append(LogicalLink endLink, LogicalNode endNode)
          Appends a link at the end of this path.
 double getCost()
          Returns the cost 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()
          Returns all the user data name value pairs.
 java.lang.Object getUserData(java.lang.String dataName)
          Returns the user data object for the specified data name.
 LogicalHeavyPath prepend(LogicalHeavyPath path)
          Appends a path before this path.
 LogicalHeavyPath prepend(LogicalLink startLink, LogicalNode startNode)
          Appends a link at the beginning of this path.
 void setCost(double cost)
          Sets the cost of this path.
 void setUserData(java.util.Map<java.lang.String,java.lang.Object> userDataMap)
          Sets the value of the user data.
 void setUserData(java.lang.String dataName, java.lang.Object dataValue)
          Sets the value of the user data.
 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()
Returns the cost of this path.
Returns:
cost of this path

setCost

void setCost(double cost)
Sets the cost of this path.
Parameters:
cost - path cost

getUserData

java.lang.Object getUserData(java.lang.String dataName)
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)
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()
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)
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 endLink,
                        LogicalNode endNode)
Appends a link at the end of this path.
Parameters:
endLink - end link in the returned path
endNode - end node in the returned path

append

LogicalHeavyPath append(LogicalHeavyPath path)
Appends a path after this path.
Parameters:
path - path to append after this path

prepend

LogicalHeavyPath prepend(LogicalLink startLink,
                         LogicalNode startNode)
Appends a link at the beginning of this path.
Parameters:
startLink - end link in the returned path
startNode - end node in the returned path

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

Skip navigation links

Oracle® Spatial Java API Reference
11g Release 1 (11.1)

B28401-02


Copyright © 2007, 2008, Oracle. All Rights Reserved.