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

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

All Implemented Interfaces:

GPTool

public class BuildOverviews
extends AbstractGPTool

Defines and generates overviews for a mosaic dataset. The Build Overviews tool is contained in the Data Management Tools tool box.

Usage tips:

• If you need more control over the definition of the overviews, use the first.
• You cannot build overviews for a referenced mosaic dataset.
• By default, the overviews are stored within the geodatabase containing the mosaic dataset. This can be changed by first using the and specifying a location.

Field Summary

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

vals

Constructor Summary

BuildOverviews()
Creates the Build Overviews tool with defaults.

BuildOverviews(Object inMosaicDataset)
Creates the Build Overviews tool with the required parameters.

Method Summary

String	getDefineMissingTiles() Returns the Define Missing Overview Tiles parameter of this tool .
String	getGenerateMissingImages() Returns the Generate Missing Overview Images Only parameter of this tool .
String	getGenerateOverviews() Returns the Generate Overviews parameter of this tool .
Object	getInMosaicDataset() Returns the Mosaic Dataset parameter of this tool .
Object	getOutMosaicDataset() Returns the Mosaic Dataset parameter of this tool (Read only).
String	getRegenerateStaleImages() Returns the Regenerate Stale Overview Images Only 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.
Object	getWhereClause() Returns the Query Definition parameter of this tool .
void	setDefineMissingTiles(String defineMissingTiles) Sets the Define Missing Overview Tiles parameter of this tool .
void	setGenerateMissingImages(String generateMissingImages) Sets the Generate Missing Overview Images Only parameter of this tool .
void	setGenerateOverviews(String generateOverviews) Sets the Generate Overviews parameter of this tool .
void	setInMosaicDataset(Object inMosaicDataset) Sets the Mosaic Dataset parameter of this tool .
void	setRegenerateStaleImages(String regenerateStaleImages) Sets the Regenerate Stale Overview Images Only parameter of this tool .
void	setWhereClause(Object whereClause) Sets the Query Definition 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

BuildOverviews

public BuildOverviews()

Creates the Build Overviews tool with defaults.

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

BuildOverviews

public BuildOverviews(Object inMosaicDataset)

Creates the Build Overviews 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:

inMosaicDataset - path and name of the mosaic dataset.

Method Detail

getInMosaicDataset

public Object getInMosaicDataset()

Returns the Mosaic Dataset parameter of this tool . This parameter is path and name of the mosaic dataset. This is a required parameter.

Returns:

the Mosaic Dataset

setInMosaicDataset

public void setInMosaicDataset(Object inMosaicDataset)

Sets the Mosaic Dataset parameter of this tool . This parameter is path and name of the mosaic dataset. This is a required parameter.

Parameters:

inMosaicDataset - path and name of the mosaic dataset.

getWhereClause

public Object getWhereClause()

Returns the Query Definition parameter of this tool . This parameter is using SQL you can define a query, or use the Query Builder to build a query. This is an optional parameter.

Returns:

the Query Definition

setWhereClause

public void setWhereClause(Object whereClause)

Sets the Query Definition parameter of this tool . This parameter is using SQL you can define a query, or use the Query Builder to build a query. This is an optional parameter.

Parameters:

whereClause - using SQL you can define a query, or use the Query Builder to build a query.

getDefineMissingTiles

public String getDefineMissingTiles()

Returns the Define Missing Overview Tiles parameter of this tool . This parameter is generates overviews if not enough overviews were defined or if new data was added without defining additional overviews. This is an optional parameter.

Returns:

the Define Missing Overview Tiles

setDefineMissingTiles

public void setDefineMissingTiles(String defineMissingTiles)

Sets the Define Missing Overview Tiles parameter of this tool . This parameter is generates overviews if not enough overviews were defined or if new data was added without defining additional overviews. This is an optional parameter.

Parameters:

defineMissingTiles - generates overviews if not enough overviews were defined or if new data was added without defining additional overviews.

getGenerateOverviews

public String getGenerateOverviews()

Returns the Generate Overviews parameter of this tool . This parameter is all overviews that need to be created or recreated will be generated. This includes missing overviews and stale overviews. This is an optional parameter.

Returns:

the Generate Overviews

setGenerateOverviews

public void setGenerateOverviews(String generateOverviews)

Sets the Generate Overviews parameter of this tool . This parameter is all overviews that need to be created or recreated will be generated. This includes missing overviews and stale overviews. This is an optional parameter.

Parameters:

generateOverviews - all overviews that need to be created or recreated will be generated. This includes missing overviews and stale overviews.

getGenerateMissingImages

public String getGenerateMissingImages()

Returns the Generate Missing Overview Images Only parameter of this tool . This parameter is use if overviews have been defined but not generated. This is an optional parameter.

Returns:

the Generate Missing Overview Images Only

setGenerateMissingImages

public void setGenerateMissingImages(String generateMissingImages)

Sets the Generate Missing Overview Images Only parameter of this tool . This parameter is use if overviews have been defined but not generated. This is an optional parameter.

Parameters:

generateMissingImages - use if overviews have been defined but not generated.

getRegenerateStaleImages

public String getRegenerateStaleImages()

Returns the Regenerate Stale Overview Images Only parameter of this tool . This parameter is if the underlying raster datasets have changed or they have had their properties modified, the overviews will be identified as stale. This is an optional parameter.

Returns:

the Regenerate Stale Overview Images Only

setRegenerateStaleImages

public void setRegenerateStaleImages(String regenerateStaleImages)

Sets the Regenerate Stale Overview Images Only parameter of this tool . This parameter is if the underlying raster datasets have changed or they have had their properties modified, the overviews will be identified as stale. This is an optional parameter.

Parameters:

regenerateStaleImages - if the underlying raster datasets have changed or they have had their properties modified, the overviews will be identified as stale.

getOutMosaicDataset

public Object getOutMosaicDataset()

Returns the Mosaic Dataset parameter of this tool (Read only). This is an derived parameter.

Returns:

the Mosaic Dataset

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