com.esri.core.map
Class ImageServiceParameters

java.lang.Object
  com.esri.core.map.ImageServiceParameters

All Implemented Interfaces:

Serializable

public class ImageServiceParameters
extends Object
implements Serializable

Represents the image service parameter options used in the ArcGISImageServiceLayer.

Since:

1.0

See Also:

Serialized Form

Nested Class Summary

static class	ImageServiceParameters.IMAGE_FORMAT The format of the exported image.
static class	ImageServiceParameters.PIXEL_TYPE The pixel type, also known as data type, pertains to the type of values stored in the raster, such as signed integer, unsigned integer, or floating point.
static class	ImageServiceParameters.RSP The resampling process of extrapolating the pixel values while transforming the raster dataset when it undergoes warping or when it changes coordinate space.

Constructor Summary

ImageServiceParameters()
Instantiates an object of ImageServiceParameters.

ImageServiceParameters(ImageServiceParameters params)
Copies the properties from the given ImageServiceParameter to the current instance.

Method Summary

boolean	equals(Object obj)
int[]	getBandIds() Gets the bandIds of the ImageServiceParameters.
int	getCompressionQuality() Gets the compressionQuality of the ImageServiceParameters.
ImageServiceParameters.IMAGE_FORMAT	getFormat() Gets the format of the exported image.
ImageServiceParameters.RSP	getInterpolation() Gets the interpolation of the ImageServiceParameters.
MosaicRule	getMosaicRule() Gets the mosaicRule of the ImageServiceParameters.
int	getNoData() Gets the pixel value representing no information.
ImageServiceParameters.PIXEL_TYPE	getPixelType() Gets the pixelType of the ImageServiceParameters.
RasterFunction	getRenderingRule() Gets the renderingRule of the ImageServiceParameters.
int	hashCode()
void	setBandIds(int[] bandIds) Sets the bandIds of the ImageServiceParameters.
void	setCompressionQuality(int compressionQuality) Sets the compressionQuality of the ImageServiceParameters.
void	setFormat(ImageServiceParameters.IMAGE_FORMAT format) Sets the format of the exported image.
void	setInterpolation(ImageServiceParameters.RSP interpolation) Sets the interpolation of the ImageServiceParameters.
void	setMosaicRule(MosaicRule mosaicRule) Sets the mosaicRule of the ImageServiceParameters.
void	setNoData(int noData) Sets the pixel value representing no information.
void	setPixelType(ImageServiceParameters.PIXEL_TYPE pixelType) Sets the pixelType of the ImageServiceParameters.
void	setRenderingRule(RasterFunction renderingRule) Sets the renderingRule of the ImageServiceParameters.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageServiceParameters

public ImageServiceParameters()

Instantiates an object of ImageServiceParameters.

Since:

1.0

ImageServiceParameters

public ImageServiceParameters(ImageServiceParameters params)

Copies the properties from the given ImageServiceParameter to the current instance.

Parameters:

params - the ImageServiceParameter to copy from.

Since:

1.0

Method Detail

getFormat

public ImageServiceParameters.IMAGE_FORMAT getFormat()

Gets the format of the exported image. The default format is jpgpng.

Returns:

Returns the format.

Since:

1.0

setFormat

public void setFormat(ImageServiceParameters.IMAGE_FORMAT format)

Sets the format of the exported image. The default format is jpgpng.

Parameters:

format - The format to set.

Since:

1.0

getPixelType

public ImageServiceParameters.PIXEL_TYPE getPixelType()

Gets the pixelType of the ImageServiceParameters. The pixel type, also known as data type, pertains to the type of values stored in the raster, such as signed integer, unsigned integer, or floating point. Integers are whole numbers, whereas floating points have decimals.

Returns:

Returns the pixelType.

Since:

1.0

setPixelType

public void setPixelType(ImageServiceParameters.PIXEL_TYPE pixelType)

Sets the pixelType of the ImageServiceParameters. The pixel type, also known as data type, pertains to the type of values stored in the raster, such as signed integer, unsigned integer, or floating point. Integers are whole numbers, whereas floating points have decimals.

Parameters:

pixelType - The pixelType to set.

Since:

1.0

getNoData

public int getNoData()

Gets the pixel value representing no information. Example: setNoData(0);

Returns:

Returns the noData.

Since:

1.0

setNoData

public void setNoData(int noData)

Sets the pixel value representing no information. Example: setNoData(0);

Parameters:

noData - The noData to set.

Since:

1.0

getInterpolation

public ImageServiceParameters.RSP getInterpolation()

Gets the interpolation of the ImageServiceParameters. It is the resampling process of extrapolating the pixel values while transforming the raster dataset when it undergoes warping or when it changes coordinate space.

Returns:

Returns the interpolation.

Since:

1.0

setInterpolation

public void setInterpolation(ImageServiceParameters.RSP interpolation)

Sets the interpolation of the ImageServiceParameters. It is the resampling process of extrapolating the pixel values while transforming the raster dataset when it undergoes warping or when it changes coordinate space.

Parameters:

interpolation - The interpolation to set.

Since:

1.0

getCompressionQuality

public int getCompressionQuality()

Gets the compressionQuality of the ImageServiceParameters. It controls how much loss the image will be subjected to by the compression algorithm. Valid value ranges of compression quality are from 0 to 100. Example: setCompressionQuality(75);

Returns:

Returns the compressionQuality.

Since:

1.0

setCompressionQuality

public void setCompressionQuality(int compressionQuality)

Sets the compressionQuality of the ImageServiceParameters. It controls how much loss the image will be subjected to by the compression algorithm. Valid value ranges of compression quality are from 0 to 100. Example: setCompressionQuality(75);

Parameters:

compressionQuality - The compressionQuality to set.

Since:

1.0

getBandIds

public int[] getBandIds()

Gets the bandIds of the ImageServiceParameters. If there are multiple bands, you can specify a single band to export, or you can change the band combination (red, green, blue) by specifying the band number. Band number is 0 based. Example: setBandIds(new int[]{2,1,0});

Returns:

Returns the bandIds.

Since:

1.0

setBandIds

public void setBandIds(int[] bandIds)

Sets the bandIds of the ImageServiceParameters. If there are multiple bands, you can specify a single band to export, or you can change the band combination (red, green, blue) by specifying the band number. Band number is 0 based. Example: setBandIds(new int[]{2,1,0});

Parameters:

bandIds - The bandIds to set.

Since:

1.0

getMosaicRule

public MosaicRule getMosaicRule()

Gets the mosaicRule of the ImageServiceParameters. It specifies the mosaic rule when defining how individual images should be mosaicked. It specifies selection, mosaic method, sort order, overlapping pixel resolution, etc. When mosaic rule is not specified, mosaic rule will default to esriMosaicNone.

Returns:

Returns the mosaicRule.

Since:

1.0

setMosaicRule

public void setMosaicRule(MosaicRule mosaicRule)

Sets the mosaicRule of the ImageServiceParameters. It specifies the mosaic rule when defining how individual images should be mosaicked. It specifies selection, mosaic method, sort order, overlapping pixel resolution, etc. When mosaic rule is not specified, mosaic rule will default to esriMosaicNone.

Parameters:

mosaicRule - The mosaicRule to set.

Since:

1.0

getRenderingRule

public RasterFunction getRenderingRule()

Gets the renderingRule of the ImageServiceParameters. It specifies the rendering rule for how the requested image should be rendered.

Returns:

Returns the renderingRule.

Since:

1.0

setRenderingRule

public void setRenderingRule(RasterFunction renderingRule)

Sets the renderingRule of the ImageServiceParameters. It specifies the rendering rule for how the requested image should be rendered.

Parameters:

renderingRule - The renderingRule to set.

Since:

1.0

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Since:

1.0

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

Since:

1.0

toString

public String toString()

Overrides:

toString in class Object

Since:

1.0