com.esri.arcgis.arcweb
Class ArcWebSpatialQueryOptions

java.lang.Object
  com.esri.arcgis.arcweb.ArcWebSpatialQueryOptions

All Implemented Interfaces:

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

public class ArcWebSpatialQueryOptions
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IArcWebSpatialQueryOptions

A set of parameters used by the ArcWebSpatialQuery.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:

Serialized Form

Constructor Summary

ArcWebSpatialQueryOptions()
Constructs a ArcWebSpatialQueryOptions using ArcGIS Engine.

ArcWebSpatialQueryOptions(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ArcWebSpatialQueryOptions theArcWebSpatialQueryOptions = (ArcWebSpatialQueryOptions) obj;

Method Summary

boolean	equals(Object o) Compare this object with another
double	getBufferDistance() The area in which to search for results.
int	getBufferUnits() The units for the buffer distance.
static String	getClsid() getClsid.
String	getDataSource() The name of the data source.
int	getDistanceUnits() The units used to measure the distance from the input search geometry to individual results (default is miles).
IArcWebSearchOptions	getSearchOptions() The parameters defining the search results.
int	hashCode() the hashcode for this object
boolean	isReturnDistance() Indicates if the distances are returned from the input search geometry to the individual results (default is false).
boolean	isReturnGeometry() Indicates if the latitude and longitude values are returned.
void	setBufferDistance(double bufferDistance) The area in which to search for results.
void	setBufferUnits(int distanceUnits) The units for the buffer distance.
void	setDataSource(String dataSource) The name of the data source.
void	setDistanceUnits(int distanceUnits) The units used to measure the distance from the input search geometry to individual results (default is miles).
void	setReturnDistance(boolean returnDistance) Indicates if the distances are returned from the input search geometry to the individual results (default is false).
void	setReturnGeometry(boolean returnGeometry) Indicates if the latitude and longitude values are returned.
void	setSearchOptionsByRef(IArcWebSearchOptions searchOptions) The parameters defining the search results.

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

ArcWebSpatialQueryOptions

public ArcWebSpatialQueryOptions()
                          throws IOException,
                                 UnknownHostException

Constructs a ArcWebSpatialQueryOptions using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ArcWebSpatialQueryOptions

public ArcWebSpatialQueryOptions(Object obj)
                          throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ArcWebSpatialQueryOptions theArcWebSpatialQueryOptions = (ArcWebSpatialQueryOptions) obj;

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

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

getDataSource

public String getDataSource()
                     throws IOException,
                            AutomationException

The name of the data source.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getDataSource in interface IArcWebSpatialQueryOptions

Returns:

The dataSource

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDataSource

public void setDataSource(String dataSource)
                   throws IOException,
                          AutomationException

The name of the data source.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setDataSource in interface IArcWebSpatialQueryOptions

Parameters:

dataSource - The dataSource (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDistanceUnits

public int getDistanceUnits()
                     throws IOException,
                            AutomationException

The units used to measure the distance from the input search geometry to individual results (default is miles).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getDistanceUnits in interface IArcWebSpatialQueryOptions

Returns:

A com.esri.arcgis.arcweb.esriArcWebDistanceUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDistanceUnits

public void setDistanceUnits(int distanceUnits)
                      throws IOException,
                             AutomationException

The units used to measure the distance from the input search geometry to individual results (default is miles).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setDistanceUnits in interface IArcWebSpatialQueryOptions

Parameters:

distanceUnits - A com.esri.arcgis.arcweb.esriArcWebDistanceUnits constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnDistance

public boolean isReturnDistance()
                         throws IOException,
                                AutomationException

Indicates if the distances are returned from the input search geometry to the individual results (default is false).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isReturnDistance in interface IArcWebSpatialQueryOptions

Returns:

The returnDistance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnDistance

public void setReturnDistance(boolean returnDistance)
                       throws IOException,
                              AutomationException

Indicates if the distances are returned from the input search geometry to the individual results (default is false).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setReturnDistance in interface IArcWebSpatialQueryOptions

Parameters:

returnDistance - The returnDistance (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnGeometry

public boolean isReturnGeometry()
                         throws IOException,
                                AutomationException

Indicates if the latitude and longitude values are returned.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isReturnGeometry in interface IArcWebSpatialQueryOptions

Returns:

The returnGeometry

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnGeometry

public void setReturnGeometry(boolean returnGeometry)
                       throws IOException,
                              AutomationException

Indicates if the latitude and longitude values are returned.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setReturnGeometry in interface IArcWebSpatialQueryOptions

Parameters:

returnGeometry - The returnGeometry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSearchOptions

public IArcWebSearchOptions getSearchOptions()
                                      throws IOException,
                                             AutomationException

The parameters defining the search results.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getSearchOptions in interface IArcWebSpatialQueryOptions

Returns:

A reference to a com.esri.arcgis.arcweb.IArcWebSearchOptions

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSearchOptionsByRef

public void setSearchOptionsByRef(IArcWebSearchOptions searchOptions)
                           throws IOException,
                                  AutomationException

The parameters defining the search results.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setSearchOptionsByRef in interface IArcWebSpatialQueryOptions

Parameters:

searchOptions - A reference to a com.esri.arcgis.arcweb.IArcWebSearchOptions (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBufferDistance

public double getBufferDistance()
                         throws IOException,
                                AutomationException

The area in which to search for results.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getBufferDistance in interface IArcWebSpatialQueryOptions

Returns:

The bufferDistance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBufferDistance

public void setBufferDistance(double bufferDistance)
                       throws IOException,
                              AutomationException

The area in which to search for results.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setBufferDistance in interface IArcWebSpatialQueryOptions

Parameters:

bufferDistance - The bufferDistance (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBufferUnits

public int getBufferUnits()
                   throws IOException,
                          AutomationException

The units for the buffer distance.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getBufferUnits in interface IArcWebSpatialQueryOptions

Returns:

A com.esri.arcgis.arcweb.esriArcWebDistanceUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBufferUnits

public void setBufferUnits(int distanceUnits)
                    throws IOException,
                           AutomationException

The units for the buffer distance.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setBufferUnits in interface IArcWebSpatialQueryOptions

Parameters:

distanceUnits - A com.esri.arcgis.arcweb.esriArcWebDistanceUnits constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.