Skip navigation links

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

B28401-02


oracle.spatial.network.lod
Interface LogicalSubPath

All Known Subinterfaces:
SpatialSubPath

public interface LogicalSubPath

LogicalSubPath represents a portition of a LogicalPath, with the start and/or end points located on links of the the containing path.

Since:
11gR1

Method Summary
 double getCost()
          Returns the cost of the subpath.
 int getEndLinkIndex()
          Returns the end link index.
 double getEndPercentage()
          Returns the location of the end point of the subpath as a percentage of the last link of the containing path.
 LogicalPath getReferencePath()
          Returns the path containing the subpath.
 int getStartLinkIndex()
          Returns the start link index.
 double getStartPercentage()
          Returns the location of the starting point of the subpath as a percentage of the first link of the containing path.
 java.util.Map<java.lang.String,java.lang.Object> getUserData()
          Returns all the user data name value pairs.
 boolean isFullPath()
          Returns true if the subpath covers the entire reference path.
 void setUserData(java.util.Map<java.lang.String,java.lang.Object> userDataMap)
          Sets the value of the user data.

 

Method Detail

getReferencePath

LogicalPath getReferencePath()
Returns the path containing the subpath.
Returns:
the logical path that contains the subpath

getStartLinkIndex

int getStartLinkIndex()
Returns the start link index.
Returns:
the start link index

getEndLinkIndex

int getEndLinkIndex()
Returns the end link index.
Returns:
the end link index

getStartPercentage

double getStartPercentage()
Returns the location of the starting point of the subpath as a percentage of the first link of the containing path.
Returns:
location of the starting point on the start link

getEndPercentage

double getEndPercentage()
Returns the location of the end point of the subpath as a percentage of the last link of the containing path.
Returns:
location of the end point on the end link

getCost

double getCost()
Returns the cost of the subpath.
Returns:
cost of the subpath

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

isFullPath

boolean isFullPath()
Returns true if the subpath covers the entire reference path.
Returns:
true if the subpath covers the entire reference path, false otherwise.

Skip navigation links

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

B28401-02


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