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

java.lang.Object
  com.esri.adf.web.data.geometry.WebGeometry
      com.esri.adf.web.data.geometry.WebPolygon

All Implemented Interfaces:

java.io.Serializable

public class WebPolygon
extends WebGeometry

WebPolygon is a class used for representing polygons. A WebPolygon holds a list of WebRings.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.esri.adf.web.data.geometry.WebGeometry

spatialReference

Constructor Summary

WebPolygon()
Constructs an empty instance of WebPolygon

WebPolygon(java.util.List<? extends WebRing> rings)
Constructs an instance of WebPolygon that contains the passed rings.

WebPolygon(WebSpatialReference spatialReference)
Constructs an empty instance of WebPolyhon with the given spatial reference.

Method Summary

void	addRing(WebRing ring) Adds a given ring to the polygon.
void	addRings(java.util.List<? extends WebRing> webRings) Adds all rings from the given list to the polygon.
boolean	equals(java.lang.Object obj)
WebPolygon	fromMapGeometry(WebExtent extent, int width, int height) Converts a geometry in map coordinates to a geometry of the same type in screen coordinates.
WebPolygon	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.
WebRing	getRing(int index) Returns a ring with the given index.
java.util.List<WebRing>	getRings() Returns the list of WebRings constituting this WebPolygon.
int	hashCode()
WebPolygon	project(WebSpatialReference toSpatialReference) Converts the geometry in map coordinates from the spatialReference of this geometry to a geometry in the desired spatial reference.
WebPolygon	toMapGeometry(WebExtent extent, int width, int height) Converts a geometry in screen coordinates to a geometry of the same type in map coordinates.
WebPolygon	toMapGeometry(WebMap webMap) Converts a geometry in screen coordinates to a geometry of the same type in map coordinates.
java.lang.String	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

WebPolygon

public WebPolygon(java.util.List<? extends WebRing> rings)

Constructs an instance of WebPolygon that contains the passed rings.

Parameters:

rings - the rings constituting the polygon

WebPolygon

public WebPolygon(WebSpatialReference spatialReference)

Constructs an empty instance of WebPolyhon with the given spatial reference.

Parameters:

spatialReference - spatial reference

WebPolygon

public WebPolygon()

Constructs an empty instance of WebPolygon

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

getRings

public java.util.List<WebRing> getRings()

Returns the list of WebRings constituting this WebPolygon.

Returns:

the list of WebRings constituting this WebPolygon

getRing

public WebRing getRing(int index)

Returns a ring with the given index.

Parameters:

index - index of the ring to be returned

Returns:

a ring with the given index

addRing

public void addRing(WebRing ring)

Adds a given ring to the polygon.

Parameters:

ring - a ring to be added to the polygon

addRings

public void addRings(java.util.List<? extends WebRing> webRings)

Adds all rings from the given list to the polygon.

Parameters:

webRings - a list of rings to be added to the polygon

toMapGeometry

public WebPolygon 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 WebPolygon 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 WebPolygon 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 WebPolygon 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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

project

public WebPolygon 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

hashCode

public int hashCode()

Overrides:

hashCode in class WebGeometry

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class WebGeometry