Skip navigation links

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


oracle.spatial.network.lod
Class SpatialSubPathImpl

java.lang.Object
  extended by oracle.spatial.network.lod.LogicalSubPathImpl
      extended by oracle.spatial.network.lod.SpatialSubPathImpl

All Implemented Interfaces:
LogicalLightSubPath, LogicalSubPath, SpatialSubPath

public class SpatialSubPathImpl
extends LogicalSubPathImpl
implements SpatialSubPath

Default implementation of SpatialSubPath.

Since:
11gR1

Constructor Summary
SpatialSubPathImpl(SpatialPath referencePath, int startLinkIndex, double startPercentage, int endLinkIndex, double endPercentage, double[] costs, JGeometry geometry, CategorizedUserData userData)
           

 

Method Summary
 CategorizedUserData getCategorizedUserData()
          Returns categorized user data.
 double getCost()
          Deprecated.  
 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.
 JGeometry getGeometry()
          Returns the geometry information of the 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.
 UserData getUserData(int category)
          Returns user data for the specified category.
 java.lang.Object getUserData(java.lang.String dataName)
          Deprecated.  
 java.lang.Object getUserData(java.lang.String dataName)
          Deprecated.  
 boolean isFullPath()
          Returns true if the subpath covers the entire reference path.
 void setCategorizedUserData(CategorizedUserData cud)
          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(int category, UserData userData)
          Sets user data for the specified category.
 void setUserData(java.util.Map<java.lang.String,java.lang.Object> userDataMap)
          Deprecated.  
 void setUserData(java.lang.String dataName, java.lang.Object dataValue)
          Deprecated.  
 void setUserData(java.lang.String dataName, java.lang.Object dataValue)
          Deprecated.  

 

Methods inherited from class oracle.spatial.network.lod.LogicalSubPathImpl
getReferencePath

 

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Methods inherited from interface oracle.spatial.network.lod.LogicalSubPath
getReferencePath

 

Methods inherited from interface oracle.spatial.network.lod.LogicalLightSubPath
getCategorizedUserData, getCost, getCosts, getEndLinkIndex, getEndPercentage, getReferenceLightPath, getStartLinkIndex, getStartPercentage, getUserData, isFullPath, setCategorizedUserData, setCosts, setEndLinkIndex, setEndPercentage, setReferenceLightPath, setStartLinkIndex, setStartPercentage, setUserData

 

Constructor Detail

SpatialSubPathImpl

public SpatialSubPathImpl(SpatialPath referencePath,
                          int startLinkIndex,
                          double startPercentage,
                          int endLinkIndex,
                          double endPercentage,
                          double[] costs,
                          JGeometry geometry,
                          CategorizedUserData userData)

Method Detail

getGeometry

public JGeometry getGeometry()
Description copied from interface: SpatialSubPath
Returns the geometry information of the path.
Specified by:
getGeometry in interface SpatialSubPath
Returns:
the geometry information of the path

getUserData

public 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

public 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

public UserData getUserData(int category)
Returns user data for the specified category.
Returns:

setUserData

public void setUserData(int category,
                        UserData userData)
Sets user data for the specified category.
Parameters:
userData -

getReferenceLightPath

public LogicalLightPath getReferenceLightPath()
Description copied from interface: LogicalLightSubPath
Returns the path containing the subpath.
Specified by:
getReferenceLightPath in interface LogicalLightSubPath
Returns:
the light weight logical path that contains the subpath

getStartPercentage

public double getStartPercentage()
Description copied from interface: LogicalLightSubPath
Returns the location of the starting point of the subpath as a percentage of the first link of the containing path.
Specified by:
getStartPercentage in interface LogicalLightSubPath
Returns:
location of the starting point on the start link

getEndPercentage

public double getEndPercentage()
Description copied from interface: LogicalLightSubPath
Returns the location of the end point of the subpath as a percentage of the last link of the containing path.
Specified by:
getEndPercentage in interface LogicalLightSubPath
Returns:
location of the end point on the end link

getStartLinkIndex

public int getStartLinkIndex()
Description copied from interface: LogicalLightSubPath
Returns the start link index.
Specified by:
getStartLinkIndex in interface LogicalLightSubPath
Returns:
the start link index

getEndLinkIndex

public int getEndLinkIndex()
Description copied from interface: LogicalLightSubPath
Returns the end link index.
Specified by:
getEndLinkIndex in interface LogicalLightSubPath
Returns:
the end link index

getCost

public double getCost()
Deprecated. 
Description copied from interface: LogicalLightSubPath
Returns the cost of the subpath.
Specified by:
getCost in interface LogicalLightSubPath
Returns:
cost of the subpath

isFullPath

public boolean isFullPath()
Description copied from interface: LogicalLightSubPath
Returns true if the subpath covers the entire reference path.
Specified by:
isFullPath in interface LogicalLightSubPath
Returns:
true if the subpath covers the entire reference path, false otherwise.

getCosts

public double[] getCosts()
Description copied from interface: LogicalLightSubPath
Returns the costs of the subpath.
Specified by:
getCosts in interface LogicalLightSubPath
Returns:
costs of the subpath

setReferenceLightPath

public void setReferenceLightPath(LogicalLightPath refPath)
Description copied from interface: LogicalLightSubPath
Sets the path containing the subpath.
Specified by:
setReferenceLightPath in interface LogicalLightSubPath

setStartPercentage

public void setStartPercentage(double startPercentage)
Description copied from interface: LogicalLightSubPath
Sets the location of the starting point of the subpath as a percentage of the first link of the containing path.
Specified by:
setStartPercentage in interface LogicalLightSubPath

setEndPercentage

public void setEndPercentage(double endPercentage)
Description copied from interface: LogicalLightSubPath
Sets the location of the end point of the subpath as a percentage of the last link of the containing path.
Specified by:
setEndPercentage in interface LogicalLightSubPath

setStartLinkIndex

public void setStartLinkIndex(int startLinkIndex)
Description copied from interface: LogicalLightSubPath
Sets the start link index.
Specified by:
setStartLinkIndex in interface LogicalLightSubPath

setEndLinkIndex

public void setEndLinkIndex(int endLinkIndex)
Description copied from interface: LogicalLightSubPath
Sets the end link index.
Specified by:
setEndLinkIndex in interface LogicalLightSubPath

setCosts

public void setCosts(double[] costs)
Description copied from interface: LogicalLightSubPath
Sets the costs of the subpath.
Specified by:
setCosts in interface LogicalLightSubPath

getUserData

public 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

public 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

public java.util.Map<java.lang.String,java.lang.Object> getUserData()
Deprecated. 
Returns user data.
Returns:
user data

setUserData

public void setUserData(java.util.Map<java.lang.String,java.lang.Object> userDataMap)
Deprecated. 
Sets user data.
Parameters:
userDataMap - user Data

getCategorizedUserData

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

setCategorizedUserData

public void setCategorizedUserData(CategorizedUserData cud)
Sets categorized user data.

getUserData

public UserData getUserData(int category)
Returns user data for the specified category.
Returns:

setUserData

public void setUserData(int category,
                        UserData userData)
Sets user data for the specified category.

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.