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

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

public class KMLToLayer
extends AbstractGPTool

This tool converts a KML or KMZ file into a feature class along with a layer file dervived from the source render information inside the KML/KMZ. The KML To Layer 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
KMLToLayer()
          Creates the KML To Layer tool with defaults.
KMLToLayer(Object inKmlFile, Object outputFolder)
          Creates the KML To Layer tool with the required parameters.
 
Method Summary
 Object getInKmlFile()
          Returns the Input KML File parameter of this tool .
 Object getOutGeodatabase()
          Returns the Output Geodatabase parameter of this tool (Read only).
 String getOutputData()
          Returns the Output Data Name parameter of this tool .
 Object getOutputFolder()
          Returns the Output Location parameter of this tool .
 Object getOutputLayer()
          Returns the Output Layer parameter of this tool (Read only).
 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 setInKmlFile(Object inKmlFile)
          Sets the Input KML File parameter of this tool .
 void setOutputData(String outputData)
          Sets the Output Data Name parameter of this tool .
 void setOutputFolder(Object outputFolder)
          Sets the Output Location 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

KMLToLayer

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

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


KMLToLayer

public KMLToLayer(Object inKmlFile,
                  Object outputFolder)
Creates the KML To Layer 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:
inKmlFile - the path to the KML or KMZ file to be translated.
outputFolder - the destination folder for the File Geodatabase and layer (.lyr) file.
Method Detail

getInKmlFile

public Object getInKmlFile()
Returns the Input KML File parameter of this tool . This parameter is the path to the KML or KMZ file to be translated. This is a required parameter.

Returns:
the Input KML File

setInKmlFile

public void setInKmlFile(Object inKmlFile)
Sets the Input KML File parameter of this tool . This parameter is the path to the KML or KMZ file to be translated. This is a required parameter.

Parameters:
inKmlFile - the path to the KML or KMZ file to be translated.

getOutputFolder

public Object getOutputFolder()
Returns the Output Location parameter of this tool . This parameter is the destination folder for the File Geodatabase and layer (.lyr) file. This is a required parameter.

Returns:
the Output Location

setOutputFolder

public void setOutputFolder(Object outputFolder)
Sets the Output Location parameter of this tool . This parameter is the destination folder for the File Geodatabase and layer (.lyr) file. This is a required parameter.

Parameters:
outputFolder - the destination folder for the File Geodatabase and layer (.lyr) file.

getOutputData

public String getOutputData()
Returns the Output Data Name parameter of this tool . This parameter is the name of the output File Geodatabase and layer file (.lyr). Defaults to the name of the input KML file. This is an optional parameter.

Returns:
the Output Data Name

setOutputData

public void setOutputData(String outputData)
Sets the Output Data Name parameter of this tool . This parameter is the name of the output File Geodatabase and layer file (.lyr). Defaults to the name of the input KML file. This is an optional parameter.

Parameters:
outputData - the name of the output File Geodatabase and layer file (.lyr). Defaults to the name of the input KML file.

getOutputLayer

public Object getOutputLayer()
Returns the Output Layer parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Layer

getOutGeodatabase

public Object getOutGeodatabase()
Returns the Output Geodatabase parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Geodatabase

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