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

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

All Implemented Interfaces:

GPTool

public class ConsolidateToolbox
extends AbstractGPTool

Consolidates a Toolbox and all tool resources into a specified folder. The Consolidate Toolbox tool is contained in the Data Management Tools tool box.

Usage tips:

• The tool resources that will be consolidated along with your toolbox are: map documents, scripts, layer files, graphic files, and documentation files. Data sets and tables that are referenced or used as parametres in your models or scripts will not be colsoidated.

Field Summary

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

vals

Constructor Summary

ConsolidateToolbox()
Creates the Consolidate Toolbox tool with defaults.

ConsolidateToolbox(Object inToolbox, Object outputFolder)
Creates the Consolidate Toolbox tool with the required parameters.

Method Summary

String	getApplyExtentToArcsde() Returns the Apply Extent to ArcSDE Layers Only parameter of this tool .
String	getConvertArcsdeData() Returns the Convert ArcSDE Data to File Geodatabase parameter of this tool .
String	getConvertData() Returns the Convert Data to File Geodatabase parameter of this tool .
Object	getExtent() Returns the Extent parameter of this tool .
Object	getInToolbox() Returns the Input Toolbox parameter of this tool .
Object	getOutputFolder() Returns the Output Folder 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	setApplyExtentToArcsde(String applyExtentToArcsde) Sets the Apply Extent to ArcSDE Layers Only parameter of this tool .
void	setConvertArcsdeData(String convertArcsdeData) Sets the Convert ArcSDE Data to File Geodatabase parameter of this tool .
void	setConvertData(String convertData) Sets the Convert Data to File Geodatabase parameter of this tool .
void	setExtent(Object extent) Sets the Extent parameter of this tool .
void	setInToolbox(Object inToolbox) Sets the Input Toolbox parameter of this tool .
void	setOutputFolder(Object outputFolder) Sets the Output Folder 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

ConsolidateToolbox

public ConsolidateToolbox()

Creates the Consolidate Toolbox tool with defaults.

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

ConsolidateToolbox

public ConsolidateToolbox(Object inToolbox,
                          Object outputFolder)

Creates the Consolidate Toolbox 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:

inToolbox - null

outputFolder - the output folder that will contain the consolidated toolbox and all corresponding tools and tool resources.

Method Detail

getInToolbox

public Object getInToolbox()

Returns the Input Toolbox parameter of this tool . This is a required parameter.

Returns:

the Input Toolbox

setInToolbox

public void setInToolbox(Object inToolbox)

Sets the Input Toolbox parameter of this tool . This is a required parameter.

Parameters:

inToolbox - null

getOutputFolder

public Object getOutputFolder()

Returns the Output Folder parameter of this tool . This parameter is the output folder that will contain the consolidated toolbox and all corresponding tools and tool resources. This is a required parameter.

Returns:

the Output Folder

setOutputFolder

public void setOutputFolder(Object outputFolder)

Sets the Output Folder parameter of this tool . This parameter is the output folder that will contain the consolidated toolbox and all corresponding tools and tool resources. This is a required parameter.

Parameters:

outputFolder - the output folder that will contain the consolidated toolbox and all corresponding tools and tool resources.

getConvertData

public String getConvertData()

Returns the Convert Data to File Geodatabase parameter of this tool . This parameter is specifies if input toolbox will be converted to a file geodatabase toolbox. This is an optional parameter.

Returns:

the Convert Data to File Geodatabase

setConvertData

public void setConvertData(String convertData)

Sets the Convert Data to File Geodatabase parameter of this tool . This parameter is specifies if input toolbox will be converted to a file geodatabase toolbox. This is an optional parameter.

Parameters:

convertData - specifies if input toolbox will be converted to a file geodatabase toolbox.

getConvertArcsdeData

public String getConvertArcsdeData()

Returns the Convert ArcSDE Data to File Geodatabase parameter of this tool . This parameter is specifies if input layers will be converted into file geodatabase or preserve their original format. This is an optional parameter.

Returns:

the Convert ArcSDE Data to File Geodatabase

setConvertArcsdeData

public void setConvertArcsdeData(String convertArcsdeData)

Sets the Convert ArcSDE Data to File Geodatabase parameter of this tool . This parameter is specifies if input layers will be converted into file geodatabase or preserve their original format. This is an optional parameter.

Parameters:

convertArcsdeData - specifies if input layers will be converted into file geodatabase or preserve their original format.

getExtent

public Object getExtent()

Returns the Extent parameter of this tool . This parameter is specify the extent by manually entering the coordinates in the extent parameter using the format {X-Min Y-Min X-Max Y-Max}. Additionally, to use the extent of a specific layer, simply add the layer name for the extent parameter. for example: ConsolidateToolbox_management("C:/Workspace/parcels.lyr","C:/Workspace/output/parcels.lpk","CONVERT", "CONVERT_SDE", "1556900.00591249 379195.663930234 1753436.4759875 568118.813069764","ALL", "ALL) This is an optional parameter.

Returns:

the Extent

setExtent

public void setExtent(Object extent)

Sets the Extent parameter of this tool . This parameter is specify the extent by manually entering the coordinates in the extent parameter using the format {X-Min Y-Min X-Max Y-Max}. Additionally, to use the extent of a specific layer, simply add the layer name for the extent parameter. for example: ConsolidateToolbox_management("C:/Workspace/parcels.lyr","C:/Workspace/output/parcels.lpk","CONVERT", "CONVERT_SDE", "1556900.00591249 379195.663930234 1753436.4759875 568118.813069764","ALL", "ALL) This is an optional parameter.

Parameters:

extent - specify the extent by manually entering the coordinates in the extent parameter using the format {X-Min Y-Min X-Max Y-Max}. Additionally, to use the extent of a specific layer, simply add the layer name for the extent parameter. for example: ConsolidateToolbox_management("C:/Workspace/parcels.lyr","C:/Workspace/output/parcels.lpk","CONVERT", "CONVERT_SDE", "1556900.00591249 379195.663930234 1753436.4759875 568118.813069764","ALL", "ALL)

getApplyExtentToArcsde

public String getApplyExtentToArcsde()

Returns the Apply Extent to ArcSDE Layers Only parameter of this tool . This parameter is specifies the extent that will be used to select ArcSDE data sources. This is an optional parameter.

Returns:

the Apply Extent to ArcSDE Layers Only

setApplyExtentToArcsde

public void setApplyExtentToArcsde(String applyExtentToArcsde)

Sets the Apply Extent to ArcSDE Layers Only parameter of this tool . This parameter is specifies the extent that will be used to select ArcSDE data sources. This is an optional parameter.

Parameters:

applyExtentToArcsde - specifies the extent that will be used to select ArcSDE data sources.

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