com.esri.arcgis.geoprocessing.tools.samples
Class CADtoFeatureClasswithAttributeofNearestPoint

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

public class CADtoFeatureClasswithAttributeofNearestPoint
extends AbstractGPTool

Generate a feature class from CAD objects and point features that are nearest to those CAD features. The CAD to Feature Class with Attribute of Nearest Point tool is contained in the Samples tool box.

Software restrictions: ArcInfo only

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
CADtoFeatureClasswithAttributeofNearestPoint()
          Creates the CAD to Feature Class with Attribute of Nearest Point tool with defaults.
CADtoFeatureClasswithAttributeofNearestPoint(Object inputCADFile, Object outputFeatureClass)
          Creates the CAD to Feature Class with Attribute of Nearest Point tool with the required parameters.
 
Method Summary
 Object getInputCADFile()
          Returns the input CAD file parameter of this tool .
 Object getMainFeaturesFilterExpression()
          Returns the main features filter expression parameter of this tool .
 Object getNearPointFilterExpression()
          Returns the near point filter expression parameter of this tool .
 Object getOutputFeatureClass()
          Returns the output feature class parameter of this tool .
 Object getSearchRadius()
          Returns the search radius parameter of this tool .
 String getSelectNearPointsOrAnnotation()
          Returns the select near points or annotation parameter of this tool .
 String getSelectOutputFeatureType()
          Returns the select output feature type 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 setInputCADFile(Object inputCADFile)
          Sets the input CAD file parameter of this tool .
 void setMainFeaturesFilterExpression(Object mainFeaturesFilterExpression)
          Sets the main features filter expression parameter of this tool .
 void setNearPointFilterExpression(Object nearPointFilterExpression)
          Sets the near point filter expression parameter of this tool .
 void setOutputFeatureClass(Object outputFeatureClass)
          Sets the output feature class parameter of this tool .
 void setSearchRadius(Object searchRadius)
          Sets the search radius parameter of this tool .
 void setSelectNearPointsOrAnnotation(String selectNearPointsOrAnnotation)
          Sets the select near points or annotation parameter of this tool .
 void setSelectOutputFeatureType(String selectOutputFeatureType)
          Sets the select output feature type 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

CADtoFeatureClasswithAttributeofNearestPoint

public CADtoFeatureClasswithAttributeofNearestPoint()
Creates the CAD to Feature Class with Attribute of Nearest Point tool with defaults.

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


CADtoFeatureClasswithAttributeofNearestPoint

public CADtoFeatureClasswithAttributeofNearestPoint(Object inputCADFile,
                                                    Object outputFeatureClass)
Creates the CAD to Feature Class with Attribute of Nearest Point 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:
inputCADFile - CAD Drawing Dataset, the CAD file that will be converted to an ArcGIS feature class.
outputFeatureClass - Feature Class, the feature class that will be created from the input CAD file.
Method Detail

getInputCADFile

public Object getInputCADFile()
Returns the input CAD file parameter of this tool . This parameter is CAD Drawing Dataset, the CAD file that will be converted to an ArcGIS feature class. This is a required parameter.

Returns:
the input CAD file

setInputCADFile

public void setInputCADFile(Object inputCADFile)
Sets the input CAD file parameter of this tool . This parameter is CAD Drawing Dataset, the CAD file that will be converted to an ArcGIS feature class. This is a required parameter.

Parameters:
inputCADFile - CAD Drawing Dataset, the CAD file that will be converted to an ArcGIS feature class.

getOutputFeatureClass

public Object getOutputFeatureClass()
Returns the output feature class parameter of this tool . This parameter is Feature Class, the feature class that will be created from the input CAD file. This is a required parameter.

Returns:
the output feature class

setOutputFeatureClass

public void setOutputFeatureClass(Object outputFeatureClass)
Sets the output feature class parameter of this tool . This parameter is Feature Class, the feature class that will be created from the input CAD file. This is a required parameter.

Parameters:
outputFeatureClass - Feature Class, the feature class that will be created from the input CAD file.

getMainFeaturesFilterExpression

public Object getMainFeaturesFilterExpression()
Returns the main features filter expression parameter of this tool . This parameter is SQL Expression, the SQL query expression that will be used to select records. This is an optional parameter.

Returns:
the main features filter expression

setMainFeaturesFilterExpression

public void setMainFeaturesFilterExpression(Object mainFeaturesFilterExpression)
Sets the main features filter expression parameter of this tool . This parameter is SQL Expression, the SQL query expression that will be used to select records. This is an optional parameter.

Parameters:
mainFeaturesFilterExpression - SQL Expression, the SQL query expression that will be used to select records.

getSelectNearPointsOrAnnotation

public String getSelectNearPointsOrAnnotation()
Returns the select near points or annotation parameter of this tool . This parameter is String, the type of near point objects whose attributes are associated with the output features. This is an optional parameter.

Returns:
the select near points or annotation

setSelectNearPointsOrAnnotation

public void setSelectNearPointsOrAnnotation(String selectNearPointsOrAnnotation)
Sets the select near points or annotation parameter of this tool . This parameter is String, the type of near point objects whose attributes are associated with the output features. This is an optional parameter.

Parameters:
selectNearPointsOrAnnotation - String, the type of near point objects whose attributes are associated with the output features.

getNearPointFilterExpression

public Object getNearPointFilterExpression()
Returns the near point filter expression parameter of this tool . This parameter is SQL Expression, the SQL query expression that will be used to select records from the Near feature class. This is an optional parameter.

Returns:
the near point filter expression

setNearPointFilterExpression

public void setNearPointFilterExpression(Object nearPointFilterExpression)
Sets the near point filter expression parameter of this tool . This parameter is SQL Expression, the SQL query expression that will be used to select records from the Near feature class. This is an optional parameter.

Parameters:
nearPointFilterExpression - SQL Expression, the SQL query expression that will be used to select records from the Near feature class.

getSearchRadius

public Object getSearchRadius()
Returns the search radius parameter of this tool . This parameter is Linear Unit, the maximum distance used to attach the point or annotation attributes to output features. This is an optional parameter.

Returns:
the search radius

setSearchRadius

public void setSearchRadius(Object searchRadius)
Sets the search radius parameter of this tool . This parameter is Linear Unit, the maximum distance used to attach the point or annotation attributes to output features. This is an optional parameter.

Parameters:
searchRadius - Linear Unit, the maximum distance used to attach the point or annotation attributes to output features.

getSelectOutputFeatureType

public String getSelectOutputFeatureType()
Returns the select output feature type parameter of this tool . This parameter is String, the output feature class type that will be created. This is an optional parameter.

Returns:
the select output feature type

setSelectOutputFeatureType

public void setSelectOutputFeatureType(String selectOutputFeatureType)
Sets the select output feature type parameter of this tool . This parameter is String, the output feature class type that will be created. This is an optional parameter.

Parameters:
selectOutputFeatureType - String, the output feature class type that will be created.

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