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

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

All Implemented Interfaces:

GPTool

public class RemoveRastersFromMosaicDataset
extends AbstractGPTool

Removes rasters from a mosaic dataset. The Remove Rasters From Mosaic Dataset tool is contained in the Data Management Tools tool box.

Usage tips:

• If you don't make a selection or define a query, the mosaic dataset will be emptied.
• You have the option to remove overviews but not to delete them. If the overviews are generated within the mosaic dataset they will be deleted when they are removed, because they are managed by the mosaic dataset. If you have created the overviews in a folder, or nondefault location, they are not fully managed by the mosaic dataset; therefore, you can remove them but not delete them from disk. You may not want to delete overviews if you are using them elsewhere.
• If you choose to mark the affected overviews but not delete them, you can use the to regenerate the affected overviews.

Field Summary

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

vals

Constructor Summary

RemoveRastersFromMosaicDataset()
Creates the Remove Rasters From Mosaic Dataset tool with defaults.

RemoveRastersFromMosaicDataset(Object inMosaicDataset)
Creates the Remove Rasters From Mosaic Dataset tool with the required parameters.

Method Summary

String	getDeleteOverviewImages() Returns the Delete Overview Images parameter of this tool .
Object	getInMosaicDataset() Returns the Mosaic Dataset parameter of this tool .
String	getMarkOverviewsItems() Returns the Mark Affected Overviews parameter of this tool .
Object	getOutMosaicDataset() Returns the Mosaic Dataset parameter of this tool (Read only).
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.
String	getUpdateBoundary() Returns the Update Boundary parameter of this tool .
Object	getWhereClause() Returns the Query Definition parameter of this tool .
void	setDeleteOverviewImages(String deleteOverviewImages) Sets the Delete Overview Images parameter of this tool .
void	setInMosaicDataset(Object inMosaicDataset) Sets the Mosaic Dataset parameter of this tool .
void	setMarkOverviewsItems(String markOverviewsItems) Sets the Mark Affected Overviews parameter of this tool .
void	setUpdateBoundary(String updateBoundary) Sets the Update Boundary 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

RemoveRastersFromMosaicDataset

public RemoveRastersFromMosaicDataset()

Creates the Remove Rasters From Mosaic Dataset tool with defaults.

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

RemoveRastersFromMosaicDataset

public RemoveRastersFromMosaicDataset(Object inMosaicDataset)

Creates the Remove Rasters From 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 to define the raster datasets that will be removed from the mosaic dataset. 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 to define the raster datasets that will be removed from the mosaic dataset. This is an optional parameter.

Parameters:

whereClause - using SQL you can define a query, or use the Query Builder to build a query to define the raster datasets that will be removed from the mosaic dataset.

getUpdateBoundary

public String getUpdateBoundary()

Returns the Update Boundary parameter of this tool . This is an optional parameter.

Returns:

the Update Boundary

setUpdateBoundary

public void setUpdateBoundary(String updateBoundary)

Sets the Update Boundary parameter of this tool . This is an optional parameter.

Parameters:

updateBoundary - null

getMarkOverviewsItems

public String getMarkOverviewsItems()

Returns the Mark Affected Overviews parameter of this tool . This parameter is when the rasters in a mosaic catalog have been removed, any overviews created using those rasters may no longer be accurate, therefore, they can be identified so they can be updated or removed if they are no longer needed. This is an optional parameter.

Returns:

the Mark Affected Overviews

setMarkOverviewsItems

public void setMarkOverviewsItems(String markOverviewsItems)

Sets the Mark Affected Overviews parameter of this tool . This parameter is when the rasters in a mosaic catalog have been removed, any overviews created using those rasters may no longer be accurate, therefore, they can be identified so they can be updated or removed if they are no longer needed. This is an optional parameter.

Parameters:

markOverviewsItems - when the rasters in a mosaic catalog have been removed, any overviews created using those rasters may no longer be accurate, therefore, they can be identified so they can be updated or removed if they are no longer needed.

getDeleteOverviewImages

public String getDeleteOverviewImages()

Returns the Delete Overview Images parameter of this tool . This parameter is any overviews that are no longer required as a result of the source rasters being removed can also be removed from the mosaic dataset. This is an optional parameter.

Returns:

the Delete Overview Images

setDeleteOverviewImages

public void setDeleteOverviewImages(String deleteOverviewImages)

Sets the Delete Overview Images parameter of this tool . This parameter is any overviews that are no longer required as a result of the source rasters being removed can also be removed from the mosaic dataset. This is an optional parameter.

Parameters:

deleteOverviewImages - any overviews that are no longer required as a result of the source rasters being removed can also be removed from the mosaic dataset.

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