com.esri.arcgis.controls
Class IARSearchDefProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.controls.IARSearchDefProxy

All Implemented Interfaces:

IARSearchDef, Externalizable, Serializable

public class IARSearchDefProxy
extends com.esri.arcgis.interop.Dispatch
implements IARSearchDef, Serializable

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E

Constructor Summary

	IARSearchDefProxy()
	IARSearchDefProxy(Object obj)
protected	IARSearchDefProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
int	getSpatialRelationship() The spatial relationship between the search and target shapes.
String	getWhereClause() A SQL where clause for the search.
void	readExternal(ObjectInput in)
void	removeListener(String iidStr, Object theListener)
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.
void	writeExternal(ObjectOutput out)

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke

Methods inherited from class java.lang.Object

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

Constructor Detail

IARSearchDefProxy

public IARSearchDefProxy()

IARSearchDefProxy

public IARSearchDefProxy(Object obj)
                  throws IOException

Throws:

IOException

IARSearchDefProxy

protected IARSearchDefProxy(Object obj,
                            String iid)
                     throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

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.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

ClassNotFoundException