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

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

All Implemented Interfaces:

GPTool

public class ImportMosaicDatasetGeometry
extends AbstractGPTool

Modifies the feature geometry for footprints, the boundary, or seamlines in a mosaic dataset to match those in a polygon feature class. The Import Mosaic Dataset Geometry tool is contained in the Data Management Tools tool box.

Usage tips:

• This tool matches the feature in the mosaic dataset with the feature in the feature class based on a common attribute field.
• The footprint is not always used to clip the image in the mosaic dataset. You can change the Always Clip The ImageTo Its Footprint property to Yes in the Mosaic Dataset Properties dialog box on the Defaults tab.

Field Summary

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

vals

Constructor Summary

ImportMosaicDatasetGeometry()
Creates the Import Mosaic Dataset Geometry tool with defaults.

ImportMosaicDatasetGeometry(Object inMosaicDataset, String targetFeatureclassType, Object targetJoinField, Object inputFeatureclass, Object inputJoinField)
Creates the Import Mosaic Dataset Geometry tool with the required parameters.

Method Summary

Object	getInMosaicDataset() Returns the Mosaic Dataset parameter of this tool .
Object	getInputFeatureclass() Returns the Input Feature Class parameter of this tool .
Object	getInputJoinField() Returns the Input Join Field parameter of this tool .
Object	getOutMosaicDataset() Returns the Mosaic Dataset parameter of this tool (Read only).
String	getTargetFeatureclassType() Returns the Target Feature Class parameter of this tool .
Object	getTargetJoinField() Returns the Target Join Field 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.
void	setInMosaicDataset(Object inMosaicDataset) Sets the Mosaic Dataset parameter of this tool .
void	setInputFeatureclass(Object inputFeatureclass) Sets the Input Feature Class parameter of this tool .
void	setInputJoinField(Object inputJoinField) Sets the Input Join Field parameter of this tool .
void	setTargetFeatureclassType(String targetFeatureclassType) Sets the Target Feature Class parameter of this tool .
void	setTargetJoinField(Object targetJoinField) Sets the Target Join Field 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

ImportMosaicDatasetGeometry

public ImportMosaicDatasetGeometry()

Creates the Import Mosaic Dataset Geometry tool with defaults.

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

ImportMosaicDatasetGeometry

public ImportMosaicDatasetGeometry(Object inMosaicDataset,
                                   String targetFeatureclassType,
                                   Object targetJoinField,
                                   Object inputFeatureclass,
                                   Object inputJoinField)

Creates the Import Mosaic Dataset Geometry 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.

targetFeatureclassType - the polygon feature class in the mosaic dataset whose geometry will be replaced.

targetJoinField - field in the mosaic dataset that will link to correct geometry in the input feature class.

inputFeatureclass - the polygon feature class with the new geometry for the mosaic dataset.

inputJoinField - field in the input feature class that will link to the correct row in the 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.

getTargetFeatureclassType

public String getTargetFeatureclassType()

Returns the Target Feature Class parameter of this tool . This parameter is the polygon feature class in the mosaic dataset whose geometry will be replaced. This is a required parameter.

Returns:

the Target Feature Class

setTargetFeatureclassType

public void setTargetFeatureclassType(String targetFeatureclassType)

Sets the Target Feature Class parameter of this tool . This parameter is the polygon feature class in the mosaic dataset whose geometry will be replaced. This is a required parameter.

Parameters:

targetFeatureclassType - the polygon feature class in the mosaic dataset whose geometry will be replaced.

getTargetJoinField

public Object getTargetJoinField()

Returns the Target Join Field parameter of this tool . This parameter is field in the mosaic dataset that will link to correct geometry in the input feature class. This is a required parameter.

Returns:

the Target Join Field

setTargetJoinField

public void setTargetJoinField(Object targetJoinField)

Sets the Target Join Field parameter of this tool . This parameter is field in the mosaic dataset that will link to correct geometry in the input feature class. This is a required parameter.

Parameters:

targetJoinField - field in the mosaic dataset that will link to correct geometry in the input feature class.

getInputFeatureclass

public Object getInputFeatureclass()

Returns the Input Feature Class parameter of this tool . This parameter is the polygon feature class with the new geometry for the mosaic dataset. This is a required parameter.

Returns:

the Input Feature Class

setInputFeatureclass

public void setInputFeatureclass(Object inputFeatureclass)

Sets the Input Feature Class parameter of this tool . This parameter is the polygon feature class with the new geometry for the mosaic dataset. This is a required parameter.

Parameters:

inputFeatureclass - the polygon feature class with the new geometry for the mosaic dataset.

getInputJoinField

public Object getInputJoinField()

Returns the Input Join Field parameter of this tool . This parameter is field in the input feature class that will link to the correct row in the mosaic dataset. This is a required parameter.

Returns:

the Input Join Field

setInputJoinField

public void setInputJoinField(Object inputJoinField)

Sets the Input Join Field parameter of this tool . This parameter is field in the input feature class that will link to the correct row in the mosaic dataset. This is a required parameter.

Parameters:

inputJoinField - field in the input feature class that will link to the correct row in 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