com.esri.arcgis.geoprocessing.tools.schematicstools
Class ConvertDiagram

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.schematicstools.ConvertDiagram

All Implemented Interfaces:

GPTool

public class ConvertDiagram
extends AbstractGPTool

This tool converts a schematic diagram to feature classes or shapefiles. The Convert Diagram To Features tool is contained in the Schematics Tools tool box.

Usage tips:

• To convert a schematic diagram to feature classes, browse to and select a geodatabase/feature dataset for the specified output location parameter. To convert a schematic diagram to shapefiles, browse to and select a folder.
• To export several diagrams in the same feature classes/shapefiles, check the Reuse Existing Structure option. To export several diagrams in different feature classes/shapefiles, uncheck the Reuse Existing Structure option.
• Check the Export All Related Feature Attributes option if you want each schematic feature contained in the input schematic diagram to be exported with its schematic attributesall the attributes related to its associated real feature.
• The Export All Related Attribute Features option works for schematic feature classes for which the Associated Feature Class/Table field value is known. If no associated feature class/table is specified for a schematic feature class, its related attribute features cannot be exported.
• When the Reuse Existing Structure option is enabled and the structure has been created without the Export All Related Attribute Features option, enabling this option will have no effect; no field corresponding to the associated features can be created. Check the Export All Related Attribute Features option at the first diagram conversion if you want these attributes to be exported during each diagram conversion process.
• Select POLYGON in Container Geometry if you want all containers contained in the input schematic diagram to be exported as a polygon feature. If you want such containers to be exported as polyline (or point) features, select POLYLINE (or POINT).
• When working with the Reuse Existing Structure option while POLYGON (POLYLINE or POINT) has been chosen for the first diagram conversion, there is no way to change the conversion to POLYLINE or POINT (POLYGON) for the next conversions. If you want to change it, you must remove the structure and export your diagrams again.
• Schematic feature nodes are usually converted to point features unless they are containers in the input schematic diagram. But if the structure is created from an input diagram that doesn't have a container or has empty containers, the feature class created for these schematic feature classes will be a point type feature class.
• When the specified input schematic diagram has been already exported in the specified output location, it will be deleted before being re-created.

Field Summary

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

vals

Constructor Summary

ConvertDiagram()
Creates the Convert Diagram To Features tool with defaults.

ConvertDiagram(Object inDiagram, Object outLocation)
Creates the Convert Diagram To Features tool with the required parameters.

Method Summary

String	getConfigKeyword() Returns the Configuration Keyword parameter of this tool .
String	getContainerGeometry() Returns the Container Geometry parameter of this tool .
String	getExportRelatedAttributes() Returns the Export All related Features Attributes parameter of this tool .
Object	getInDiagram() Returns the Input Schematic Diagram parameter of this tool .
Object	getOutDataset() Returns the Input Schematic Diagram parameter of this tool (Read only).
Object	getOutLocation() Returns the Output Location parameter of this tool .
String	getReuseFc() Returns the Reuse Existing Structure 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	setConfigKeyword(String configKeyword) Sets the Configuration Keyword parameter of this tool .
void	setContainerGeometry(String containerGeometry) Sets the Container Geometry parameter of this tool .
void	setExportRelatedAttributes(String exportRelatedAttributes) Sets the Export All related Features Attributes parameter of this tool .
void	setInDiagram(Object inDiagram) Sets the Input Schematic Diagram parameter of this tool .
void	setOutLocation(Object outLocation) Sets the Output Location parameter of this tool .
void	setReuseFc(String reuseFc) Sets the Reuse Existing Structure 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

ConvertDiagram

public ConvertDiagram()

Creates the Convert Diagram To Features tool with defaults.

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

ConvertDiagram

public ConvertDiagram(Object inDiagram,
                      Object outLocation)

Creates the Convert Diagram To Features 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:

inDiagram - the schematic diagram to be converted.

outLocation - workspace, feature dataset, or folder in which the schematic diagram will be converted. This container must already exist.

Method Detail

getInDiagram

public Object getInDiagram()

Returns the Input Schematic Diagram parameter of this tool . This parameter is the schematic diagram to be converted. This is a required parameter.

Returns:

the Input Schematic Diagram

setInDiagram

public void setInDiagram(Object inDiagram)

Sets the Input Schematic Diagram parameter of this tool . This parameter is the schematic diagram to be converted. This is a required parameter.

Parameters:

inDiagram - the schematic diagram to be converted.

getOutLocation

public Object getOutLocation()

Returns the Output Location parameter of this tool . This parameter is workspace, feature dataset, or folder in which the schematic diagram will be converted. This container must already exist. This is a required parameter.

Returns:

the Output Location

setOutLocation

public void setOutLocation(Object outLocation)

Sets the Output Location parameter of this tool . This parameter is workspace, feature dataset, or folder in which the schematic diagram will be converted. This container must already exist. This is a required parameter.

Parameters:

outLocation - workspace, feature dataset, or folder in which the schematic diagram will be converted. This container must already exist.

getReuseFc

public String getReuseFc()

Returns the Reuse Existing Structure parameter of this tool . This parameter is indicates whether the input schematic diagram will be exported in the same feature classes/shapefiles as the other diagrams based on the same diagram template. This is an optional parameter.

Returns:

the Reuse Existing Structure

setReuseFc

public void setReuseFc(String reuseFc)

Sets the Reuse Existing Structure parameter of this tool . This parameter is indicates whether the input schematic diagram will be exported in the same feature classes/shapefiles as the other diagrams based on the same diagram template. This is an optional parameter.

Parameters:

reuseFc - indicates whether the input schematic diagram will be exported in the same feature classes/shapefiles as the other diagrams based on the same diagram template.

getExportRelatedAttributes

public String getExportRelatedAttributes()

Returns the Export All related Features Attributes parameter of this tool . This parameter is indicates whether all the attributes stored in the feature classes/object tables associated with the schematic feature classes contained in the export diagram will be also exported. if no associated feature class/table is specified for a schematic feature class, no feature attributes can be exported. when using the Reuse Existing Structure option and the structure already exists without the associated feature fields, enabling this option will have no effect. This is an optional parameter.

Returns:

the Export All related Features Attributes

setExportRelatedAttributes

public void setExportRelatedAttributes(String exportRelatedAttributes)

Sets the Export All related Features Attributes parameter of this tool . This parameter is indicates whether all the attributes stored in the feature classes/object tables associated with the schematic feature classes contained in the export diagram will be also exported. if no associated feature class/table is specified for a schematic feature class, no feature attributes can be exported. when using the Reuse Existing Structure option and the structure already exists without the associated feature fields, enabling this option will have no effect. This is an optional parameter.

Parameters:

exportRelatedAttributes - indicates whether all the attributes stored in the feature classes/object tables associated with the schematic feature classes contained in the export diagram will be also exported. if no associated feature class/table is specified for a schematic feature class, no feature attributes can be exported. when using the Reuse Existing Structure option and the structure already exists without the associated feature fields, enabling this option will have no effect.

getContainerGeometry

public String getContainerGeometry()

Returns the Container Geometry parameter of this tool . This parameter is indicates the geometry type of the features that will be created for the exported schematic containers contained in the input diagram. when using the Reuse Existing Structure option and the structure already exists with POLYGON (POLYLINE or POINT) feature classes created for container schematic features, there is no way to change the feature class type to POLYLINE or POINT (POLYGON) for the next conversions. This is an optional parameter.

Returns:

the Container Geometry

setContainerGeometry

public void setContainerGeometry(String containerGeometry)

Sets the Container Geometry parameter of this tool . This parameter is indicates the geometry type of the features that will be created for the exported schematic containers contained in the input diagram. when using the Reuse Existing Structure option and the structure already exists with POLYGON (POLYLINE or POINT) feature classes created for container schematic features, there is no way to change the feature class type to POLYLINE or POINT (POLYGON) for the next conversions. This is an optional parameter.

Parameters:

containerGeometry - indicates the geometry type of the features that will be created for the exported schematic containers contained in the input diagram. when using the Reuse Existing Structure option and the structure already exists with POLYGON (POLYLINE or POINT) feature classes created for container schematic features, there is no way to change the feature class type to POLYLINE or POINT (POLYGON) for the next conversions.

getConfigKeyword

public String getConfigKeyword()

Returns the Configuration Keyword parameter of this tool . This parameter is the configuration keyword that determines the storage parameters of the table in a relational database management system (RDBMS)This is for ArcSDE only. This is an optional parameter.

Returns:

the Configuration Keyword

setConfigKeyword

public void setConfigKeyword(String configKeyword)

Sets the Configuration Keyword parameter of this tool . This parameter is the configuration keyword that determines the storage parameters of the table in a relational database management system (RDBMS)This is for ArcSDE only. This is an optional parameter.

Parameters:

configKeyword - the configuration keyword that determines the storage parameters of the table in a relational database management system (RDBMS)This is for ArcSDE only.

getOutDataset

public Object getOutDataset()

Returns the Input Schematic Diagram parameter of this tool (Read only). This is an derived parameter.

Returns:

the Input Schematic Diagram

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