com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class MakeImageServerLayer

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.MakeImageServerLayer

All Implemented Interfaces:

GPTool

public class MakeImageServerLayer
extends AbstractGPTool

Creates a temporary raster layer from an image service. The layer that is created will not persist after the session ends unless the document is saved. The Make Image Server Layer tool is contained in the Data Management Tools tool box.

Usage tips:

• Use this tool to create an image layer from an image service, or a URL that references an image service.
• If an image server URL is used, the URL should include the coverage name and version information. If only URL is entered, the tool will automatically take the first coverage and use the default version (1.0.0) to create the image layer.
• The output can be the entire image service or a portion of it.
• You can clip out a portion of the image service by choosing an output extent layer or by specifying the rectangle extent. If you choose an output extent layer, the clip extent will be based upon the extent of that layer.
• The output can be created with only a subset of the bands. This will help save on time and disk space.
• The mosaicking options are only available when the image service it contains is generated from a mosaic definition or image service definition.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

MakeImageServerLayer()
Creates the Make Image Server Layer tool with defaults.

MakeImageServerLayer(Object inImageService, Object outImageserverLayer)
Creates the Make Image Server Layer tool with the required parameters.

Method Summary

Object	getBandIndex() Returns the Bands parameter of this tool .
Object	getInImageService() Returns the Input Image Service parameter of this tool .
String	getLockRasterid() Returns the Lock Raster ID parameter of this tool .
String	getMosaicMethod() Returns the Mosaic Method parameter of this tool .
String	getOrderBaseValue() Returns the Order Base Value parameter of this tool .
String	getOrderField() Returns the Order Field parameter of this tool .
Object	getOutImageserverLayer() Returns the Output Image Server Layer parameter of this tool .
Object	getTemplate() Returns the Template Extent parameter of this tool .
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
void	setBandIndex(Object bandIndex) Sets the Bands parameter of this tool .
void	setInImageService(Object inImageService) Sets the Input Image Service parameter of this tool .
void	setLockRasterid(String lockRasterid) Sets the Lock Raster ID parameter of this tool .
void	setMosaicMethod(String mosaicMethod) Sets the Mosaic Method parameter of this tool .
void	setOrderBaseValue(String orderBaseValue) Sets the Order Base Value parameter of this tool .
void	setOrderField(String orderField) Sets the Order Field parameter of this tool .
void	setOutImageserverLayer(Object outImageserverLayer) Sets the Output Image Server Layer parameter of this tool .
void	setTemplate(Object template) Sets the Template Extent parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

MakeImageServerLayer

public MakeImageServerLayer()

Creates the Make Image Server Layer tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

MakeImageServerLayer

public MakeImageServerLayer(Object inImageService,
                            Object outImageserverLayer)

Creates the Make Image Server Layer tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

inImageService - the name of the input image service, or the URL that references the image service. if an image server URL is used, the URL should include the coverage name and version information. If only URL is entered, the tool will automatically take the first coverage and use the default version (1.0.0) to create the image layer. an example of a URL that includes the coverage name and version is below: http://AGSServer/arcgis/services/ISName/ImageServer?coverage=rasterDRGs&version=1.1.1 in this example, "http://AGSServer/arcgis/services/ISName/ImageServer?" is the URL. The coverage specified is "coverage=rasterDRGs", and the version is "&version=1.1.1".

outImageserverLayer - the name of the output image layer.

Method Detail

getInImageService

public Object getInImageService()

Returns the Input Image Service parameter of this tool . This parameter is the name of the input image service, or the URL that references the image service. if an image server URL is used, the URL should include the coverage name and version information. If only URL is entered, the tool will automatically take the first coverage and use the default version (1.0.0) to create the image layer. an example of a URL that includes the coverage name and version is below: http://AGSServer/arcgis/services/ISName/ImageServer?coverage=rasterDRGs&version=1.1.1 in this example, "http://AGSServer/arcgis/services/ISName/ImageServer?" is the URL. The coverage specified is "coverage=rasterDRGs", and the version is "&version=1.1.1". This is a required parameter.

Returns:

the Input Image Service

setInImageService

public void setInImageService(Object inImageService)

Sets the Input Image Service parameter of this tool . This parameter is the name of the input image service, or the URL that references the image service. if an image server URL is used, the URL should include the coverage name and version information. If only URL is entered, the tool will automatically take the first coverage and use the default version (1.0.0) to create the image layer. an example of a URL that includes the coverage name and version is below: http://AGSServer/arcgis/services/ISName/ImageServer?coverage=rasterDRGs&version=1.1.1 in this example, "http://AGSServer/arcgis/services/ISName/ImageServer?" is the URL. The coverage specified is "coverage=rasterDRGs", and the version is "&version=1.1.1". This is a required parameter.

Parameters:

inImageService - the name of the input image service, or the URL that references the image service. if an image server URL is used, the URL should include the coverage name and version information. If only URL is entered, the tool will automatically take the first coverage and use the default version (1.0.0) to create the image layer. an example of a URL that includes the coverage name and version is below: http://AGSServer/arcgis/services/ISName/ImageServer?coverage=rasterDRGs&version=1.1.1 in this example, "http://AGSServer/arcgis/services/ISName/ImageServer?" is the URL. The coverage specified is "coverage=rasterDRGs", and the version is "&version=1.1.1".

getOutImageserverLayer

public Object getOutImageserverLayer()

Returns the Output Image Server Layer parameter of this tool . This parameter is the name of the output image layer. This is a required parameter.

Returns:

the Output Image Server Layer

setOutImageserverLayer

public void setOutImageserverLayer(Object outImageserverLayer)

Sets the Output Image Server Layer parameter of this tool . This parameter is the name of the output image layer. This is a required parameter.

Parameters:

outImageserverLayer - the name of the output image layer.

getTemplate

public Object getTemplate()

Returns the Template Extent parameter of this tool . This parameter is the output extent of the image layer. the output extent can either be specified by defining the area to be clipped (X-Minimum, Y-Minimum, X-Maximum, Y-Maximum) or by using the extent of an existing layer. This is an optional parameter.

Returns:

the Template Extent

setTemplate

public void setTemplate(Object template)

Sets the Template Extent parameter of this tool . This parameter is the output extent of the image layer. the output extent can either be specified by defining the area to be clipped (X-Minimum, Y-Minimum, X-Maximum, Y-Maximum) or by using the extent of an existing layer. This is an optional parameter.

Parameters:

template - the output extent of the image layer. the output extent can either be specified by defining the area to be clipped (X-Minimum, Y-Minimum, X-Maximum, Y-Maximum) or by using the extent of an existing layer.

getBandIndex

public Object getBandIndex()

Returns the Bands parameter of this tool . This parameter is choose which bands to export for the layer. If no bands are specified, then all the bands will be used in the output. This is an optional parameter.

Returns:

the Bands

setBandIndex

public void setBandIndex(Object bandIndex)

Sets the Bands parameter of this tool . This parameter is choose which bands to export for the layer. If no bands are specified, then all the bands will be used in the output. This is an optional parameter.

Parameters:

bandIndex - choose which bands to export for the layer. If no bands are specified, then all the bands will be used in the output.

getMosaicMethod

public String getMosaicMethod()

Returns the Mosaic Method parameter of this tool . This parameter is the mosaic method defines how the mosaic is created from different rasters. an image returned to the client can be created from a number of input rasters. The mosaic process has two default options available. This is an optional parameter.

Returns:

the Mosaic Method

setMosaicMethod

public void setMosaicMethod(String mosaicMethod)

Sets the Mosaic Method parameter of this tool . This parameter is the mosaic method defines how the mosaic is created from different rasters. an image returned to the client can be created from a number of input rasters. The mosaic process has two default options available. This is an optional parameter.

Parameters:

mosaicMethod - the mosaic method defines how the mosaic is created from different rasters. an image returned to the client can be created from a number of input rasters. The mosaic process has two default options available.

getOrderField

public String getOrderField()

Returns the Order Field parameter of this tool . This parameter is the default field to use to order the rasters when the mosaic method is ByAttribute. The list of fields is defined as those in the service table that are of type metadata and are integer (for example, the values can represent dates or cloud cover percentage). This is an optional parameter.

Returns:

the Order Field

setOrderField

public void setOrderField(String orderField)

Sets the Order Field parameter of this tool . This parameter is the default field to use to order the rasters when the mosaic method is ByAttribute. The list of fields is defined as those in the service table that are of type metadata and are integer (for example, the values can represent dates or cloud cover percentage). This is an optional parameter.

Parameters:

orderField - the default field to use to order the rasters when the mosaic method is ByAttribute. The list of fields is defined as those in the service table that are of type metadata and are integer (for example, the values can represent dates or cloud cover percentage).

getOrderBaseValue

public String getOrderBaseValue()

Returns the Order Base Value parameter of this tool . This parameter is the images are sorted based on the difference between this input value and attribute value in the specified field. This is an optional parameter.

Returns:

the Order Base Value

setOrderBaseValue

public void setOrderBaseValue(String orderBaseValue)

Sets the Order Base Value parameter of this tool . This parameter is the images are sorted based on the difference between this input value and attribute value in the specified field. This is an optional parameter.

Parameters:

orderBaseValue - the images are sorted based on the difference between this input value and attribute value in the specified field.

getLockRasterid

public String getLockRasterid()

Returns the Lock Raster ID parameter of this tool . This parameter is raster ID or raster name to which the service should be locked, such that only the specified rasters are displayed. If left blank (undefined), it will be similar to system default. Multiple IDs can be defined as a semicolon-delimited list. This is an optional parameter.

Returns:

the Lock Raster ID

setLockRasterid

public void setLockRasterid(String lockRasterid)

Sets the Lock Raster ID parameter of this tool . This parameter is raster ID or raster name to which the service should be locked, such that only the specified rasters are displayed. If left blank (undefined), it will be similar to system default. Multiple IDs can be defined as a semicolon-delimited list. This is an optional parameter.

Parameters:

lockRasterid - raster ID or raster name to which the service should be locked, such that only the specified rasters are displayed. If left blank (undefined), it will be similar to system default. Multiple IDs can be defined as a semicolon-delimited list.

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias