com.moximedia.aims
Class AimsPointObject

java.lang.Object
  com.moximedia.aims.AimsPointObject

All Implemented Interfaces:

AimsAcetateObject, java.lang.Cloneable, java.io.Serializable

public class AimsPointObject

extends java.lang.Object

implements AimsAcetateObject, java.io.Serializable, java.lang.Cloneable

Implementation of an ArcIMS point object which can be placed in an Acetate layer of a map. Use an AimsPoint instead if you need similar functionality for non-acetate use.

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.moximedia.aims.AimsAcetateObject

ACETATE_OBJECT_TYPE_ENVELOPE, ACETATE_OBJECT_TYPE_LINE, ACETATE_OBJECT_TYPE_NORTHARROW, ACETATE_OBJECT_TYPE_POINT, ACETATE_OBJECT_TYPE_POLYGON, ACETATE_OBJECT_TYPE_POLYLINE, ACETATE_OBJECT_TYPE_SCALEBAR, ACETATE_OBJECT_TYPE_TEXT, ACETATE_OBJECT_UNITS_DATABASE, ACETATE_OBJECT_UNITS_PIXEL

Constructor Summary

AimsPointObject()
Creates a new point object with no arguments.

AimsPointObject(AimsPoint pt)
Creates a new point object with coordinate from an AimsPoint

AimsPointObject(AimsPointObject pt)
Creates a new point object with coordinate from another AimsPointObject

AimsPointObject(double x, double y)
Creates a new point object with coordinate values.

AimsPointObject(java.lang.String xy)
Creates a new point object with coordinate values contained in a String.

Method Summary

java.lang.Object	clone() Creates a copy of this object.
int	getAcetateObjectType() Gets the acetate object type.
java.lang.Object	getObjectTag() Gets the object tag.
AimsPoint	getPoint() Gets the point object associated with this object.
java.lang.String	getProperty(java.lang.String name) Gets the value of a property.
java.util.Set	getPropertyNames() Returns a Set containing the property names.
AimsSymbol	getSymbol() Gets the symbol for the object
int	getUnits()
java.lang.String	getUnitsString()
double	getX() Gets the X coordinate location of the point object.
double	getY() Gets the Y coordinate location of the point object.
boolean	hasProperties() Returns an indicator of whether the object has programmer defined properties.
void	offsetBy(AimsPoint offset) Sets the position of the point by adjusting it by the X and Y values contained in another point.
void	setAxlAttribute(java.lang.String tag, java.lang.String name, java.lang.String value) Sets one of the attributes of this object using a string value.
void	setCoordsys(AimsCoordsys coordsys) Sets the coordsys for this object.
void	setLocation(AimsPoint pt) Sets the location of the object using an AimsPoint.
void	setLocation(AimsPointObject pt) Sets the location of the object using another AimsPointObject.
void	setLocation(double x, double y) Sets the location of the object using coordinates.
void	setMaxScale(double scale, AimsMap map)
void	setMaxScaleFactor(double unitsPerPixel)
void	setMinScale(double scale, AimsMap map)
void	setMinScaleFactor(double unitsPerPixel)
void	setObjectTag(java.lang.Object tag) Sets an object tag for this object.
void	setPoint(AimsPoint pt) Sets the point associated with this object.
void	setProperty(java.lang.String name, java.lang.String value) Sets the value of a property (programmer defined).
void	setSymbol(AimsRasterMarkerSymbol sym) Sets the symbol for the object.
void	setSymbol(AimsSimpleMarkerSymbol sym) Sets the symbol for the object.
void	setSymbol(AimsTrueTypeMarkerSymbol sym) Sets the symbol for the object.
void	setUnits(int units) Sets the units of the acetate object.
void	setUnits(java.lang.String units) Sets the units of the acetate object.
void	setX(double x) Sets the X coordinate location of the point object.
void	setY(double y) Sets the Y coordinate location of the point object.
java.lang.String	toAxlString() Returns the AXL string to refresh this object, using the default environment setting.
java.lang.String	toAxlString(AimsEnvironment env) Returns the AXL string to refresh this object, using the coordinate separators in the specified environnment setting.
java.lang.String	toString() Returns a text representation of of this object.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AimsPointObject

public AimsPointObject()

Creates a new point object with no arguments.

AimsPointObject

public AimsPointObject(double x,
                       double y)

Creates a new point object with coordinate values.

Parameters:

x - The x location of the object

y - The y location of the object.

AimsPointObject

public AimsPointObject(AimsPoint pt)

Creates a new point object with coordinate from an AimsPoint

Parameters:

pt - The AimsPoint containing the location of the object

AimsPointObject

public AimsPointObject(java.lang.String xy)

Creates a new point object with coordinate values contained in a String.

Parameters:

xy - The xy location of the object

AimsPointObject

public AimsPointObject(AimsPointObject pt)

Creates a new point object with coordinate from another AimsPointObject

Parameters:

pt - The AimsPointObject containing the location of the object

Method Detail

getProperty

public java.lang.String getProperty(java.lang.String name)

Gets the value of a property.

Specified by:

getProperty in interface AimsAcetateObject

Parameters:

name - The property name

Returns:

The property value, or null.

setProperty

public void setProperty(java.lang.String name,
                        java.lang.String value)

Sets the value of a property (programmer defined).

Specified by:

setProperty in interface AimsAcetateObject

Parameters:

name - The property name

value - The property value.

getPropertyNames

public java.util.Set getPropertyNames()

Returns a Set containing the property names.

Specified by:

getPropertyNames in interface AimsAcetateObject

Returns:

The set containing the names, or null.

hasProperties

public boolean hasProperties()

Returns an indicator of whether the object has programmer defined properties.

Specified by:

hasProperties in interface AimsAcetateObject

Returns:

True if properties exist, otherwise false.

setObjectTag

public void setObjectTag(java.lang.Object tag)

Sets an object tag for this object.

Specified by:

setObjectTag in interface AimsAcetateObject

getObjectTag

public java.lang.Object getObjectTag()

Gets the object tag.

Specified by:

getObjectTag in interface AimsAcetateObject

Returns:

The object tag, or null if there isn't one set.

clone

public java.lang.Object clone()

Creates a copy of this object.

Specified by:

clone in interface AimsAcetateObject

Returns:

An object that is a copy of this object. Note that the returned value is a java.lang.Object that must be cast to an AimsPointObject before use.

offsetBy

public void offsetBy(AimsPoint offset)

Sets the position of the point by adjusting it by the X and Y values contained in another point.

Parameters:

offset - A point containing the X and Y delta offsets.

setCoordsys

public void setCoordsys(AimsCoordsys coordsys)

Sets the coordsys for this object.

Parameters:

coordsys - The coordsys for this object.

setMinScale

public void setMinScale(double scale,
                        AimsMap map)

setMinScaleFactor

public void setMinScaleFactor(double unitsPerPixel)

setMaxScale

public void setMaxScale(double scale,
                        AimsMap map)

setMaxScaleFactor

public void setMaxScaleFactor(double unitsPerPixel)

getSymbol

public AimsSymbol getSymbol()

Gets the symbol for the object

Returns:

The symbol for the object

setSymbol

public void setSymbol(AimsSimpleMarkerSymbol sym)

Sets the symbol for the object.

setSymbol

public void setSymbol(AimsRasterMarkerSymbol sym)

Sets the symbol for the object.

setSymbol

public void setSymbol(AimsTrueTypeMarkerSymbol sym)

Sets the symbol for the object.

setLocation

public void setLocation(double x,
                        double y)

Sets the location of the object using coordinates.

Parameters:

x - The x location of the object

y - The y location of the object.

setLocation

public void setLocation(AimsPointObject pt)

Sets the location of the object using another AimsPointObject.

Parameters:

pt - The point object containing coordinates to use.

setLocation

public void setLocation(AimsPoint pt)

Sets the location of the object using an AimsPoint.

Parameters:

pt - The point containing coordinates to use.

setX

public void setX(double x)

Sets the X coordinate location of the point object.

setY

public void setY(double y)

Sets the Y coordinate location of the point object.

getX

public double getX()

Gets the X coordinate location of the point object.

Returns:

The X coordinate location for the point object.

getY

public double getY()

Gets the Y coordinate location of the point object.

Returns:

The Y coordinate location for the point object.

getPoint

public AimsPoint getPoint()

Gets the point object associated with this object.

Returns:

The point.

setPoint

public void setPoint(AimsPoint pt)

Sets the point associated with this object.

Parameters:

pt - The point.

toString

public java.lang.String toString()

Returns a text representation of of this object.

Returns:

A string describing the object

toAxlString

public java.lang.String toAxlString()

Returns the AXL string to refresh this object, using the default environment setting. This method is not typically used by the application programmer.

Specified by:

toAxlString in interface AimsAcetateObject

Returns:

The AXL string to refresh this object.

toAxlString

public java.lang.String toAxlString(AimsEnvironment env)

Returns the AXL string to refresh this object, using the coordinate separators in the specified environnment setting. This method is not typically used by the application programmer.

Specified by:

toAxlString in interface AimsAcetateObject

Parameters:

env - The environment object containing coordinate separators.

Returns:

The AXL string to refresh this object.

getAcetateObjectType

public int getAcetateObjectType()

Gets the acetate object type.

Specified by:

getAcetateObjectType in interface AimsAcetateObject

Returns:

AimsAcetateObject.ACETATE_OBJECT_TYPE_POINT.

setUnits

public void setUnits(java.lang.String units)

Sets the units of the acetate object. Valid values are "pixel" and "database".

Parameters:

units - The units of the acetate object. Valid values are "pixel" and "database".

setUnits

public void setUnits(int units)

Sets the units of the acetate object.

Specified by:

setUnits in interface AimsAcetateObject

Parameters:

units - The units of the acetate object. Valid values are AimsAcetateObject.ACETATE_OBJECT_UNITS_DATABASE or AimsAcetateObject.ACETATE_OBJECT_UNITS_PIXEL.

getUnits

public int getUnits()

Specified by:

getUnits in interface AimsAcetateObject

getUnitsString

public java.lang.String getUnitsString()

setAxlAttribute

public void setAxlAttribute(java.lang.String tag,
                            java.lang.String name,
                            java.lang.String value)

Sets one of the attributes of this object using a string value. This method should only be called from the SAX event handler.

Parameters:

tag - The AXL element tag containing this attribute.

name - The AXL attribute name.

value - The AXL attribute value.