com.moximedia.aims
Class AimsFilter

java.lang.Object
  com.moximedia.aims.AimsFilter

All Implemented Interfaces:

AimsAxlObject, java.lang.Cloneable, java.io.Serializable

public class AimsFilter

extends java.lang.Object

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

Representation of an ArcIMS filter object. A filter is used to restrict the features of a featurelayer, or in a query of its recordset.

See Also:

Serialized Form

Constructor Summary

AimsFilter()
Creates new Filter

Method Summary

java.lang.Object	clone() Creates a copy of this object.
AimsBuffer	getBuffer()
AimsSpatialFilter	getSpatialFilter() Gets the spatial filter associated with this object, if any.
java.lang.String	getWhereExpression() Gets the where part of SQL.
void	setAccuracy(int accuracy) Set the filter accuracy
void	setBuffer(AimsBuffer buffer) Sets the buffer of the filter to the specified buffer.
void	setFeatureCoordsys(AimsCoordsys coordsys) Sets the feature coordsys.
void	setFilterCoordsys(AimsCoordsys coordsys) Sets the filter coordsys.
void	setJoinExpression(java.lang.String join) Set table join expressions
void	setJoinTables(java.lang.String jointab) Set the list of join tables
void	setSearchOrder(java.lang.String order) Set the search order
void	setSpatialFilter(AimsEnvelope env) Sets the spatial query for the filter using an envelope.
void	setSpatialFilter(AimsPoint pt) Sets the spatial query for the filter using a point.
void	setSpatialFilter(AimsPoint pt, AimsMap map, double percent) Sets the spatial query for the filter using an envelope that is a percentage of the map extent.
void	setSpatialFilter(AimsShapeObject shape) Sets the spatial query for the filter using a shape.
void	setSpatialFilter(AimsSpatialFilter spatialFilter) Sets the spatial query for the filter.
void	setSubfields(java.lang.String subflds) Set the list of fields to be extracted
void	setWhereExpression(java.lang.String where) Set the where part of SQL.
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	toAxlString(AimsEnvironment env, AimsRecordset rs) Returns the AXL string to refresh this object.
java.lang.String	toAxlString(java.lang.String requestType, AimsEnvironment env, AimsRecordset rs) 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

AimsFilter

public AimsFilter()

Creates new Filter

Method Detail

clone

public java.lang.Object clone()

Creates a copy of this object.

Returns:

An object that is a copy of this object. The object must be cast to an AimsFilterbefore use.

setAccuracy

public void setAccuracy(int accuracy)

Set the filter accuracy

Parameters:

accuracy - The filter accuracy

getBuffer

public AimsBuffer getBuffer()

setBuffer

public void setBuffer(AimsBuffer buffer)

Sets the buffer of the filter to the specified buffer.

Parameters:

buffer - A buffer used by the filter.

setFeatureCoordsys

public void setFeatureCoordsys(AimsCoordsys coordsys)

Sets the feature coordsys.

Parameters:

coordsys - The feature coordsys used by the filter.

setFilterCoordsys

public void setFilterCoordsys(AimsCoordsys coordsys)

Sets the filter coordsys.

Parameters:

coordsys - The filter coordsys used by the filter.

setSearchOrder

public void setSearchOrder(java.lang.String order)

Set the search order

Parameters:

order - The search order string

setJoinExpression

public void setJoinExpression(java.lang.String join)

Set table join expressions

Parameters:

join - e.g.: "To=[master table column which will be used for joining], From=[defines a join table column which will be joined], Type=[exact or scan]". Note that the join expression is automatically escaped before it is sent to the map server.

setJoinTables

public void setJoinTables(java.lang.String jointab)

Set the list of join tables

Parameters:

jointab - List of joined table names separated by blank spaces; for ArcSDE, table name is full name including database name (e.g., DATA.STATE); for shapefiles, names of DBF files without extension (e.g.,STATES).

setSubfields

public void setSubfields(java.lang.String subflds)

Set the list of fields to be extracted

Parameters:

subflds - List of fields to be extracted separated by blank space. If subfields is not used, all fields are returned. If it is used, only listed fields are returned.

getWhereExpression

public java.lang.String getWhereExpression()

Gets the where part of SQL.

Returns:

where Defines where part of SQL expression. Required when jointable attribute for ArcSDE tables is used. Note that the where expression is automatically escaped before it is sent to the map server.

getSpatialFilter

public AimsSpatialFilter getSpatialFilter()

Gets the spatial filter associated with this object, if any.

Returns:

The spatial filter, or null if undefined.

setWhereExpression

public void setWhereExpression(java.lang.String where)

Set the where part of SQL.

Parameters:

where - Defines where part of SQL expression. Required when jointable attribute for ArcSDE tables is used. Note that the where expression is automatically escaped before it is sent to the map server.

setSpatialFilter

public void setSpatialFilter(AimsSpatialFilter spatialFilter)

Sets the spatial query for the filter.

Parameters:

spatialFilter - An AimsSpatialFilter object.

setSpatialFilter

public void setSpatialFilter(AimsShapeObject shape)

Sets the spatial query for the filter using a shape.

Parameters:

shape - A shape object to use to select features. An AimsSpatialFilter object will be created from the specified shape.

setSpatialFilter

public void setSpatialFilter(AimsEnvelope env)

Sets the spatial query for the filter using an envelope.

Parameters:

env - A shape object to use to select features. An AimsSpatialFilter object will be created from the specified shape.

setSpatialFilter

public void setSpatialFilter(AimsPoint pt)

Sets the spatial query for the filter using a point.

Parameters:

pt - A shape object to use to select features. An AimsSpatialFilter object will be created from the specified shape.

setSpatialFilter

public void setSpatialFilter(AimsPoint pt,
                             AimsMap map,
                             double percent)

Sets the spatial query for the filter 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.

toString

public java.lang.String toString()

Returns a text representation of of this class.

Returns:

A string describing the class

toAxlString

public java.lang.String toAxlString()

Returns the AXL string to refresh this object.

Specified by:

toAxlString in interface AimsAxlObject

Returns:

The AXL string to refresh this object.

toAxlString

public java.lang.String toAxlString(AimsEnvironment env)

Returns the AXL string to refresh this object.

Parameters:

env - The environment object containing coordinate separators and other information used to output the correct AXL request.

Returns:

The AXL string to refresh this object.

toAxlString

public java.lang.String toAxlString(AimsEnvironment env,
                                    AimsRecordset rs)

Returns the AXL string to refresh this object.

Parameters:

env - The environment object containing coordinate separators and other information used to output the correct AXL request.

rs - The recordset object, used for combining filters.

Returns:

The AXL string to refresh this object.

toAxlString

public java.lang.String toAxlString(java.lang.String requestType,
                                    AimsEnvironment env,
                                    AimsRecordset rs)

Returns the AXL string to refresh this object.

Parameters:

env - The environment object containing coordinate separators and other information used to output the correct AXL request.

rs - The recordset object, used for combining filters.

Returns:

The AXL string to refresh this object.