com.mapquest
Class SymbolPrimitive

java.lang.Object
  com.mapquest.MQObject
      com.mapquest.Primitive
          com.mapquest.SymbolPrimitive

All Implemented Interfaces:

java.lang.Cloneable

public class SymbolPrimitive

extends Primitive

Describes a SymbolPrimitive to be placed on a map. The SymbolPrimitive is initially located by an X/Y coordinate. The coordinate is converted into a latitude/longitude point so the SymbolPrimitive can be placed in the same geographical location after the map is manipulated.

See Also:

Point, LatLng, SymbolType

Field Summary

static int	CLASS_ID
static java.lang.String	CLASS_NAME

Fields inherited from class com.mapquest.MQObject

DEFAULT_ID, DEFAULT_NAME, DEFAULT_VERSION, FORMAT_NUMERIC_ID, FORMAT_TEXT_NAME, INVALID_ID, INVALID_NAME, INVALID_VERSION

Constructor Summary

SymbolPrimitive()
Default constructor.

Method Summary

boolean	equals(java.lang.Object otherObject) Compares this object to the specified object.
LatLng	getCenterLatLng() Retrieves the latitude of the Center of this SymbolPrimitive.
Point	getCenterPoint() Retrieves the Center point of this SymbolPrimitive.
int	getClassId() Returns the numeric id of this class.
java.lang.String	getClassName() Returns the text name of this class.
java.lang.String	getSymbolName() Returns the SymbolPrimitive name.
SymbolType	getSymbolType() Returns the Symbol type.
int	hashCode() Returns a hash code for this SymbolPrimitive.
void	init() Initializes object.
void	setCenterLatLng(LatLng ll) Sets the lat/long of the Center of this SymbolPrimitive.
void	setCenterPoint(Point pnt) Sets the coordinates of the Center point of this SymbolPrimitive.
void	setSymbolName(java.lang.String symbolName) Sets the SymbolPrimitive name.
void	setSymbolType(SymbolType symbolType) Sets the Symbol type.

Methods inherited from class com.mapquest.Primitive

getCoordinateType, getDrawTrigger, getKey, getOpacity, getTriggerDT, setCoordinateType, setDrawTrigger, setKey, setOpacity, setTriggerDT

Methods inherited from class com.mapquest.MQObject

clone, getFormat, getIdWithVersion, getNameWithVersion, getObjectVersion, getTypeId, getTypeName, getVerboseConsoleOutput, setFormat, setObjectVersion, setVerboseConsoleOutput, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_ID

public static final int CLASS_ID

See Also:

Constant Field Values

CLASS_NAME

public static final java.lang.String CLASS_NAME

See Also:

Constant Field Values

Constructor Detail

SymbolPrimitive

public SymbolPrimitive()

Default constructor.

Method Detail

init

public void init()

Initializes object.

Overrides:

init in class Primitive

getClassId

public int getClassId()

Returns the numeric id of this class.

Overrides:

getClassId in class MQObject

Returns:

the numeric id of this class.

getClassName

public java.lang.String getClassName()

Returns the text name of this class.

Overrides:

getClassName in class MQObject

Returns:

the text name of this class.

getCenterPoint

public Point getCenterPoint()

Retrieves the Center point of this SymbolPrimitive.

Returns:

The Center point of the SymbolPrimitive.

setCenterPoint

public void setCenterPoint(Point pnt)

Sets the coordinates of the Center point of this SymbolPrimitive.

Parameters:

pnt - The point coordinate.

getCenterLatLng

public LatLng getCenterLatLng()

Retrieves the latitude of the Center of this SymbolPrimitive.

Returns:

The latitude of the Center of this SymbolPrimitive.

setCenterLatLng

public void setCenterLatLng(LatLng ll)

Sets the lat/long of the Center of this SymbolPrimitive. This function is for completeness, and should not be used in an application.

Parameters:

ll - The LatLng of this SymbolPrimitive Center.

setSymbolName

public void setSymbolName(java.lang.String symbolName)

Sets the SymbolPrimitive name.

Parameters:

symbolName - The name of this SymbolPrimitive.

getSymbolName

public java.lang.String getSymbolName()

Returns the SymbolPrimitive name.

Returns:

The name of this SymbolPrimitive.

setSymbolType

public void setSymbolType(SymbolType symbolType)

Sets the Symbol type.

Parameters:

symbolType - The type of this SymbolPrimitive.

getSymbolType

public SymbolType getSymbolType()

Returns the Symbol type.

Returns:

The type of this SymbolPrimitive.

equals

public boolean equals(java.lang.Object otherObject)

Compares this object to the specified object. The result is true if and only if the argument is not null and is a SymbolPrimitive object that has same attributes as this object.

Overrides:

equals in class Primitive

Parameters:

otherObject - the object to compare this SymbolPrimitive against.

Returns:

true if the SymbolPrimitive objects are equal; false otherwise.

hashCode

public int hashCode()

Returns a hash code for this SymbolPrimitive.

Overrides:

hashCode in class Primitive

Returns:

a hash code value for this SymbolPrimitive.