|
Oracle® Spatial Java API Reference 11g Release 1 (11.1) B28401-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LogicalPath
A LogicalPath is defined by an array of link IDs, array of node IDs, and the cost of 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 the start node and the end node.
Method Summary | |
---|---|
LogicalPath |
append(LogicalPath path, double connectorNodeCost) Appends a path to the end this path. |
LogicalPath |
append(long nextLinkId, double nextLinkCost, long nextNodeId, double connectorNodeCost) Append a link to this path. |
double |
getCost() Returns the cost of this path. |
long |
getEndNodeId() Returns the end node ID of this path. |
long |
getFirstLinkId() Returns the ID of the first link on this path. |
long |
getLastLinkId() Returns the ID of the last link on this path. |
long[] |
getLinkIds() Returns the array of link IDs on this path. |
long[] |
getNodeIds() Returns the array of node IDs on this path. |
long |
getStartNodeId() Returns the start node ID of 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. |
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, double connectorNodeCost) Appends a path to the beginning of this path. |
LogicalPath |
prepend(long prevLinkId, double prevLinkCost, long prevNodeId, double connectorNodeCost) Prepend a link to this path. |
void |
setCost(double cost) Sets the cost of the 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. |
Method Detail |
---|
long[] getLinkIds()
long[] getNodeIds()
double getCost()
long getStartNodeId()
long getEndNodeId()
long getFirstLinkId()
long getLastLinkId()
boolean isSimple()
java.lang.Object getUserData(java.lang.String dataName)
dataName
- name of the user datavoid setUserData(java.lang.String dataName, java.lang.Object dataValue)
dataName
- name of the user datadataValue
- value of the user datajava.util.Map<java.lang.String,java.lang.Object> getUserData()
void setUserData(java.util.Map<java.lang.String,java.lang.Object> userDataMap)
userDataMap
- a map of userdata name value pairsLogicalPath append(long nextLinkId, double nextLinkCost, long nextNodeId, double connectorNodeCost)
nextLinkId
- ID of the next linknextLinkCost
- cost of the next linknextNodeId
- ID of the next nodeconnectorNodeCost
- cost of the connector nodeLogicalPath prepend(long prevLinkId, double prevLinkCost, long prevNodeId, double connectorNodeCost)
prevLinkId
- ID of the prev linkprevLinkCost
- cost of the prev linkprevNodeId
- ID of the prev nodeconnectorNodeCost
- cost of the connector nodeLogicalPath append(LogicalPath path, double connectorNodeCost)
path
- path to append to the endconnectorNodeCost
- cost of the connector nodeLogicalPath prepend(LogicalPath path, double connectorNodeCost)
path
- path to append at the beginningconnectorNodeCost
- cost of the connector nodevoid setCost(double cost)
cost
- cost of the pathint indexOfNode(long nodeId)
nodeId
- node idint indexOfLink(long linkId)
linkId
- link id
|
Oracle® Spatial Java API Reference 11g Release 1 (11.1) B28401-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |