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

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

public class LayerToKML
extends AbstractGPTool

This tool converts an in-memory or file-based feature or raster layer into a KML file containing a translation of ESRI geometries and symbology. This file is compressed using ZIP compression, has a .kmz extension, and can be read by any KML client including ArcGIS Explorer, ArcGlobe, and Google Earth. The Layer To KML tool is contained in the Conversion Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
LayerToKML()
          Creates the Layer To KML tool with defaults.
LayerToKML(Object layer, Object outKmzFile, double layerOutputScale)
          Creates the Layer To KML tool with the required parameters.
 
Method Summary
 Object getBoundaryBoxExtent()
          Returns the Extent to Export parameter of this tool .
 int getDpiOfClient()
          Returns the DPI of output image parameter of this tool .
 int getImageSize()
          Returns the Size of returned image (pixels) parameter of this tool .
 String getIsComposite()
          Returns the Return single composite image parameter of this tool .
 Object getLayer()
          Returns the Layer parameter of this tool .
 double getLayerOutputScale()
          Returns the Layer Output Scale parameter of this tool .
 Object getOutKmzFile()
          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.
 void setBoundaryBoxExtent(Object boundaryBoxExtent)
          Sets the Extent to Export parameter of this tool .
 void setDpiOfClient(int dpiOfClient)
          Sets the DPI of output image parameter of this tool .
 void setImageSize(int imageSize)
          Sets the Size of returned image (pixels) parameter of this tool .
 void setIsComposite(String isComposite)
          Sets the Return single composite image parameter of this tool .
 void setLayer(Object layer)
          Sets the Layer parameter of this tool .
 void setLayerOutputScale(double layerOutputScale)
          Sets the Layer Output Scale parameter of this tool .
 void setOutKmzFile(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

LayerToKML

public LayerToKML()
Creates the Layer To KML tool with defaults.

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


LayerToKML

public LayerToKML(Object layer,
                  Object outKmzFile,
                  double layerOutputScale)
Creates the Layer 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:
layer - the in-memory layer or layer file stored on disk that is to be converted to KML.
outKmzFile - the KML file to write. This file is compressed and has a .kmz extension. It can be read by any KML client including ArcGIS Explorer, ArcGlobe, and Google Earth.
layerOutputScale - the scale at which to export the layer. Any scale-dependent rendering is observed, so if the layer is not visible at the export scale, it will not be included in the created KML file. The symbology for the layer is driven by this scale. only numeric characters should be entered. For example, enter "20000" as the scale, not 1:20000 or 20,000. furthermore, if you are exporting a layer that is to be displayed as 3D vectors—such as a point layer with the Return single composite image option disabled—and there is no scale-dependent rendering defined for the layer, then this parameter is not required for the export process and can be set to any numeric value, such as 1.
Method Detail

getLayer

public Object getLayer()
Returns the Layer parameter of this tool . This parameter is the in-memory layer or layer file stored on disk that is to be converted to KML. This is a required parameter.

Returns:
the Layer

setLayer

public void setLayer(Object layer)
Sets the Layer parameter of this tool . This parameter is the in-memory layer or layer file stored on disk that is to be converted to KML. This is a required parameter.

Parameters:
layer - the in-memory layer or layer file stored on disk that is to be converted to KML.

getOutKmzFile

public Object getOutKmzFile()
Returns the Output File parameter of this tool . This parameter is the KML file to write. This file is compressed and has 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(Object outKmzFile)
Sets the Output File parameter of this tool . This parameter is the KML file to write. This file is compressed and has 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 has a .kmz extension. It can be read by any KML client including ArcGIS Explorer, ArcGlobe, and Google Earth.

getLayerOutputScale

public double getLayerOutputScale()
Returns the Layer Output Scale parameter of this tool . This parameter is the scale at which to export the layer. Any scale-dependent rendering is observed, so if the layer is not visible at the export scale, it will not be included in the created KML file. The symbology for the layer is driven by this scale. only numeric characters should be entered. For example, enter "20000" as the scale, not 1:20000 or 20,000. furthermore, if you are exporting a layer that is to be displayed as 3D vectors—such as a point layer with the Return single composite image option disabled—and there is no scale-dependent rendering defined for the layer, then 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 Layer Output Scale

setLayerOutputScale

public void setLayerOutputScale(double layerOutputScale)
Sets the Layer Output Scale parameter of this tool . This parameter is the scale at which to export the layer. Any scale-dependent rendering is observed, so if the layer is not visible at the export scale, it will not be included in the created KML file. The symbology for the layer is driven by this scale. only numeric characters should be entered. For example, enter "20000" as the scale, not 1:20000 or 20,000. furthermore, if you are exporting a layer that is to be displayed as 3D vectors—such as a point layer with the Return single composite image option disabled—and there is no scale-dependent rendering defined for the layer, then 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:
layerOutputScale - the scale at which to export the layer. Any scale-dependent rendering is observed, so if the layer is not visible at the export scale, it will not be included in the created KML file. The symbology for the layer is driven by this scale. only numeric characters should be entered. For example, enter "20000" as the scale, not 1:20000 or 20,000. furthermore, if you are exporting a layer that is to be displayed as 3D vectors—such as a point layer with the Return single composite image option disabled—and there is no scale-dependent rendering defined for the layer, then this parameter is not required for the export process and can be set to any numeric value, such as 1.

getIsComposite

public 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(String isComposite)
Sets the Return single composite image parameter of this tool . This is an optional parameter.

Parameters:
isComposite - null

getBoundaryBoxExtent

public Object getBoundaryBoxExtent()
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

setBoundaryBoxExtent

public void setBoundaryBoxExtent(Object boundaryBoxExtent)
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:
boundaryBoxExtent - 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 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 defines the vertical and horizontal resolution of any rasters in the output KML document. This is an optional parameter.

Parameters:
imageSize - 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 define 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 define the device resolution for any rasters in the output KML document. This is an optional parameter.

Parameters:
dpiOfClient - define the device resolution for any rasters in the output KML document.

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