com.moximedia.aims
Class AimsSpatialFilter

java.lang.Object
  com.moximedia.aims.AimsSpatialFilter

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class AimsSpatialFilter

extends java.lang.Object

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

The SpatialFilter class is used to define filter for a FeatureLayer.

See Also:

Serialized Form

Constructor Summary

AimsSpatialFilter()
Construct a SpatialFilter object

AimsSpatialFilter(AimsPoint pt, AimsMap map, double percent)
Created a spatial query using an envelope that is a percentage of the map extent.

AimsSpatialFilter(AimsShapeObject shape)
Creates a spatial filter using a shape object.

Method Summary

java.lang.Object	clone() Creates a copy of this spatial filter.
AimsShapeObject	getShape() Gets the shape of the spatial filter.
boolean	hasShape() Tests the shape of the spatial filter.
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	setBuffer(AimsBuffer buffer) Sets the buffer of the spatial filter to the specified buffer.
void	setRelation(java.lang.String relation) the filter relationship.
void	setShape(AimsShapeObject shape) Sets the shape of the spatial filter to the specified shape.
java.lang.String	toAxlString() Returns the AXL string to refresh this object.
java.lang.String	toAxlString(AimsEnvironment env) Returns the AXL string to refresh this object.
java.lang.String	toString() Returns a text representation of of this class.

Methods inherited from class java.lang.Object

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

Constructor Detail

AimsSpatialFilter

public AimsSpatialFilter()

Construct a SpatialFilter object

AimsSpatialFilter

public AimsSpatialFilter(AimsShapeObject shape)

Creates a spatial filter using a shape object.

AimsSpatialFilter

public AimsSpatialFilter(AimsPoint pt,
                         AimsMap map,
                         double percent)

Created a spatial query using an envelope that is a percentage of the map extent.

Parameters:

pt - An AimsPoint to use as the selection envelope centre.

map - An AimsMap object to get the extent from.

percent - The width of the envelope as a percent of the map extent.

Method Detail

clone

public java.lang.Object clone()

Creates a copy of this spatial filter.

Returns:

An object that is a copy of this spatial filter.

setBuffer

public void setBuffer(AimsBuffer buffer)

Sets the buffer of the spatial filter to the specified buffer.

Parameters:

buffer - A buffer used by the spatial filter.

hasShape

public boolean hasShape()

Tests the shape of the spatial filter.

Returns:

True if the spatial filter has a shape, otherwise false.

getShape

public AimsShapeObject getShape()

Gets the shape of the spatial filter.

Returns:

The shape used to limit the layer.

setShape

public void setShape(AimsShapeObject shape)

Sets the shape of the spatial filter to the specified shape.

Parameters:

shape - A shape to use to limit the layer.

setRelation

public void setRelation(java.lang.String relation)

the filter relationship. default is area_intersection.

Parameters:

relation - area_intersection / envelope_intersection

toString

public java.lang.String toString()

Returns a text representation of of this class.

Returns:

A string describing the class

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 (not used).

name - The AXL attribute name.

value - The AXL attribute value.

toAxlString

public java.lang.String toAxlString()

Returns the AXL string to refresh this object. This method is not typically used by the application programmer.

Returns:

The AXL string to refresh this object.

toAxlString

public java.lang.String toAxlString(AimsEnvironment env)

Returns the AXL string to refresh this object. This method is not typically used by the application programmer.

Returns:

The AXL string to refresh this object.