com.esri.arcgis.controls
Class ArcReaderSearchDef

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

All Implemented Interfaces:

IARSearchDef, java.io.Serializable

public class ArcReaderSearchDef

extends java.lang.Object

implements IARSearchDef

ArcReaderSearchDef is used to specify spatial and attribute queries.

Product Availability

Available with ArcGIS Engine.

See Also:

Serialized Form

Constructor Summary

ArcReaderSearchDef()
Constructs a ArcReaderSearchDef using ArcGIS Engine.

ArcReaderSearchDef(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
IARSearchDef	getAsIARSearchDef() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
static java.lang.String	getClsid()
int	getSpatialRelationship() The spatial relationship between the search and target shapes.
java.lang.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(java.lang.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

Constructor Detail

ArcReaderSearchDef

public ArcReaderSearchDef()
                   throws java.io.IOException,
                          java.net.UnknownHostException

Constructs a ArcReaderSearchDef using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ArcReaderSearchDef

public ArcReaderSearchDef(java.lang.Object obj)
                   throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

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.
ArcReaderSearchDef theArcReaderSearchDef = (ArcReaderSearchDef) obj;

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getAsIARSearchDef

public IARSearchDef getAsIARSearchDef()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

setPointShape

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

Description copied from interface: IARSearchDef

Set the search shape to a point.

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:

java.io.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 java.io.IOException,
                             AutomationException

Description copied from interface: IARSearchDef

Set the search shape to an envelope.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setARFeatureShape

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

Description copied from interface: IARSearchDef

Set the search shape to the shape of a feature.

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:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setSpatialRelationship

public void setSpatialRelationship(int spatialRel)
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IARSearchDef

The spatial relationship between the search and target shapes.

Specified by:

setSpatialRelationship in interface IARSearchDef

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getSpatialRelationship

public int getSpatialRelationship()
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IARSearchDef

The spatial relationship between the search and target shapes.

Specified by:

getSpatialRelationship in interface IARSearchDef

Returns:

A com.esri.arcgis.controls.esriARSpatialRelationship constant

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setWhereClause

public void setWhereClause(java.lang.String sWhereClause)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IARSearchDef

A SQL where clause for the search.

Specified by:

setWhereClause in interface IARSearchDef

Parameters:

sWhereClause - The sWhereClause (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWhereClause

public java.lang.String getWhereClause()
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: IARSearchDef

A SQL where clause for the search.

Specified by:

getWhereClause in interface IARSearchDef

Returns:

The sWhereClause

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.