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

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

public class ComputeDirtyArea
extends AbstractGPTool

Identifies an area within a mosaic dataset that has changed since a specified point in time. The Compute Dirty Area 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
ComputeDirtyArea()
          Creates the Compute Dirty Area tool with defaults.
ComputeDirtyArea(Object inMosaicDataset, String timestamp, Object outFeatureClass)
          Creates the Compute Dirty Area tool with the required parameters.
 
Method Summary
 Object getInMosaicDataset()
          Returns the Mosaic Dataset parameter of this tool .
 Object getOutFeatureClass()
          Returns the Output Feature Class parameter of this tool .
 String getTimestamp()
          Returns the Start Date and Time 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 setInMosaicDataset(Object inMosaicDataset)
          Sets the Mosaic Dataset parameter of this tool .
 void setOutFeatureClass(Object outFeatureClass)
          Sets the Output Feature Class parameter of this tool .
 void setTimestamp(String timestamp)
          Sets the Start Date and Time 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

ComputeDirtyArea

public ComputeDirtyArea()
Creates the Compute Dirty Area tool with defaults.

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


ComputeDirtyArea

public ComputeDirtyArea(Object inMosaicDataset,
                        String timestamp,
                        Object outFeatureClass)
Creates the Compute Dirty Area 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 - the input mosaic dataset.
timestamp - specify a date and time. All mosaic items modified after this date will be used to compute the dirty area. currently there are two types of date formats supported: for more information about the formating of the time string, please refer to the Usage Tips.
  • XML time syntax:
  • Non-XML time syntax: 2002/12/25 23:59:58.123
outFeatureClass - the output feature class where the dirty area polygons will be created.
Method Detail

getInMosaicDataset

public Object getInMosaicDataset()
Returns the Mosaic Dataset parameter of this tool . This parameter is the input 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 the input mosaic dataset. This is a required parameter.

Parameters:
inMosaicDataset - the input mosaic dataset.

getWhereClause

public Object getWhereClause()
Returns the Query Definition parameter of this tool . This parameter is an optional SQL query that can be specified to only process a specific subset of data. 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 an optional SQL query that can be specified to only process a specific subset of data. This is an optional parameter.

Parameters:
whereClause - an optional SQL query that can be specified to only process a specific subset of data.

getTimestamp

public String getTimestamp()
Returns the Start Date and Time parameter of this tool . This parameter is specify a date and time. All mosaic items modified after this date will be used to compute the dirty area. currently there are two types of date formats supported: for more information about the formating of the time string, please refer to the Usage Tips. This is a required parameter.

Returns:
the Start Date and Time

setTimestamp

public void setTimestamp(String timestamp)
Sets the Start Date and Time parameter of this tool . This parameter is specify a date and time. All mosaic items modified after this date will be used to compute the dirty area. currently there are two types of date formats supported: for more information about the formating of the time string, please refer to the Usage Tips. This is a required parameter.

Parameters:
timestamp - specify a date and time. All mosaic items modified after this date will be used to compute the dirty area. currently there are two types of date formats supported: for more information about the formating of the time string, please refer to the Usage Tips.
  • XML time syntax:
  • Non-XML time syntax: 2002/12/25 23:59:58.123

getOutFeatureClass

public Object getOutFeatureClass()
Returns the Output Feature Class parameter of this tool . This parameter is the output feature class where the dirty area polygons will be created. This is a required parameter.

Returns:
the Output Feature Class

setOutFeatureClass

public void setOutFeatureClass(Object outFeatureClass)
Sets the Output Feature Class parameter of this tool . This parameter is the output feature class where the dirty area polygons will be created. This is a required parameter.

Parameters:
outFeatureClass - the output feature class where the dirty area polygons will be created.

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