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

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

public class BuildPyramidsandStatistics
extends AbstractGPTool

Traverses a folder structure, building pyramids and calculating statistics for all the raster datasets it contains. It can also build pyramids and calculate statistics for all the items in a raster catalog or mosaic dataset. The Build Pyramids And Statistics 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
BuildPyramidsandStatistics()
          Creates the Build Pyramids And Statistics tool with defaults.
BuildPyramidsandStatistics(java.lang.Object inWorkspace)
          Creates the Build Pyramids And Statistics tool with the required parameters.
 
Method Summary
 java.lang.String getBUILDONSOURCE()
          Returns the Include Source Datasets parameter of this tool .
 java.lang.String getBuildPyramids()
          Returns the Build Pyramids parameter of this tool .
 java.lang.String getCalculateStatistics()
          Returns the Calculate Statistics parameter of this tool .
 java.lang.String getIncludeSubdirectories()
          Returns the Include Sub-directories parameter of this tool .
 java.lang.Object getInWorkspace()
          Returns the Input Data or Workspace parameter of this tool .
 java.lang.Object getOutWorkspace()
          Returns the Output Workspace parameter of this tool (Read only).
 java.lang.String getToolboxAlias()
          Returns the alias of the tool box containing this tool.
 java.lang.String getToolboxName()
          Returns the name of the tool box containing this tool.
 java.lang.String getToolName()
          Returns the name of this tool.
 void setBUILDONSOURCE(java.lang.String bUILDONSOURCE)
          Sets the Include Source Datasets parameter of this tool .
 void setBuildPyramids(java.lang.String buildPyramids)
          Sets the Build Pyramids parameter of this tool .
 void setCalculateStatistics(java.lang.String calculateStatistics)
          Sets the Calculate Statistics parameter of this tool .
 void setIncludeSubdirectories(java.lang.String includeSubdirectories)
          Sets the Include Sub-directories parameter of this tool .
 void setInWorkspace(java.lang.Object inWorkspace)
          Sets the Input Data or Workspace 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

BuildPyramidsandStatistics

public BuildPyramidsandStatistics()
Creates the Build Pyramids And Statistics tool with defaults.

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


BuildPyramidsandStatistics

public BuildPyramidsandStatistics(java.lang.Object inWorkspace)
Creates the Build Pyramids And Statistics 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:
inWorkspace - the workspace that contains all the raster datasets to be processed. raster catalogs and mosaic datasets must be specified as the input workspace. If the workspace includes a raster catalog or mosaic dataset, then these items will not be included when the tool runs.
Method Detail

getInWorkspace

public java.lang.Object getInWorkspace()
Returns the Input Data or Workspace parameter of this tool . This parameter is the workspace that contains all the raster datasets to be processed. raster catalogs and mosaic datasets must be specified as the input workspace. If the workspace includes a raster catalog or mosaic dataset, then these items will not be included when the tool runs. This is a required parameter.

Returns:
the Input Data or Workspace

setInWorkspace

public void setInWorkspace(java.lang.Object inWorkspace)
Sets the Input Data or Workspace parameter of this tool . This parameter is the workspace that contains all the raster datasets to be processed. raster catalogs and mosaic datasets must be specified as the input workspace. If the workspace includes a raster catalog or mosaic dataset, then these items will not be included when the tool runs. This is a required parameter.

Parameters:
inWorkspace - the workspace that contains all the raster datasets to be processed. raster catalogs and mosaic datasets must be specified as the input workspace. If the workspace includes a raster catalog or mosaic dataset, then these items will not be included when the tool runs.

getIncludeSubdirectories

public java.lang.String getIncludeSubdirectories()
Returns the Include Sub-directories parameter of this tool . This parameter is specify whether to include subdirectories. raster catalogs and mosaic datasets must be specified as the input workspace. If the workspace includes a raster catalog or mosaic dataset, then these items will not be included when the tool runs. This is an optional parameter.

Returns:
the Include Sub-directories

setIncludeSubdirectories

public void setIncludeSubdirectories(java.lang.String includeSubdirectories)
Sets the Include Sub-directories parameter of this tool . This parameter is specify whether to include subdirectories. raster catalogs and mosaic datasets must be specified as the input workspace. If the workspace includes a raster catalog or mosaic dataset, then these items will not be included when the tool runs. This is an optional parameter.

Parameters:
includeSubdirectories - specify whether to include subdirectories. raster catalogs and mosaic datasets must be specified as the input workspace. If the workspace includes a raster catalog or mosaic dataset, then these items will not be included when the tool runs.

getBuildPyramids

public java.lang.String getBuildPyramids()
Returns the Build Pyramids parameter of this tool . This parameter is specify whether to build pyramids. This is an optional parameter.

Returns:
the Build Pyramids

setBuildPyramids

public void setBuildPyramids(java.lang.String buildPyramids)
Sets the Build Pyramids parameter of this tool . This parameter is specify whether to build pyramids. This is an optional parameter.

Parameters:
buildPyramids - specify whether to build pyramids.

getCalculateStatistics

public java.lang.String getCalculateStatistics()
Returns the Calculate Statistics parameter of this tool . This parameter is specify whether to calculate statistics. This is an optional parameter.

Returns:
the Calculate Statistics

setCalculateStatistics

public void setCalculateStatistics(java.lang.String calculateStatistics)
Sets the Calculate Statistics parameter of this tool . This parameter is specify whether to calculate statistics. This is an optional parameter.

Parameters:
calculateStatistics - specify whether to calculate statistics.

getBUILDONSOURCE

public java.lang.String getBUILDONSOURCE()
Returns the Include Source Datasets parameter of this tool . This is an optional parameter.

Returns:
the Include Source Datasets

setBUILDONSOURCE

public void setBUILDONSOURCE(java.lang.String bUILDONSOURCE)
Sets the Include Source Datasets parameter of this tool . This is an optional parameter.

Parameters:
bUILDONSOURCE - null

getOutWorkspace

public java.lang.Object getOutWorkspace()
Returns the Output Workspace parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Workspace

getToolName

public java.lang.String getToolName()
Returns the name of this tool.

Returns:
the tool name

getToolboxName

public java.lang.String getToolboxName()
Returns the name of the tool box containing this tool.

Returns:
the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()
Returns the alias of the tool box containing this tool.

Returns:
the tool box alias