com.esri.adf.web.data.geometry
Class WebPath

java.lang.Object
  extended by com.esri.adf.web.data.geometry.WebGeometry
      extended by com.esri.adf.web.data.geometry.WebPointCollection
          extended by com.esri.adf.web.data.geometry.WebPath
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
WebRing

public class WebPath
extends WebPointCollection

WebPath is a class used for representing a several connected segments of a WebPolyline. WebPath holds a list of WebPoints.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.adf.web.data.geometry.WebPointCollection
points
 
Fields inherited from class com.esri.adf.web.data.geometry.WebGeometry
spatialReference
 
Constructor Summary
WebPath()
          Constructs an empty WebPath with null for spatial reference.
WebPath(java.util.List<? extends WebPoint> points)
          Constructs a WebPath using the s from the passed list,
WebPath(WebSpatialReference spatialReference)
          Constructs an empty WebPath with the given WebSpatialReference.
 
Method Summary
 WebPath fromMapGeometry(WebExtent extent, int width, int height)
           Converts a geometry in map coordinates to a geometry of the same type in screen coordinates.
 WebPath fromMapGeometry(WebMap webMap)
           Converts a geometry in map coordinates to a geometry of the same type in screen coordinates.
 java.lang.String getGeometryType()
           Returns a text representing the type of the geometry.
 WebPath project(WebSpatialReference toSpatialReference)
           Converts the geometry in map coordinates from the spatialReference of this geometry to a geometry in the desired spatial reference.
 WebPath toMapGeometry(WebExtent extent, int width, int height)
           Converts a geometry in screen coordinates to a geometry of the same type in map coordinates.
 WebPath toMapGeometry(WebMap webMap)
           Converts a geometry in screen coordinates to a geometry of the same type in map coordinates.
 
Methods inherited from class com.esri.adf.web.data.geometry.WebPointCollection
addPoint, equals, fromMapPoints, fromMapPoints, getPoints, getXs, getYs, hashCode, projectPoints, toMapPoints, toMapPoints, toString
 
Methods inherited from class com.esri.adf.web.data.geometry.WebGeometry
getSpatialReference, setSpatialReference
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WebPath

public WebPath(java.util.List<? extends WebPoint> points)
Constructs a WebPath using the s from the passed list,

Parameters:
points - a list of WebPoints

WebPath

public WebPath(WebSpatialReference spatialReference)
Constructs an empty WebPath with the given WebSpatialReference.

Parameters:
spatialReference - a spatial reference to be used

WebPath

public WebPath()
Constructs an empty WebPath with null for spatial reference.

Method Detail

getGeometryType

public java.lang.String getGeometryType()
Description copied from class: WebGeometry

Returns a text representing the type of the geometry. WebGeometry objects of the same type must return the same text.

Specified by:
getGeometryType in class WebGeometry
Returns:
a text representing the type of the geometry

toMapGeometry

public WebPath toMapGeometry(WebMap webMap)
Description copied from class: WebGeometry

Converts a geometry in screen coordinates to a geometry of the same type in map coordinates. The coordinate system of the converted geometry is the same as the coordinate system of the WebMap.

Specified by:
toMapGeometry in class WebGeometry
Parameters:
webMap - The WebMap based on which the coordinates need to be converted
Returns:
the WebGeometry in map coordinates

toMapGeometry

public WebPath toMapGeometry(WebExtent extent,
                             int width,
                             int height)
Description copied from class: WebGeometry

Converts a geometry in screen coordinates to a geometry of the same type in map coordinates. The coordinate system of the converted geometry is the same as the coordinate system of the specified extent.

Overrides:
toMapGeometry in class WebGeometry
Parameters:
extent - the WebExtent of the map image
width - the width of the map image
height - the height of the map image
Returns:
the WebGeometry in map coordinates

fromMapGeometry

public WebPath fromMapGeometry(WebMap webMap)
Description copied from class: WebGeometry

Converts a geometry in map coordinates to a geometry of the same type in screen coordinates. Since the converted geometry is a screen geometry, the coordinate system of the converted geometry will be null.

Specified by:
fromMapGeometry in class WebGeometry
Parameters:
webMap - The WebMap based on which the coordinates need to be converted
Returns:
the WebGeometry in screen coordinates

fromMapGeometry

public WebPath fromMapGeometry(WebExtent extent,
                               int width,
                               int height)
Description copied from class: WebGeometry

Converts a geometry in map coordinates to a geometry of the same type in screen coordinates. Since the converted geometry is a screen geometry, the coordinate system of the converted geometry will be null.

Overrides:
fromMapGeometry in class WebGeometry
Parameters:
extent - the WebExtent of the map image
width - the width of the map image
height - the height of the map image
Returns:
the WebGeometry in screen coordinates

project

public WebPath project(WebSpatialReference toSpatialReference)
Description copied from class: WebGeometry

Converts the geometry in map coordinates from the spatialReference of this geometry to a geometry in the desired spatial reference. If the desired spatial reference is same as that of this geometry, this same geometry is returned. Otherwise, a new WebGeometry object is created and populated with the converted coordinates. The type of the projected geometry is same as this geometry.

Specified by:
project in class WebGeometry
Parameters:
toSpatialReference - the desired spatial reference of the projected geometry
Returns:
the projected WebGeometry