com.esri.arcgis.geoprocessing.tools.conversiontools
Class MapToKML

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.conversiontools.MapToKML

All Implemented Interfaces:

GPTool

public class MapToKML
extends AbstractGPTool

This tool converts a map document into a KML file containing a translation of ESRI geometries and symbology. This file is compressed using ZIP compression and will have a .kmz extension and can be read by any KML client including ArcGIS Explorer, ArcGlobe, and Google Earth. The Map To KML tool is contained in the Conversion Tools tool box.

Usage tips:

• The output KMZ file cannot already exist.
• You can reduce the size of the output KMZ document if your map has scale-dependent renderers and you choose an appropriate map output scale.
• To output a single raster image draped over topography, use the Return single composite image option.
• To output every layer as a separate raster image, use the Convert Vector to Raster option.

Field Summary

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

vals

Constructor Summary

MapToKML()
Creates the Map To KML tool with defaults.

MapToKML(java.lang.Object inMapDocument, java.lang.String dataFrame, java.lang.Object outKmzFile, double mapOutputScale)
Creates the Map To KML tool with the required parameters.

Method Summary

java.lang.String	getDataFrame() Returns the Data Frame parameter of this tool .
int	getDpiOfClient() Returns the DPI of output image parameter of this tool .
java.lang.Object	getExtentToExport() Returns the Extent to Export parameter of this tool .
int	getImageSize() Returns the Size of returned image (pixels) parameter of this tool .
java.lang.Object	getInMapDocument() Returns the Map Document parameter of this tool .
java.lang.String	getIsComposite() Returns the Return single composite image parameter of this tool .
java.lang.String	getIsVectorToRaster() Returns the Convert Vector to Raster parameter of this tool .
double	getMapOutputScale() Returns the Map Output Scale parameter of this tool .
java.lang.Object	getOutKmzFile() Returns the Output File parameter of this tool .
java.lang.String	getToolboxAlias() Returns the alias of the tool box containing this tool.
java.lang.String	getToolboxName() Returns the name of the tool box containing this tool.
java.lang.String	getToolName() Returns the name of this tool.
void	setDataFrame(java.lang.String dataFrame) Sets the Data Frame parameter of this tool .
void	setDpiOfClient(int dpiOfClient) Sets the DPI of output image parameter of this tool .
void	setExtentToExport(java.lang.Object extentToExport) Sets the Extent to Export parameter of this tool .
void	setImageSize(int imageSize) Sets the Size of returned image (pixels) parameter of this tool .
void	setInMapDocument(java.lang.Object inMapDocument) Sets the Map Document parameter of this tool .
void	setIsComposite(java.lang.String isComposite) Sets the Return single composite image parameter of this tool .
void	setIsVectorToRaster(java.lang.String isVectorToRaster) Sets the Convert Vector to Raster parameter of this tool .
void	setMapOutputScale(double mapOutputScale) Sets the Map Output Scale parameter of this tool .
void	setOutKmzFile(java.lang.Object outKmzFile) Sets the Output File 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

MapToKML

public MapToKML()

Creates the Map To KML tool with defaults.

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

MapToKML

public MapToKML(java.lang.Object inMapDocument,
                java.lang.String dataFrame,
                java.lang.Object outKmzFile,
                double mapOutputScale)

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

inMapDocument - the map document to convert to KML.

dataFrame - the data frame of the map document to convert to KML.

outKmzFile - the KML file to write. This file is compressed and will have a .kmz extension. It can be read by any KML client including ArcGIS Explorer, ArcGlobe, and Google Earth.

mapOutputScale - the scale at which to export the map document. Any scale-dependent rendering will be observed, so layers that are not visible at the export scale will not be included in the created KML file. The symbology for the map will be driven by this scale, so if the map has a reference scale defined, it should be considered when setting this parameter. only numerical characters should be entered. For example, enter the scale as "20000", not 1:20,000 or 20,000. furthermore, if you are exporting a map containing only layers that will be displayed as 3D vectors and there is no scale-dependent rendering defined, this parameter is not required for the export process and can be set to any numeric value, such as 1.

Method Detail

getInMapDocument

public java.lang.Object getInMapDocument()

Returns the Map Document parameter of this tool . This parameter is the map document to convert to KML. This is a required parameter.

Returns:

the Map Document

setInMapDocument

public void setInMapDocument(java.lang.Object inMapDocument)

Sets the Map Document parameter of this tool . This parameter is the map document to convert to KML. This is a required parameter.

Parameters:

inMapDocument - the map document to convert to KML.

getDataFrame

public java.lang.String getDataFrame()

Returns the Data Frame parameter of this tool . This parameter is the data frame of the map document to convert to KML. This is a required parameter.

Returns:

the Data Frame

setDataFrame

public void setDataFrame(java.lang.String dataFrame)

Sets the Data Frame parameter of this tool . This parameter is the data frame of the map document to convert to KML. This is a required parameter.

Parameters:

dataFrame - the data frame of the map document to convert to KML.

getOutKmzFile

public java.lang.Object getOutKmzFile()

Returns the Output File parameter of this tool . This parameter is the KML file to write. This file is compressed and will have a .kmz extension. It can be read by any KML client including ArcGIS Explorer, ArcGlobe, and Google Earth. This is a required parameter.

Returns:

the Output File

setOutKmzFile

public void setOutKmzFile(java.lang.Object outKmzFile)

Sets the Output File parameter of this tool . This parameter is the KML file to write. This file is compressed and will have a .kmz extension. It can be read by any KML client including ArcGIS Explorer, ArcGlobe, and Google Earth. This is a required parameter.

Parameters:

outKmzFile - the KML file to write. This file is compressed and will have a .kmz extension. It can be read by any KML client including ArcGIS Explorer, ArcGlobe, and Google Earth.

getMapOutputScale

public double getMapOutputScale()

Returns the Map Output Scale parameter of this tool . This parameter is the scale at which to export the map document. Any scale-dependent rendering will be observed, so layers that are not visible at the export scale will not be included in the created KML file. The symbology for the map will be driven by this scale, so if the map has a reference scale defined, it should be considered when setting this parameter. only numerical characters should be entered. For example, enter the scale as "20000", not 1:20,000 or 20,000. furthermore, if you are exporting a map containing only layers that will be displayed as 3D vectors and there is no scale-dependent rendering defined, this parameter is not required for the export process and can be set to any numeric value, such as 1. This is a required parameter.

Returns:

the Map Output Scale

setMapOutputScale

public void setMapOutputScale(double mapOutputScale)

Sets the Map Output Scale parameter of this tool . This parameter is the scale at which to export the map document. Any scale-dependent rendering will be observed, so layers that are not visible at the export scale will not be included in the created KML file. The symbology for the map will be driven by this scale, so if the map has a reference scale defined, it should be considered when setting this parameter. only numerical characters should be entered. For example, enter the scale as "20000", not 1:20,000 or 20,000. furthermore, if you are exporting a map containing only layers that will be displayed as 3D vectors and there is no scale-dependent rendering defined, this parameter is not required for the export process and can be set to any numeric value, such as 1. This is a required parameter.

Parameters:

mapOutputScale - the scale at which to export the map document. Any scale-dependent rendering will be observed, so layers that are not visible at the export scale will not be included in the created KML file. The symbology for the map will be driven by this scale, so if the map has a reference scale defined, it should be considered when setting this parameter. only numerical characters should be entered. For example, enter the scale as "20000", not 1:20,000 or 20,000. furthermore, if you are exporting a map containing only layers that will be displayed as 3D vectors and there is no scale-dependent rendering defined, this parameter is not required for the export process and can be set to any numeric value, such as 1.

getIsComposite

public java.lang.String getIsComposite()

Returns the Return single composite image parameter of this tool . This is an optional parameter.

Returns:

the Return single composite image

setIsComposite

public void setIsComposite(java.lang.String isComposite)

Sets the Return single composite image parameter of this tool . This is an optional parameter.

Parameters:

isComposite - null

getIsVectorToRaster

public java.lang.String getIsVectorToRaster()

Returns the Convert Vector to Raster parameter of this tool . This is an optional parameter.

Returns:

the Convert Vector to Raster

setIsVectorToRaster

public void setIsVectorToRaster(java.lang.String isVectorToRaster)

Sets the Convert Vector to Raster parameter of this tool . This is an optional parameter.

Parameters:

isVectorToRaster - null

getExtentToExport

public java.lang.Object getExtentToExport()

Returns the Extent to Export parameter of this tool . This parameter is the geographic extent of the area to be exported. The extent rectangle bounds should be specified as a space-delimited string of WGS84 geographic coordinates in the form "left lower right upper". This is an optional parameter.

Returns:

the Extent to Export

setExtentToExport

public void setExtentToExport(java.lang.Object extentToExport)

Sets the Extent to Export parameter of this tool . This parameter is the geographic extent of the area to be exported. The extent rectangle bounds should be specified as a space-delimited string of WGS84 geographic coordinates in the form "left lower right upper". This is an optional parameter.

Parameters:

extentToExport - the geographic extent of the area to be exported. The extent rectangle bounds should be specified as a space-delimited string of WGS84 geographic coordinates in the form "left lower right upper".

getImageSize

public int getImageSize()

Returns the Size of returned image (pixels) parameter of this tool . This parameter is size of returned image in pixels (optional): Defines the vertical and horizontal resolution of any rasters in the output KML document. This is an optional parameter.

Returns:

the Size of returned image (pixels)

setImageSize

public void setImageSize(int imageSize)

Sets the Size of returned image (pixels) parameter of this tool . This parameter is size of returned image in pixels (optional): Defines the vertical and horizontal resolution of any rasters in the output KML document. This is an optional parameter.

Parameters:

imageSize - size of returned image in pixels (optional): Defines the vertical and horizontal resolution of any rasters in the output KML document.

getDpiOfClient

public int getDpiOfClient()

Returns the DPI of output image parameter of this tool . This parameter is defines the device resolution for any rasters in the output KML document. This is an optional parameter.

Returns:

the DPI of output image

setDpiOfClient

public void setDpiOfClient(int dpiOfClient)

Sets the DPI of output image parameter of this tool . This parameter is defines the device resolution for any rasters in the output KML document. This is an optional parameter.

Parameters:

dpiOfClient - defines the device resolution for any rasters in the output KML document.

getToolName

public java.lang.String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public java.lang.String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias