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

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

All Implemented Interfaces:

GPTool

public class SynchronizeMosaicDataset
extends AbstractGPTool

Rebuilds the raster item and updates affected fields in the mosaic dataset using the raster type and options that were used when it was originally added. The Synchronize Mosaic Dataset tool is contained in the Data Management Tools tool box.

Usage tips:

• Use this tool to rebuild selected items in the mosaic dataset using corresponding data source. Since selected items are reconstructed, any modifications made to these items since the last time they were built would be lost.This tool is particularly useful for keeping mosaic datasets up to data, especially those that are populated using tables that reside in an externally managed databases.It is a good idea to create pyramids and stats for all raster datasets referenced by the mosaic dataset.

Field Summary

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

vals

Constructor Summary

SynchronizeMosaicDataset()
Creates the Synchronize Mosaic Dataset tool with defaults.

SynchronizeMosaicDataset(Object inMosaicDataset)
Creates the Synchronize Mosaic Dataset tool with the required parameters.

Method Summary

String	getBuildPyramids() Returns the Build Raster Pyramids parameter of this tool .
String	getBuildThumbnails() Returns the Build Thumbnails parameter of this tool .
String	getCalculateStatistics() Returns the Calculate Statistics 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	getSyncOnlyStale() Returns the Synchronize Stale Items 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	setBuildPyramids(String buildPyramids) Sets the Build Raster Pyramids parameter of this tool .
void	setBuildThumbnails(String buildThumbnails) Sets the Build Thumbnails parameter of this tool .
void	setCalculateStatistics(String calculateStatistics) Sets the Calculate Statistics parameter of this tool .
void	setInMosaicDataset(Object inMosaicDataset) Sets the Mosaic Dataset parameter of this tool .
void	setSyncOnlyStale(String syncOnlyStale) Sets the Synchronize Stale Items 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

SynchronizeMosaicDataset

public SynchronizeMosaicDataset()

Creates the Synchronize Mosaic Dataset tool with defaults.

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

SynchronizeMosaicDataset

public SynchronizeMosaicDataset(Object inMosaicDataset)

Creates the Synchronize Mosaic Dataset 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 mosaic dataset.

Method Detail

getInMosaicDataset

public Object getInMosaicDataset()

Returns the Mosaic Dataset parameter of this tool . This parameter is path and name of 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 mosaic dataset. This is a required parameter.

Parameters:

inMosaicDataset - path and name of 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.

getSyncOnlyStale

public String getSyncOnlyStale()

Returns the Synchronize Stale Items Only parameter of this tool . This parameter is if the base rasters used to create a raster, such as an overview, have been synchronized, then the overview will be updated. This is an optional parameter.

Returns:

the Synchronize Stale Items Only

setSyncOnlyStale

public void setSyncOnlyStale(String syncOnlyStale)

Sets the Synchronize Stale Items Only parameter of this tool . This parameter is if the base rasters used to create a raster, such as an overview, have been synchronized, then the overview will be updated. This is an optional parameter.

Parameters:

syncOnlyStale - if the base rasters used to create a raster, such as an overview, have been synchronized, then the overview will be updated.

getBuildPyramids

public String getBuildPyramids()

Returns the Build Raster Pyramids parameter of this tool . This parameter is pyramids can be built for each raster item in the mosaic dataset. Pyramids can improve the speed at which each raster can be displayed. This is an optional parameter.

Returns:

the Build Raster Pyramids

setBuildPyramids

public void setBuildPyramids(String buildPyramids)

Sets the Build Raster Pyramids parameter of this tool . This parameter is pyramids can be built for each raster item in the mosaic dataset. Pyramids can improve the speed at which each raster can be displayed. This is an optional parameter.

Parameters:

buildPyramids - pyramids can be built for each raster item in the mosaic dataset. Pyramids can improve the speed at which each raster can be displayed.

getCalculateStatistics

public String getCalculateStatistics()

Returns the Calculate Statistics parameter of this tool . This parameter is statistics can be calculated for each raster item in the mosaic dataset. Statistics are requied for your mosaic dataset when performing certain tasks, such as applying a contrast stretch. This is an optional parameter.

Returns:

the Calculate Statistics

setCalculateStatistics

public void setCalculateStatistics(String calculateStatistics)

Sets the Calculate Statistics parameter of this tool . This parameter is statistics can be calculated for each raster item in the mosaic dataset. Statistics are requied for your mosaic dataset when performing certain tasks, such as applying a contrast stretch. This is an optional parameter.

Parameters:

calculateStatistics - statistics can be calculated for each raster item in the mosaic dataset. Statistics are requied for your mosaic dataset when performing certain tasks, such as applying a contrast stretch.

getBuildThumbnails

public String getBuildThumbnails()

Returns the Build Thumbnails parameter of this tool . This parameter is thumbnails are small, highly resampled images that can be created for each raster item in the mosaic definition. Thumbnails can be accessed when the mosaic dataset is accessed as in image service. This is an optional parameter.

Returns:

the Build Thumbnails

setBuildThumbnails

public void setBuildThumbnails(String buildThumbnails)

Sets the Build Thumbnails parameter of this tool . This parameter is thumbnails are small, highly resampled images that can be created for each raster item in the mosaic definition. Thumbnails can be accessed when the mosaic dataset is accessed as in image service. This is an optional parameter.

Parameters:

buildThumbnails - thumbnails are small, highly resampled images that can be created for each raster item in the mosaic definition. Thumbnails can be accessed when the mosaic dataset is accessed as in image service.

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