Skip navigation links

Oracle® Spatial Java API Reference
11g Release 2 (11.2)
E11829-02


oracle.spatial.network.lod
Interface LogicalLightSubPath

All Known Subinterfaces:
LogicalSubPath, SpatialSubPath
All Known Implementing Classes:
LogicalSubPathImpl, SpatialSubPathImpl

public interface LogicalLightSubPath

Light weight logical sub-path that references to a LogicalLightPath

Since:
Oracle Database 11g Release 2 (11.2)

Method Summary
 CategorizedUserData getCategorizedUserData()
          Returns categorized user data.
 double getCost()
          Deprecated. use getCosts();
 double[] getCosts()
          Returns the costs 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.
 LogicalLightPath getReferenceLightPath()
          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()
          Deprecated.  
 UserData getUserData(int category)
          Returns user data for the specified category.
 java.lang.Object getUserData(java.lang.String dataName)
          Deprecated.  
 boolean isFullPath()
          Returns true if the subpath covers the entire reference path.
 void setCategorizedUserData(CategorizedUserData userData)
          Sets categorized user data.
 void setCosts(double[] costs)
          Sets the costs of the subpath.
 void setEndLinkIndex(int endLinkIndex)
          Sets the end link index.
 void setEndPercentage(double endPercentage)
          Sets the location of the end point of the subpath as a percentage of the last link of the containing path.
 void setReferenceLightPath(LogicalLightPath refPath)
          Sets the path containing the subpath.
 void setStartLinkIndex(int startLinkIndex)
          Sets the start link index.
 void setStartPercentage(double startPercentage)
          Sets the location of the starting point of the subpath as a percentage of the first link of the containing path.
 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.  

 

Method Detail

getReferenceLightPath

LogicalLightPath getReferenceLightPath()
Returns the path containing the subpath.
Returns:
the light weight logical path that contains the subpath

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

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

getCost

double getCost()
Deprecated. use getCosts();
Returns the cost of the subpath.
Returns:
cost of the subpath

getCosts

double[] getCosts()
Returns the costs of the subpath.
Returns:
costs of the subpath

setReferenceLightPath

void setReferenceLightPath(LogicalLightPath refPath)
Sets the path containing the subpath.

setStartPercentage

void setStartPercentage(double startPercentage)
Sets the location of the starting point of the subpath as a percentage of the first link of the containing path.

setEndPercentage

void setEndPercentage(double endPercentage)
Sets the location of the end point of the subpath as a percentage of the last link of the containing path.

setStartLinkIndex

void setStartLinkIndex(int startLinkIndex)
Sets the start link index.

setEndLinkIndex

void setEndLinkIndex(int endLinkIndex)
Sets the end link index.

setCosts

void setCosts(double[] costs)
Sets the costs of the subpath.

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

getCategorizedUserData

CategorizedUserData getCategorizedUserData()
Returns categorized user data.
Returns:
user data

setCategorizedUserData

void setCategorizedUserData(CategorizedUserData userData)
Sets categorized user data.
Parameters:
userData - user Data

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.

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

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 -

Skip navigation links

Oracle® Spatial Java API Reference
11g Release 2 (11.2)
E11829-02


Copyright © 2007, 2011, Oracle and/or its affiliates. All Rights Reserved.