net.rim.device.api.lbs.maps.model.geospatial
Interface GsElement

All Superinterfaces:
Boxable, Mappable
All Known Implementing Classes:
MapLocation, GsFolder, GsImage, GsLine, GsMarker, GsPoint, GsPolyLine, GsPolygon, GsRoot

public interface GsElement
extends Mappable

Defines the interface implemented by all geospatial features. Geospatial features differ from other Mappable features in the following ways:

Since:
BlackBerry API 7.0.0

Method Summary
 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.
 void setParent(GsFolder parent)
          Sets the parent folder of this element.
 
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
 



Method Detail

getName

String getName()
Retrieves the name of this element.

Returns:
The name of the element.
Since:
BlackBerry API 7.0.0

getDescription

String getDescription()
Retrieves the description of this element.

Returns:
The description of this element.
Since:
BlackBerry API 7.0.0

getParent

GsFolder getParent()
Retrieves the parent folder of this element.

Returns:
The parent folder of this element.
Since:
BlackBerry API 7.0.0

setParent

void setParent(GsFolder parent)
Sets the parent folder of this element.

Parameters:
parent - The parent folder of this element.
Since:
BlackBerry API 7.0.0

equalsNode

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

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

equalsHierarchically

boolean equalsHierarchically(GsElement obj)
Determines equality of this element and another element based on the element's attributes and parent.

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





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