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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.datamanagementtools.MakeWCSLayer
All Implemented Interfaces:
GPTool

public class MakeWCSLayer
extends AbstractGPTool

Creates a temporary raster layer from a WCS service. The Make WCS Layer tool is contained in the Data Management Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
MakeWCSLayer()
          Creates the Make WCS Layer tool with defaults.
MakeWCSLayer(Object inWcsCoverage, Object outWcsLayer)
          Creates the Make WCS Layer tool with the required parameters.
 
Method Summary
 Object getBandIndex()
          Returns the Bands parameter of this tool .
 Object getInWcsCoverage()
          Returns the Input WCS Coverage parameter of this tool .
 Object getOutWcsLayer()
          Returns the Output WCS 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 setInWcsCoverage(Object inWcsCoverage)
          Sets the Input WCS Coverage parameter of this tool .
 void setOutWcsLayer(Object outWcsLayer)
          Sets the Output WCS 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

MakeWCSLayer

public MakeWCSLayer()
Creates the Make WCS Layer tool with defaults.

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


MakeWCSLayer

public MakeWCSLayer(Object inWcsCoverage,
                    Object outWcsLayer)
Creates the Make WCS 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:
inWcsCoverage - the name of the input WCS service, or the URL that references the WCS service. if a WCS 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 default version (1.0.0) to create the WCS layer. an example of a URL that includes the coverage name and version is below: http://ServerName/arcgis/services/serviceName/ImageServer/WCSServer?coverage=rasterDRGs&version=1.1.1 in this example, "http://ServerName/arcgis/services/serviceName/ImageServer/WCSServer?" is the URL. The coverage specified is "coverage=rasterDRGs", and the version is "&version=1.1.1". to get the coverage names on a WCS server, use the WCS GetCapabilities request. An example of WCS request is http://ServerName/arcgis/services/serviceName/ImageServer/WCSServer?request=getcapabilities&service=wcs
outWcsLayer - the name of the output WCS layer.
Method Detail

getInWcsCoverage

public Object getInWcsCoverage()
Returns the Input WCS Coverage parameter of this tool . This parameter is the name of the input WCS service, or the URL that references the WCS service. if a WCS 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 default version (1.0.0) to create the WCS layer. an example of a URL that includes the coverage name and version is below: http://ServerName/arcgis/services/serviceName/ImageServer/WCSServer?coverage=rasterDRGs&version=1.1.1 in this example, "http://ServerName/arcgis/services/serviceName/ImageServer/WCSServer?" is the URL. The coverage specified is "coverage=rasterDRGs", and the version is "&version=1.1.1". to get the coverage names on a WCS server, use the WCS GetCapabilities request. An example of WCS request is http://ServerName/arcgis/services/serviceName/ImageServer/WCSServer?request=getcapabilities&service=wcs This is a required parameter.

Returns:
the Input WCS Coverage

setInWcsCoverage

public void setInWcsCoverage(Object inWcsCoverage)
Sets the Input WCS Coverage parameter of this tool . This parameter is the name of the input WCS service, or the URL that references the WCS service. if a WCS 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 default version (1.0.0) to create the WCS layer. an example of a URL that includes the coverage name and version is below: http://ServerName/arcgis/services/serviceName/ImageServer/WCSServer?coverage=rasterDRGs&version=1.1.1 in this example, "http://ServerName/arcgis/services/serviceName/ImageServer/WCSServer?" is the URL. The coverage specified is "coverage=rasterDRGs", and the version is "&version=1.1.1". to get the coverage names on a WCS server, use the WCS GetCapabilities request. An example of WCS request is http://ServerName/arcgis/services/serviceName/ImageServer/WCSServer?request=getcapabilities&service=wcs This is a required parameter.

Parameters:
inWcsCoverage - the name of the input WCS service, or the URL that references the WCS service. if a WCS 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 default version (1.0.0) to create the WCS layer. an example of a URL that includes the coverage name and version is below: http://ServerName/arcgis/services/serviceName/ImageServer/WCSServer?coverage=rasterDRGs&version=1.1.1 in this example, "http://ServerName/arcgis/services/serviceName/ImageServer/WCSServer?" is the URL. The coverage specified is "coverage=rasterDRGs", and the version is "&version=1.1.1". to get the coverage names on a WCS server, use the WCS GetCapabilities request. An example of WCS request is http://ServerName/arcgis/services/serviceName/ImageServer/WCSServer?request=getcapabilities&service=wcs

getOutWcsLayer

public Object getOutWcsLayer()
Returns the Output WCS Layer parameter of this tool . This parameter is the name of the output WCS layer. This is a required parameter.

Returns:
the Output WCS Layer

setOutWcsLayer

public void setOutWcsLayer(Object outWcsLayer)
Sets the Output WCS Layer parameter of this tool . This parameter is the name of the output WCS layer. This is a required parameter.

Parameters:
outWcsLayer - the name of the output WCS layer.

getTemplate

public Object getTemplate()
Returns the Template Extent parameter of this tool . This parameter is the output extent of the WCS layer. the output extent can either be specified by defining the area to be clipped (X-Minimum, Y-Minimum, X-Maximum, and 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 WCS layer. the output extent can either be specified by defining the area to be clipped (X-Minimum, Y-Minimum, X-Maximum, and Y-Maximum) or by using the extent of an existing layer. This is an optional parameter.

Parameters:
template - the output extent of the WCS layer. the output extent can either be specified by defining the area to be clipped (X-Minimum, Y-Minimum, X-Maximum, and 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.

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