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

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

public class CadToGeodatabase
extends AbstractGPTool

Reads a CAD dataset and creates feature classes of the drawing. The feature classes are written to a geodatabase feature dataset. The CAD to Geodatabase 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
CadToGeodatabase()
          Creates the CAD to Geodatabase tool with defaults.
CadToGeodatabase(Object inputCadDatasets, Object outGdbPath, String outDatasetName, double referenceScale)
          Creates the CAD to Geodatabase tool with the required parameters.
 
Method Summary
 Object getInputCadDatasets()
          Returns the Input CAD Datasets parameter of this tool .
 Object getOutDataset()
          Returns the Output Feature Dataset parameter of this tool (Read only).
 String getOutDatasetName()
          Returns the Dataset parameter of this tool .
 Object getOutGdbPath()
          Returns the Output Geodatabase parameter of this tool .
 double getReferenceScale()
          Returns the Reference scale parameter of this tool .
 Object getSpatialReference()
          Returns the Spatial Reference 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 setInputCadDatasets(Object inputCadDatasets)
          Sets the Input CAD Datasets parameter of this tool .
 void setOutDatasetName(String outDatasetName)
          Sets the Dataset parameter of this tool .
 void setOutGdbPath(Object outGdbPath)
          Sets the Output Geodatabase parameter of this tool .
 void setReferenceScale(double referenceScale)
          Sets the Reference scale parameter of this tool .
 void setSpatialReference(Object spatialReference)
          Sets the Spatial Reference 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

CadToGeodatabase

public CadToGeodatabase()
Creates the CAD to Geodatabase tool with defaults.

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


CadToGeodatabase

public CadToGeodatabase(Object inputCadDatasets,
                        Object outGdbPath,
                        String outDatasetName,
                        double referenceScale)
Creates the CAD to Geodatabase 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:
inputCadDatasets - the collection of CAD files to convert to geodatabase features.
outGdbPath - the ArcSDE, file, or personal geodatabase where the Output Feature Dataset will be created. The target geodatabase must already exist.
outDatasetName - the name of the feature dataset to be created.
referenceScale - enter the scale to use as a reference for the annotation. This sets the scale to which all symbol and text sizes in the annotation will be made relative.
Method Detail

getInputCadDatasets

public Object getInputCadDatasets()
Returns the Input CAD Datasets parameter of this tool . This parameter is the collection of CAD files to convert to geodatabase features. This is a required parameter.

Returns:
the Input CAD Datasets

setInputCadDatasets

public void setInputCadDatasets(Object inputCadDatasets)
Sets the Input CAD Datasets parameter of this tool . This parameter is the collection of CAD files to convert to geodatabase features. This is a required parameter.

Parameters:
inputCadDatasets - the collection of CAD files to convert to geodatabase features.

getOutGdbPath

public Object getOutGdbPath()
Returns the Output Geodatabase parameter of this tool . This parameter is the ArcSDE, file, or personal geodatabase where the Output Feature Dataset will be created. The target geodatabase must already exist. This is a required parameter.

Returns:
the Output Geodatabase

setOutGdbPath

public void setOutGdbPath(Object outGdbPath)
Sets the Output Geodatabase parameter of this tool . This parameter is the ArcSDE, file, or personal geodatabase where the Output Feature Dataset will be created. The target geodatabase must already exist. This is a required parameter.

Parameters:
outGdbPath - the ArcSDE, file, or personal geodatabase where the Output Feature Dataset will be created. The target geodatabase must already exist.

getOutDatasetName

public String getOutDatasetName()
Returns the Dataset parameter of this tool . This parameter is the name of the feature dataset to be created. This is a required parameter.

Returns:
the Dataset

setOutDatasetName

public void setOutDatasetName(String outDatasetName)
Sets the Dataset parameter of this tool . This parameter is the name of the feature dataset to be created. This is a required parameter.

Parameters:
outDatasetName - the name of the feature dataset to be created.

getReferenceScale

public double getReferenceScale()
Returns the Reference scale parameter of this tool . This parameter is enter the scale to use as a reference for the annotation. This sets the scale to which all symbol and text sizes in the annotation will be made relative. This is a required parameter.

Returns:
the Reference scale

setReferenceScale

public void setReferenceScale(double referenceScale)
Sets the Reference scale parameter of this tool . This parameter is enter the scale to use as a reference for the annotation. This sets the scale to which all symbol and text sizes in the annotation will be made relative. This is a required parameter.

Parameters:
referenceScale - enter the scale to use as a reference for the annotation. This sets the scale to which all symbol and text sizes in the annotation will be made relative.

getSpatialReference

public Object getSpatialReference()
Returns the Spatial Reference parameter of this tool . This parameter is the spatial reference of the output feature dataset. If you wish to control other aspects of the spatial reference (i.e., the xy, z, m domains, resolutions, tolerances), use the relevant environments. This is an optional parameter.

Returns:
the Spatial Reference

setSpatialReference

public void setSpatialReference(Object spatialReference)
Sets the Spatial Reference parameter of this tool . This parameter is the spatial reference of the output feature dataset. If you wish to control other aspects of the spatial reference (i.e., the xy, z, m domains, resolutions, tolerances), use the relevant environments. This is an optional parameter.

Parameters:
spatialReference - the spatial reference of the output feature dataset. If you wish to control other aspects of the spatial reference (i.e., the xy, z, m domains, resolutions, tolerances), use the relevant environments.

getOutDataset

public Object getOutDataset()
Returns the Output Feature Dataset parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Feature Dataset

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