com.esri.arcgis.controls
Interface IARSearchDef

All Superinterfaces:

Serializable

All Known Implementing Classes:

ArcReaderSearchDef, IARSearchDefProxy

public interface IARSearchDef
extends Serializable

Provides access to members that control attribute and spatial search definitions.

Description

The IARSearchDef interface is a starting point for defining an attribute or spatial query.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Method Summary

int	getSpatialRelationship() The spatial relationship between the search and target shapes.
String	getWhereClause() A SQL where clause for the search.
void	setARFeatureShape(IARFeature pARFeature, double bufferDistance) Set the search shape to the shape of a feature.
void	setEnvelopeShape(double xMin, double yMin, double xMax, double yMax, double bufferDistance) Set the search shape to an envelope.
void	setPointShape(double xCoord, double yCoord, double bufferDistance) Set the search shape to a point.
void	setSpatialRelationship(int spatialRel) The spatial relationship between the search and target shapes.
void	setWhereClause(String sWhereClause) A SQL where clause for the search.

Method Detail

setPointShape

void setPointShape(double xCoord,
                   double yCoord,
                   double bufferDistance)
                   throws IOException,
                          AutomationException

Set the search shape to a point.

Description

Sets the search geometry of the ArcReaderSearchDef to an point specfied by the xCoord and yCoord coordinates given in IARMap::MapUnits. To buffer the search geometry specify a buffer distance in IARMap::MapUnits. By default the buffer distance is 0.0.

The method specifies the shape against which the ARFeature objects will be tested. Use the SpatialRelationship property to define the relationship between the shape you have specified and the shape of each ARFeature object.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:

xCoord - The xCoord (in)

yCoord - The yCoord (in)

bufferDistance - The bufferDistance (in, optional, pass 0 if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

com.esri.arcgis.publishercontrols.IARSearchDef#setARFeatureShape(com.esri.arcgis.controls.IARFeature, double), com.esri.arcgis.publishercontrols.IARSearchDef#setEnvelopeShape(double, double, double, double, double)

setEnvelopeShape

void setEnvelopeShape(double xMin,
                      double yMin,
                      double xMax,
                      double yMax,
                      double bufferDistance)
                      throws IOException,
                             AutomationException

Set the search shape to an envelope.

Description

Sets the search geometry of the ArcReaderSearchDef to an envelope specfied by the xMin, yMin, xMax, yMax coordinates given in IARMap::MapUnits. To buffer the search geometry specify a buffer distance in IARMap::MapUnits. By default the buffer distance is 0.0.

The method specifies the shape against which the ARFeature objects will be tested. Use the SpatialRelationship property to define the relationship between the shape you have specified and the shape of each ARFeature object.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:

xMin - The xMin (in)

yMin - The yMin (in)

xMax - The xMax (in)

yMax - The yMax (in)

bufferDistance - The bufferDistance (in, optional, pass 0 if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

com.esri.arcgis.publishercontrols.IARSearchDef#setARFeatureShape(com.esri.arcgis.controls.IARFeature, double), com.esri.arcgis.publishercontrols.IARSearchDef#setPointShape(double, double, double)

setARFeatureShape

void setARFeatureShape(IARFeature pARFeature,
                       double bufferDistance)
                       throws IOException,
                              AutomationException

Set the search shape to the shape of a feature.

Description

Sets the search geometry of the ArcReaderSearchDef to the shape of the specified ARFeature. To buffer the search geometry specify a buffer distance in IARMap::MapUnits. By default the buffer distance is 0.0.

The method specifies the shape against which the ARFeature objects will be tested. Use the SpatialRelationship property to define the relationship between the shape you have specified and the shape of each ARFeature object.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:

pARFeature - A reference to a com.esri.arcgis.controls.IARFeature (in)

bufferDistance - The bufferDistance (in, optional, pass 0 if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

com.esri.arcgis.publishercontrols.IARSearchDef#setEnvelopeShape(double, double, double, double, double), com.esri.arcgis.publishercontrols.IARSearchDef#setPointShape(double, double, double)

setSpatialRelationship

void setSpatialRelationship(int spatialRel)
                            throws IOException,
                                   AutomationException

The spatial relationship between the search and target shapes.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:

spatialRel - A com.esri.arcgis.controls.esriARSpatialRelationship constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpatialRelationship

int getSpatialRelationship()
                           throws IOException,
                                  AutomationException

The spatial relationship between the search and target shapes.

Description

The SpatialRelationship the ArcReaderSearchDef is based upon. By default this is an Intersects relationship.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:

A com.esri.arcgis.controls.esriARSpatialRelationship constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWhereClause

void setWhereClause(String sWhereClause)
                    throws IOException,
                           AutomationException

A SQL where clause for the search.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:

sWhereClause - The sWhereClause (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWhereClause

String getWhereClause()
                      throws IOException,
                             AutomationException

A SQL where clause for the search.

Description

To search for a subset of ARFeature objects based upon a particular attribute you need to set the WhereClause property.The WhereClause represents an SQL ‘Where’ clause; the syntax used to specify the WhereClause needs to be the same as that of the underlying database holding the data.

All ARFeature objects within an ARLayer share the same set of attribute schema; that is they have the same set of fields. The SQL string defining the attribute query is based upon one or more fields belonging to an ARFeature and consists of an IARFeature::FieldName, an operator and an IARFeature::Value. Note that these are are case sensitive.

A field that returns an IARFeature::FieldType equal to the esriARFieldTypeGeometry constant cannot be used within the WhereClause, as this field stores the geometry or shape of the ARFeature object.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:

The sWhereClause

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.