|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectnet.rim.device.api.lbs.maps.model.AbstractMappable
net.rim.device.api.lbs.maps.model.MapPolyLine
net.rim.device.api.lbs.maps.model.MapSimplePolygon
net.rim.device.api.lbs.maps.model.MapComplexPolygon
net.rim.device.api.lbs.maps.model.geospatial.GsPolygon
public class GsPolygon
Represents a polygon that is composed of an outer boundary, which is defined as an
ordered series of MapPoint elements, and inner boundaries that are
represented by 0 or more MapSimplePolygon elements.
Error checking is not performed to detect the following invalid situations:
| Constructor Summary | ||
|---|---|---|
GsPolygon()
Constructs a new GsPolygon instance. |
||
GsPolygon(MapPoint[] outerBoundary,
String name,
String description)
Constructs a GsPolygon with the given outer boundary, name, and description. |
||
GsPolygon(MapPoint[] outerBoundary,
MapSimplePolygon[] innerBoundaries,
String name,
String description)
Constructs a GsPolygon with the given outer boundary, inner boundaries, name, and description. |
||
| Method Summary | ||
|---|---|---|
boolean |
equals(Object obj)
Indicates whether some other object is "equal to" this one. |
|
boolean |
equalsHierarchically(GsElement obj)
Determines equality of this element and another element based on the element's attributes and parent. |
|
boolean |
equalsNode(GsElement obj)
Determines equality of this element and another element based on the element's attributes, but not the element's parents. |
|
String |
getDescription()
Retrieves the description of this element. |
|
String |
getName()
Retrieves the name of this element. |
|
GsFolder |
getParent()
Retrieves the parent folder of this element. |
|
int |
hashCode()
Returns a hash code value for the object. |
|
void |
setDescription(String description)
Sets the description of this polygon. |
|
void |
setName(String name)
Sets the name of this polygon. |
|
void |
setParent(GsFolder parent)
Sets the parent folder of this element. |
|
| Methods inherited from class net.rim.device.api.lbs.maps.model.MapComplexPolygon |
|---|
addInnerBoundary, getInnerBoundaries, removeAllInnerBoundaries, removeInnerBoundary |
| Methods inherited from class net.rim.device.api.lbs.maps.model.MapPolyLine |
|---|
addPoint, getBoundingBox, getPoint, insertPointAt, removeAllPoints, removePoint, removePointAt, setPointAt, size |
| Methods inherited from class net.rim.device.api.lbs.maps.model.AbstractMappable |
|---|
getCommandsByType, getStyleId, isClusterable, match, setStyleId |
| Methods inherited from class java.lang.Object |
|---|
getClass, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface net.rim.device.api.lbs.maps.model.Mappable |
|---|
getStyleId, isClusterable |
| Methods inherited from interface net.rim.device.api.lbs.maps.Boxable |
|---|
getBoundingBox |
| Constructor Detail |
|---|
public GsPolygon()
GsPolygon instance.
public GsPolygon(MapPoint[] outerBoundary,
String name,
String description)
GsPolygon with the given outer boundary, name, and description.
outerBoundary - The points that define the outer boundary.name - The name of the polygon.description - The description of the polygon.
public GsPolygon(MapPoint[] outerBoundary,
MapSimplePolygon[] innerBoundaries,
String name,
String description)
GsPolygon with the given outer boundary, inner boundaries, name, and description.
outerBoundary - The points that define the outer boundary.innerBoundaries - The MapSimplePolygon elements representing the inner boundaries.name - The name of the polygon.description - The description of the polygon.| Method Detail |
|---|
public String getName()
GsElement
getName in interface GsElementpublic void setName(String name)
name - The name of this polygon.public String getDescription()
GsElement
getDescription in interface GsElementpublic void setDescription(String description)
description - The description of this polygon.public GsFolder getParent()
GsElement
getParent in interface GsElementpublic void setParent(GsFolder parent)
GsElement
setParent in interface GsElementparent - The parent folder of this element.public int hashCode()
Objectjava.util.Hashtable.
The general contract of hashCode is:
hashCode method on each of
the two objects must produce the same integer result.
Object.equals(java.lang.Object)
method, then calling the hashCode method on each of the
two objects must produce distinct integer results. However, the
programmer should be aware that producing distinct integer results
for unequal objects may improve the performance of hashtables.
As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)
hashCode in class MapComplexPolygonObject.equals(java.lang.Object),
Hashtablepublic boolean equalsNode(GsElement obj)
GsElement
equalsNode in interface GsElementobj - The GsElement to compare to.
true if the elements are equal, false
otherwise.public boolean equalsHierarchically(GsElement obj)
GsElement
equalsHierarchically in interface GsElementobj - The GsElement to compare to.
true if the elements are equal and have the same
parent, false otherwise.public boolean equals(Object obj)
Object
The equals method implements an equivalence relation:
x,
x.equals(x) should return true.
x and
y, x.equals(y) should return
true if and only if y.equals(x) returns
true.
x,
y, and z, if x.equals(y)
returns true and y.equals(z) returns
true, then x.equals(z) should return
true.
x
and y, multiple invocations of x.equals(y)
consistently return true or consistently return
false, provided no information used in
equals comparisons on the object is modified.
x,
x.equals(null) should return false.
The equals method for class Object implements
the most discriminating possible equivalence relation on objects;
that is, for any reference values x and y,
this method returns true if and only if x and
y refer to the same object (x==y has the
value true).
equals in class MapComplexPolygonobj - the reference object with which to compare.
true if this object is the same as the obj
argument; false otherwise.Boolean.hashCode(),
Hashtable
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright 1999-2011 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Java is a trademark of Oracle America Inc. in the US and other countries.
Legal