com.esri.arcgis.controls
Class ArcReaderSearchDef

java.lang.Object
  com.esri.arcgis.controls.ArcReaderSearchDef

All Implemented Interfaces:

IARSearchDef, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ArcReaderSearchDef
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IARSearchDef

ArcReaderSearchDef is used to specify spatial and attribute queries.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

See Also:

Serialized Form

Constructor Summary

ArcReaderSearchDef()
Constructs a ArcReaderSearchDef using ArcGIS Engine.

ArcReaderSearchDef(Object obj)
Construct a ArcReaderSearchDef using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
int	getSpatialRelationship() The spatial relationship between the search and target shapes.
String	getWhereClause() A SQL where clause for the search.
int	hashCode() the hashcode for this object
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

ArcReaderSearchDef

public ArcReaderSearchDef()
                   throws IOException,
                          UnknownHostException

Constructs a ArcReaderSearchDef using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ArcReaderSearchDef

public ArcReaderSearchDef(Object obj)
                   throws IOException

Construct a ArcReaderSearchDef using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ArcReaderSearchDef.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems ArcReaderSearchDef theArcReaderSearchDef = (ArcReaderSearchDef) obj;

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setPointShape

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

Set the search shape to a point.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

setPointShape in interface IARSearchDef

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.

setEnvelopeShape

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

Set the search shape to an envelope.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

setEnvelopeShape in interface IARSearchDef

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.

setARFeatureShape

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

Set the search shape to the shape of a feature.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

setARFeatureShape in interface IARSearchDef

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.

setSpatialRelationship

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

Specified by:

setSpatialRelationship in interface IARSearchDef

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

public int getSpatialRelationship()
                           throws IOException,
                                  AutomationException

The spatial relationship between the search and target shapes.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getSpatialRelationship in interface IARSearchDef

Returns:

A com.esri.arcgis.controls.esriARSpatialRelationship constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWhereClause

public void setWhereClause(String sWhereClause)
                    throws IOException,
                           AutomationException

A SQL where clause for the search.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

setWhereClause in interface IARSearchDef

Parameters:

sWhereClause - The sWhereClause (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWhereClause

public String getWhereClause()
                      throws IOException,
                             AutomationException

A SQL where clause for the search.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getWhereClause in interface IARSearchDef

Returns:

The sWhereClause

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.