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

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

All Implemented Interfaces:

GPTool

public class BuildBoundary
extends AbstractGPTool

Generates the boundary polygon for a mosaic dataset. By default, the boundary merges all the footprint polygons to create a single boundary representing the extent of the valid pixels. The Build Boundary tool is contained in the Data Management Tools tool box.

Usage tips:

• Boundaries can only be generated for mosaic datasets stored within a geodatabase.
• If you remove or add rasters, or modify the extent of the footprints, you should use this tool to rebuild the boundary.
• If you modify the shape of the boundary polygon (using editing tools), you can use this tool to rebuild the boundary to its unmodified shape.
• Use the Append To Existing Boundary option to only update the boundary where newly added footprints exist. Since the entire boundary is not recalculated, it will save time.

Field Summary

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

vals

Constructor Summary

BuildBoundary()
Creates the Build Boundary tool with defaults.

BuildBoundary(Object inMosaicDataset)
Creates the Build Boundary tool with the required parameters.

Method Summary

String	getAppendToExisting() Returns the Append To Existing Boundary 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	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	setAppendToExisting(String appendToExisting) Sets the Append To Existing Boundary parameter of this tool .
void	setInMosaicDataset(Object inMosaicDataset) Sets the Mosaic Dataset 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

BuildBoundary

public BuildBoundary()

Creates the Build Boundary tool with defaults.

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

BuildBoundary

public BuildBoundary(Object inMosaicDataset)

Creates the Build Boundary 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 mosaic dataset for which the boundary will be calculated.

Method Detail

getInMosaicDataset

public Object getInMosaicDataset()

Returns the Mosaic Dataset parameter of this tool . This parameter is the mosaic dataset for which the boundary will be calculated. 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 mosaic dataset for which the boundary will be calculated. This is a required parameter.

Parameters:

inMosaicDataset - the mosaic dataset for which the boundary will be calculated.

getWhereClause

public Object getWhereClause()

Returns the Query Definition parameter of this tool . This parameter is enter an SQL query if you would like to create a subset of the data, based on attributes. 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 enter an SQL query if you would like to create a subset of the data, based on attributes. This is an optional parameter.

Parameters:

whereClause - enter an SQL query if you would like to create a subset of the data, based on attributes.

getAppendToExisting

public String getAppendToExisting()

Returns the Append To Existing Boundary parameter of this tool . This parameter is when footprints have been selected, this option determines how the boundary will be modified. This is an optional parameter.

Returns:

the Append To Existing Boundary

setAppendToExisting

public void setAppendToExisting(String appendToExisting)

Sets the Append To Existing Boundary parameter of this tool . This parameter is when footprints have been selected, this option determines how the boundary will be modified. This is an optional parameter.

Parameters:

appendToExisting - when footprints have been selected, this option determines how the boundary will be modified.

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