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

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

public class PackageMap
extends AbstractGPTool

Packages a map document and all referenced data sources to create a single compressed .mpk file. The Package Map 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
PackageMap()
          Creates the Package Map tool with defaults.
PackageMap(Object inMap, Object outputFile)
          Creates the Package 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 getOutputFile()
          Returns the Output File 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 getVersion()
          Returns the Package version parameter 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 setOutputFile(Object outputFile)
          Sets the Output File parameter of this tool .
 void setVersion(Object version)
          Sets the Package version 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

PackageMap

public PackageMap()
Creates the Package Map tool with defaults.

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


PackageMap

public PackageMap(Object inMap,
                  Object outputFile)
Creates the Package 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 that will be packaged.
outputFile - the name and location of the output map package (.mpk).
Method Detail

getInMap

public Object getInMap()
Returns the Input Map Document parameter of this tool . This parameter is the input map document that will be packaged. 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 that will be packaged. This is a required parameter.

Parameters:
inMap - the input map document that will be packaged.

getOutputFile

public Object getOutputFile()
Returns the Output File parameter of this tool . This parameter is the name and location of the output map package (.mpk). This is a required parameter.

Returns:
the Output File

setOutputFile

public void setOutputFile(Object outputFile)
Sets the Output File parameter of this tool . This parameter is the name and location of the output map package (.mpk). This is a required parameter.

Parameters:
outputFile - the name and location of the output map package (.mpk).

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.

getVersion

public Object getVersion()
Returns the Package version parameter of this tool . This parameter is specifies if input layers will be converted into file geodatabase or preserve their original format. For multiple versions, use semi colons to separate the arguements. ie "CURRENT;9.3.1" This is an optional parameter.

Returns:
the Package version

setVersion

public void setVersion(Object version)
Sets the Package version parameter of this tool . This parameter is specifies if input layers will be converted into file geodatabase or preserve their original format. For multiple versions, use semi colons to separate the arguements. ie "CURRENT;9.3.1" This is an optional parameter.

Parameters:
version - specifies if input layers will be converted into file geodatabase or preserve their original format. For multiple versions, use semi colons to separate the arguements. ie "CURRENT;9.3.1"

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