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

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

All Implemented Interfaces:

GPTool

public class ConsolidateMap
extends AbstractGPTool

Consolidates a map document and all referenced data sources to a specified output folder. The Consolidate Map tool is contained in the Data Management Tools tool box.

Usage tips:

• Map documents that have data sources that reside in a personal geodatabase will be converted to a file geodatabase. All other data sources such as shapefiles, coverages, etc will be added to thefolder.
• If an existing folder is specified as the output folder, all existing content will be deleted and replaced with the content of the consolidated folder or package.
• For layers that contain a join or participate in a relationship class, all joined or related data sources will be consolidated into the output folder.
• For feature layers, the Extent parameter is used tothe features that will be consolidated. For raster layers , the Extent parameter is used tothe raster datasets.
• Every unique data source referenced by the given map document, will have a unique file geodatabase created in the consolidated folder with Convert Data to File Geodatabase checked.
• Compressed raster and vector formats will not be clipped when extent is specified and Convert Data to File Geodatabse is unchecked. To use an extent with compressed data sources, use the Convert options.
• When Convert Data to File Geodatabase is checked:
  • Compressed raster fomats will be converted into a file geodtabase and file geodatabse raster compression will be used.
  • Compressed vector formats such as SDC formats will be converted to file geodatabase features classes and data compression will be lost.
• This tool supports the consolidation of schemas only. The Schema Only parameter, if checked, will consolidate only the schema of the input datasource(s). A Schema is the structure or design of a feature class or table which consists of field and table definitions, coordinate system properties, symbology, defintion queries, etc. Specifying Schema Only will not consolidate any data or records.Consolidating or packaging schemas are useful for sharing editing templates.
• Data sources that do not support Schema only will not be consolidated. If SCHEMA_ONLY is checked and the tool encounters a layer that is not supported for schema only, a warning message will be displayed and that layer will be skipped. If the only layer specified is unsupported for schema only, the tool will complete and no data will get consolidated.
• Consolidating Coverage or VPF layers will copy the entire dataset into the consolidated folder.
• Tools in the package toolset create file geodatabases that are compliant with the current release.

Field Summary

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

vals

Constructor Summary

ConsolidateMap()
Creates the Consolidate Map tool with defaults.

ConsolidateMap(Object inMap, Object outputFolder)
Creates the Consolidate Map 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	getInMap() Returns the Input Map Document 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	setInMap(Object inMap) Sets the Input Map Document 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

ConsolidateMap

public ConsolidateMap()

Creates the Consolidate Map tool with defaults.

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

ConsolidateMap

public ConsolidateMap(Object inMap,
                      Object outputFolder)

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

inMap - the input map document (.mxd) that will be consolidated.

outputFolder - the output folder that will contain the consolidated map document and data.

Method Detail

getInMap

public Object getInMap()

Returns the Input Map Document parameter of this tool . This parameter is the input map document (.mxd) that will be consolidated. This is a required parameter.

Returns:

the Input Map Document

setInMap

public void setInMap(Object inMap)

Sets the Input Map Document parameter of this tool . This parameter is the input map document (.mxd) that will be consolidated. This is a required parameter.

Parameters:

inMap - the input map document (.mxd) that will be consolidated.

getOutputFolder

public Object getOutputFolder()

Returns the Output Folder parameter of this tool . This parameter is the output folder that will contain the consolidated map document and data. 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 map document and data. This is a required parameter.

Parameters:

outputFolder - the output folder that will contain the consolidated map document and data.

getConvertData

public String getConvertData()

Returns the Convert 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 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 layers will be converted into file geodatabase or preserve their original format. This is an optional parameter.

Parameters:

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

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: ConsolidateLayer_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: ConsolidateLayer_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: ConsolidateLayer_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