net.rim.device.api.lbs.maps.model.geospatial
Class GsPoint

java.lang.Object
  extended by net.rim.device.api.lbs.maps.model.AbstractMappable
      extended by net.rim.device.api.lbs.maps.model.MapPoint
          extended by net.rim.device.api.lbs.maps.model.geospatial.GsPoint
All Implemented Interfaces:
Comparable, Boxable, GsElement, Mappable, Persistable

public class GsPoint
extends MapPoint
implements GsElement, Persistable

Represents the coordinates for a location point on a map.

Since:
BlackBerry API 7.0.0

Constructor Summary
GsPoint()
          Constructs a new instance of GsPoint.
GsPoint(double lat, double lon, String name, String description)
          Constructs a GsPoint with the given latitude, longitude, name, and description.
GsPoint(MapPoint position, String name, String description)
          Constructs a GsPoint with the given position, 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 point.
 void setName(String name)
          Sets the name of this point.
 void setParent(GsFolder parent)
          Sets the parent folder of this element.
 
Methods inherited from class net.rim.device.api.lbs.maps.model.MapPoint
compareTo, getBoundingBox, getLat, getLon, setLat, setLon, toCoordinates, toString
 
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, 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

GsPoint

public GsPoint()
Constructs a new instance of GsPoint.

Since:
BlackBerry API 7.0.0

GsPoint

public GsPoint(MapPoint position,
               String name,
               String description)
Constructs a GsPoint with the given position, name, and description.

Parameters:
position - The position of the point.
name - The name of the point.
description - The description of the point.
Since:
BlackBerry API 7.0.0

GsPoint

public GsPoint(double lat,
               double lon,
               String name,
               String description)
Constructs a GsPoint with the given latitude, longitude, name, and description.

Parameters:
lat - The latitude of the point.
lon - The longitude of the point.
name - The name of the point.
description - The description of the point.
Since:
BlackBerry API 7.0.0


Method Detail

getName

public String getName()
Description copied from interface: GsElement
Retrieves the name of this element.

Specified by:
getName in interface GsElement
Returns:
The name of the element.
Since:
BlackBerry API 7.0.0

setName

public void setName(String name)
Sets the name of this point.

Parameters:
name - The name of the point.
Since:
BlackBerry API 7.0.0

getDescription

public String getDescription()
Description copied from interface: GsElement
Retrieves the description of this element.

Specified by:
getDescription in interface GsElement
Returns:
The description of this element.
Since:
BlackBerry API 7.0.0

setDescription

public void setDescription(String description)
Sets the description of this point.

Parameters:
description - The description of the point.
Since:
BlackBerry API 7.0.0

getParent

public GsFolder getParent()
Description copied from interface: GsElement
Retrieves the parent folder of this element.

Specified by:
getParent in interface GsElement
Returns:
The parent folder of this element.
Since:
BlackBerry API 7.0.0

setParent

public void setParent(GsFolder parent)
Description copied from interface: GsElement
Sets the parent folder of this element.

Specified by:
setParent in interface GsElement
Parameters:
parent - The parent folder of this element.
Since:
BlackBerry API 7.0.0

hashCode

public int hashCode()
Description copied from class: Object
Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

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.)

Overrides:
hashCode in class MapPoint
Returns:
a hash code value for this object.
See Also:
Object.hashCode()
Since:
BlackBerry API 7.0.0

equalsNode

public boolean equalsNode(GsElement obj)
Description copied from interface: GsElement
Determines equality of this element and another element based on the element's attributes, but not the element's parents.

Specified by:
equalsNode in interface GsElement
Parameters:
obj - The GsElement to compare to.
Returns:
true if the elements are equal, false otherwise.
Since:
BlackBerry API 7.0.0

equalsHierarchically

public boolean equalsHierarchically(GsElement obj)
Description copied from interface: GsElement
Determines equality of this element and another element based on the element's attributes and parent.

Specified by:
equalsHierarchically in interface GsElement
Parameters:
obj - The GsElement to compare to.
Returns:
true if the elements are equal and have the same parent, false otherwise.
Since:
BlackBerry API 7.0.0

equals

public boolean equals(Object obj)
Description copied from class: Object
Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation:

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).

Overrides:
equals in class MapPoint
Parameters:
obj - the reference object with which to compare.
Returns:
true if this object is the same as the obj argument; false otherwise.
See Also:
Object.equals(Object)
Since:
BlackBerry API 7.0.0





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