com.moximedia.aims
Class AimsLabelledPointObject

java.lang.Object
  com.moximedia.aims.AimsLabelledPointObject

All Implemented Interfaces:

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

public class AimsLabelledPointObject

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 with a text label beside it.

Author:

Doug Cates - www.moximedia.com

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.moximedia.aims.AimsAcetateObject

ACETATE_OBJECT_TYPE_CALLOUTTEXT, ACETATE_OBJECT_TYPE_ENVELOPE, ACETATE_OBJECT_TYPE_LABELLEDPOINT, 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

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

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

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

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

AimsLabelledPointObject(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.
AimsEnvelope	getExtent() Gets the extent of the object.
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.
AimsPoint	getShape() Gets the shape geometry of the object.
AimsSymbol	getSymbol() Gets the symbol for the object
int	getUnits() Returns an enumerated value indicating the type of units, either AimsAcetateObject.ACETATE_OBJECT_UNITS_DATABASE or AimsAcetateObject.ACETATE_OBJECT_UNITS_PIXEL.
java.lang.String	getUnitsString() Returns a string indicating the type of units, either "database" or "pixel".
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.
boolean	intersects(AimsShapeObject shape) Returns an indicator whether this object intersects the specified geometry.
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	setLabel(java.lang.String label) Sets the label for the labelled point.
void	setLabelOffset(int xOffset, int yOffset) Sets the label offset from the point symbol in pixels.
void	setLabelSymbol(AimsTextMarkerSymbol symbol) Sets the symbol used for drawing the label.
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) Sets the maximum scale that this object will be displayed.
void	setMaxScaleFactor(double unitsPerPixel) Sets the maximum scale factor that this object will be displayed.
void	setMinScale(double scale, AimsMap map) Sets the minimum scale that this object will be displayed.
void	setMinScaleFactor(double unitsPerPixel) Sets the minimum scale factor that this object will be displayed.
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	toAxlString(AimsEnvironment env, AimsMap map) 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

AimsLabelledPointObject

public AimsLabelledPointObject()

Creates a new point object with no arguments.

AimsLabelledPointObject

public AimsLabelledPointObject(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.

AimsLabelledPointObject

public AimsLabelledPointObject(AimsPoint pt)

Creates a new point object with coordinate from an AimsPoint

Parameters:

pt - The AimsPoint containing the location of the object

AimsLabelledPointObject

public AimsLabelledPointObject(java.lang.String xy)

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

Parameters:

xy - The xy location of the object

AimsLabelledPointObject

public AimsLabelledPointObject(AimsPointObject pt)

Creates a new point object with coordinate from another AimsPointObject

Parameters:

pt - The AimsPointObject containing the location of the object

Method Detail

setLabel

public void setLabel(java.lang.String label)

Sets the label for the labelled point.

Parameters:

label - The text to appear beside the point symbol.

setLabelOffset

public void setLabelOffset(int xOffset,
                           int yOffset)

Sets the label offset from the point symbol in pixels.

Parameters:

xOffset - The horizontal distance from the point in pixels.

yOffset - The vertical distance from the point in pixels.

setLabelSymbol

public void setLabelSymbol(AimsTextMarkerSymbol symbol)

Sets the symbol used for drawing the label.

Parameters:

symbol - The symbol used to draw the label.

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

Parameters:

tag - A programmer defined element to associate with this object.

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. Note that the units are set to database units if a coordinate system is set.

Parameters:

coordsys - The coordsys for this object.

setMinScale

public void setMinScale(double scale,
                        AimsMap map)

Sets the minimum scale that this object will be displayed.

Parameters:

scale - The scale.

map - The map object to use to calculate scale.

setMinScaleFactor

public void setMinScaleFactor(double unitsPerPixel)

Sets the minimum scale factor that this object will be displayed.

Parameters:

unitsPerPixel - The scale factor.

setMaxScale

public void setMaxScale(double scale,
                        AimsMap map)

Sets the maximum scale that this object will be displayed.

Parameters:

scale - The scale.

map - The map object to use to calculate scale.

setMaxScaleFactor

public void setMaxScaleFactor(double unitsPerPixel)

Sets the maximum scale factor that this object will be displayed.

Parameters:

unitsPerPixel - The scale factor.

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.

Parameters:

sym - The the symbol for the object.

setSymbol

public void setSymbol(AimsRasterMarkerSymbol sym)

Sets the symbol for the object.

Parameters:

sym - The the symbol for the object.

setSymbol

public void setSymbol(AimsTrueTypeMarkerSymbol sym)

Sets the symbol for the object.

Parameters:

sym - The 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.

Parameters:

x - The new X coordinate location for the point object.

setY

public void setY(double y)

Sets the Y coordinate location of the point object.

Parameters:

y - The new Y coordinate location for 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.

getExtent

public AimsEnvelope getExtent()

Gets the extent of the object.

Specified by:

getExtent in interface AimsAcetateObject

Returns:

The extent of the object. Note: Returns null if this object uses pixels for units.

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.

toAxlString

public java.lang.String toAxlString(AimsEnvironment env,
                                    AimsMap map)

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.

Parameters:

env - The environment object containing coordinate separators.

map - The map object that this object belongs to.

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

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

Returns an enumerated value indicating the type of units, either AimsAcetateObject.ACETATE_OBJECT_UNITS_DATABASE or AimsAcetateObject.ACETATE_OBJECT_UNITS_PIXEL.

Specified by:

getUnits in interface AimsAcetateObject

Returns:

The units enumeration value.

getUnitsString

public java.lang.String getUnitsString()

Returns a string indicating the type of units, either "database" or "pixel".

Returns:

The units string.

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.

getShape

public AimsPoint getShape()

Gets the shape geometry of the object.

Returns:

A geometry object representing the shape.

intersects

public boolean intersects(AimsShapeObject shape)

Returns an indicator whether this object intersects the specified geometry.

Specified by:

intersects in interface AimsAcetateObject

Parameters:

shape - The geometry to test.

Returns:

True if intersects, otherwise false. Note: always returns false for pixel based objects.