com.esri.core.tasks.ags.identify
Class IdentifyParameters

java.lang.Object
  com.esri.core.tasks.ags.identify.IdentifyParameters

public class IdentifyParameters
extends Object

The Class IdentifyParameters.

Field Summary

static int	ALL_LAYERS Identify on all layers of the service.
static int	TOP_MOST_LAYER Identify only on the top-most layer of the service.
static int	VISIBLE_LAYERS Identify only on the visible layers of the service.

Constructor Summary

IdentifyParameters()
Instantiates a new identify parameters.

Method Summary

int	getDPI() Gets the dpi.
Geometry	getGeometry() Gets the geometry.
int	getLayerMode() Gets the layer mode.
int[]	getLayers() Gets the layers.
Envelope	getMapExtent() Gets the map extent.
int	getMapHeight() Gets the map height.
int	getMapWidth() Gets the map width.
SpatialReference	getSpatialReference() Gets the spatial reference.
int	getTolerance() Gets the tolerance.
boolean	isReturnM() True if M values are to be included in returned geometries.
boolean	isReturnZ() True if Z values included returned geometries.
void	setDPI(int dpi) Sets the dpi.
void	setGeometry(Geometry geometry) Sets the geometry.
void	setLayerMode(int layerMode) Sets the layer mode.
void	setLayers(int[] layers) Sets the layers.
void	setMapExtent(Envelope extent) Sets the map extent.
void	setMapHeight(int height) Sets the map height.
void	setMapWidth(int width) Sets the map width.
void	setReturnM(boolean returnM) Sets to true if M values are to be returned in geometries.
void	setReturnZ(boolean returnZ) Set to true to have Z values returned in geometries.
void	setSpatialReference(SpatialReference spatialReference) Sets the spatial reference.
void	setTolerance(int tolerance) Sets the tolerance.

Methods inherited from class java.lang.Object

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

Field Detail

ALL_LAYERS

public static final int ALL_LAYERS

Identify on all layers of the service.

See Also:

Constant Field Values

VISIBLE_LAYERS

public static final int VISIBLE_LAYERS

Identify only on the visible layers of the service.

See Also:

Constant Field Values

TOP_MOST_LAYER

public static final int TOP_MOST_LAYER

Identify only on the top-most layer of the service.

See Also:

Constant Field Values

Constructor Detail

IdentifyParameters

public IdentifyParameters()

Instantiates a new identify parameters.

Method Detail

setGeometry

public void setGeometry(Geometry geometry)

Sets the geometry.

Parameters:

geometry - the new geometry

getGeometry

public Geometry getGeometry()

Gets the geometry.

Returns:

the geometry

setMapExtent

public void setMapExtent(Envelope extent)

Sets the map extent.

Parameters:

extent - the new map extent

getMapExtent

public Envelope getMapExtent()

Gets the map extent.

Returns:

the map extent

setSpatialReference

public void setSpatialReference(SpatialReference spatialReference)

Sets the spatial reference.

Parameters:

spatialReference - the new spatial reference

getSpatialReference

public SpatialReference getSpatialReference()

Gets the spatial reference.

Returns:

the spatial reference

setLayerMode

public void setLayerMode(int layerMode)

Sets the layer mode.

Parameters:

layerMode - the new layer mode

getLayerMode

public int getLayerMode()

Gets the layer mode.

Returns:

the layer mode

setLayers

public void setLayers(int[] layers)

Sets the layers.

Parameters:

layers - the new layers

getLayers

public int[] getLayers()

Gets the layers.

Returns:

the layers

setMapWidth

public void setMapWidth(int width)

Sets the map width.

Parameters:

width - the new map width

getMapWidth

public int getMapWidth()

Gets the map width.

Returns:

the map width

setMapHeight

public void setMapHeight(int height)

Sets the map height.

Parameters:

height - the new map height

getMapHeight

public int getMapHeight()

Gets the map height.

Returns:

the map height

setDPI

public void setDPI(int dpi)

Sets the dpi.

Parameters:

dpi - the new dpi

getDPI

public int getDPI()

Gets the dpi.

Returns:

the dpi

setTolerance

public void setTolerance(int tolerance)

Sets the tolerance.

Parameters:

tolerance - the new tolerance

getTolerance

public int getTolerance()

Gets the tolerance.

Returns:

the tolerance

isReturnZ

public boolean isReturnZ()

True if Z values included returned geometries.

Returns:

true, if Z values are to be returned.

setReturnZ

public void setReturnZ(boolean returnZ)

Set to true to have Z values returned in geometries.

Parameters:

returnZ - true to have Z values returned.

isReturnM

public boolean isReturnM()

True if M values are to be included in returned geometries.

Returns:

true, if M values are returned.

setReturnM

public void setReturnM(boolean returnM)

Sets to true if M values are to be returned in geometries.

Parameters:

returnM - true to have M values returned.