com.moximedia.aims
Class AimsPolygonObject

java.lang.Object
  com.moximedia.aims.AimsPolygonObject

All Implemented Interfaces:

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

public class AimsPolygonObject

extends java.lang.Object

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

Implementation of an ArcIMS polygon object which can be placed in an Acetate layer of a map.

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

AimsPolygonObject()
Creates a new polygon object with no arguments.

AimsPolygonObject(AimsPoints points)
Creates a new polygon object with a points list.

AimsPolygonObject(AimsPolygon polygon)
Creates a new polygon object with a polygon.

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.
AimsPoints	getPoints() Gets the points of the polygon 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.
AimsPolygon	getShape() Returns the polygon shape associated with the polygon object.
int	getUnits()
java.lang.String	getUnitsString()
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	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	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	setPoints(AimsPoints points) Sets the points of the polygon object.
void	setProperty(java.lang.String name, java.lang.String value) Sets the value of a property (programmer defined).
void	setShape(AimsPolygon shape) Sets the polygon shape associated with the polygon object.
void	setSymbol(AimsGradientFillSymbol sym) Sets the symbol for the object.
void	setSymbol(AimsHashLineSymbol sym) Sets the symbol for the object.
void	setSymbol(AimsRasterFillSymbol sym) Sets the symbol for the object.
void	setSymbol(AimsRasterMarkerSymbol sym) Sets the symbol for the object.
void	setSymbol(AimsSimpleLineSymbol sym) Sets the symbol for the object.
void	setSymbol(AimsSimpleMarkerSymbol sym) Sets the symbol for the object.
void	setSymbol(AimsSimplePolygonSymbol 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.
java.lang.String	toAxlString() Returns the AXL string to refresh this object, using the default environment coordinate separators.
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

AimsPolygonObject

public AimsPolygonObject()

Creates a new polygon object with no arguments.

AimsPolygonObject

public AimsPolygonObject(AimsPolygon polygon)

Creates a new polygon object with a polygon.

Parameters:

polygon - an AimsPolygon to set the object to.

AimsPolygonObject

public AimsPolygonObject(AimsPoints points)

Creates a new polygon object with a points list.

Parameters:

points - an AimsPoints object representing the outer boundary.

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.

getShape

public AimsPolygon getShape()

Returns the polygon shape associated with the polygon object.

Returns:

The polygon shape.

setShape

public void setShape(AimsPolygon shape)

Sets the polygon shape associated with the polygon object.

Parameters:

shape - The polygon shape.

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 AimsPolygonObject before use.

setCoordsys

public void setCoordsys(AimsCoordsys coordsys)

Sets the coordsys for this object.

Parameters:

coordsys - The coordsys for this object.

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.

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)

getPoints

public AimsPoints getPoints()

Gets the points of the polygon object.

setPoints

public void setPoints(AimsPoints points)

Sets the points of the polygon object.

Parameters:

points - An AimsPoints object containing the polygon points.

setSymbol

public void setSymbol(AimsGradientFillSymbol sym)

Sets the symbol for the object.

setSymbol

public void setSymbol(AimsHashLineSymbol sym)

Sets the symbol for the object.

setSymbol

public void setSymbol(AimsRasterFillSymbol sym)

Sets the symbol for the object.

setSymbol

public void setSymbol(AimsRasterMarkerSymbol sym)

Sets the symbol for the object.

setSymbol

public void setSymbol(AimsSimpleLineSymbol sym)

Sets the symbol for the object.

setSymbol

public void setSymbol(AimsSimpleMarkerSymbol sym)

Sets the symbol for the object.

setSymbol

public void setSymbol(AimsSimplePolygonSymbol sym)

Sets the symbol for the object.

setSymbol

public void setSymbol(AimsTrueTypeMarkerSymbol sym)

Sets the symbol for the object.

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 coordinate separators. 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_POLYGON.

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.

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.