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

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

All Implemented Interfaces:

GPTool

public class CreateDiagram
extends AbstractGPTool

This tool creates a schematic diagram. Depending on the schematic builder, diagram creation can be based on feature layers, feature classes, object tables, a network analysis layer, or XML data. The Create Diagram tool is contained in the Schematics Tools tool box.

Usage tips:

• If the output schematic diagram name already exists, it may be deleted before being re-created. To avoid this deletion, you can uncheck the Overwrite the outputs of geoprocessing operations box from the Geoprocessing Options dialog box.
• Depending on the schematic builder related to the diagram template specified for the diagram to be created, the Input Data parameter is required or not:

Field Summary

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

vals

Constructor Summary

CreateDiagram()
Creates the Create Diagram tool with defaults.

CreateDiagram(Object outLocation, String outName, String diagramType)
Creates the Create Diagram tool with the required parameters.

Method Summary

String	getBuilderOptions() Returns the Builder Options parameter of this tool .
String	getDiagramType() Returns the Diagram Template parameter of this tool .
Object	getInData() Returns the Input Data parameter of this tool .
Object	getOutDiagram() Returns the Output Schematic Diagram parameter of this tool (Read only).
Object	getOutLocation() Returns the Output Location parameter of this tool .
String	getOutName() Returns the Output Diagram Name 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	setBuilderOptions(String builderOptions) Sets the Builder Options parameter of this tool .
void	setDiagramType(String diagramType) Sets the Diagram Template parameter of this tool .
void	setInData(Object inData) Sets the Input Data parameter of this tool .
void	setOutLocation(Object outLocation) Sets the Output Location parameter of this tool .
void	setOutName(String outName) Sets the Output Diagram Name 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

CreateDiagram

public CreateDiagram()

Creates the Create Diagram tool with defaults.

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

CreateDiagram

public CreateDiagram(Object outLocation,
                     String outName,
                     String diagramType)

Creates the Create Diagram 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:

outLocation - schematic dataset or schematic folder in which the diagram will be created.

outName - name of the schematic diagram to be created.

diagramType - schematic diagram template of the schematic diagram to be created.

Method Detail

getOutLocation

public Object getOutLocation()

Returns the Output Location parameter of this tool . This parameter is schematic dataset or schematic folder in which the diagram will be created. 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 schematic dataset or schematic folder in which the diagram will be created. This is a required parameter.

Parameters:

outLocation - schematic dataset or schematic folder in which the diagram will be created.

getOutName

public String getOutName()

Returns the Output Diagram Name parameter of this tool . This parameter is name of the schematic diagram to be created. This is a required parameter.

Returns:

the Output Diagram Name

setOutName

public void setOutName(String outName)

Sets the Output Diagram Name parameter of this tool . This parameter is name of the schematic diagram to be created. This is a required parameter.

Parameters:

outName - name of the schematic diagram to be created.

getDiagramType

public String getDiagramType()

Returns the Diagram Template parameter of this tool . This parameter is schematic diagram template of the schematic diagram to be created. This is a required parameter.

Returns:

the Diagram Template

setDiagramType

public void setDiagramType(String diagramType)

Sets the Diagram Template parameter of this tool . This parameter is schematic diagram template of the schematic diagram to be created. This is a required parameter.

Parameters:

diagramType - schematic diagram template of the schematic diagram to be created.

getInData

public Object getInData()

Returns the Input Data parameter of this tool . This parameter is the input data required to generate the diagram. the Input Data parameter specifies the elements on which the diagram generation will be based. It is a mandatory parameter for most of the predefined schematic builders: This is an optional parameter.

Returns:

the Input Data

setInData

public void setInData(Object inData)

Sets the Input Data parameter of this tool . This parameter is the input data required to generate the diagram. the Input Data parameter specifies the elements on which the diagram generation will be based. It is a mandatory parameter for most of the predefined schematic builders: This is an optional parameter.

Parameters:

inData - the input data required to generate the diagram. the Input Data parameter specifies the elements on which the diagram generation will be based. It is a mandatory parameter for most of the predefined schematic builders:

• For diagram templates that work with the Standard builder configured to operate from a geometric network, the Input Data parameter must at least reference a feature layer, feature class, or object table.
• For diagram templates that work with the Network Dataset builder, the Input Data parameter must reference a unique network analysis layer. If the related network analysis is not performed, Schematics tries to perform it before using the solved analysis layer as input.
• For diagram templates related to the XML builder, the Input Data parameter is optional when the data for the diagram generation is provided by an external component. But when no external component is defined for the builder properties, the Input Data must reference an XML file. In both cases, the input XML data must be built according to the XMLBuilderDiagram XML Schema file.
• For diagram templates that work with the Standard builder configured to operate from custom queries, no input data is required.

getBuilderOptions

public String getBuilderOptions()

Returns the Builder Options parameter of this tool . This parameter is the schematic builder creation parameters. These are optional; they are only used for diagrams based on the Network Dataset builder to specify whether nodes will be merged. No option is required for the other schematic builders. This is an optional parameter.

Returns:

the Builder Options

setBuilderOptions

public void setBuilderOptions(String builderOptions)

Sets the Builder Options parameter of this tool . This parameter is the schematic builder creation parameters. These are optional; they are only used for diagrams based on the Network Dataset builder to specify whether nodes will be merged. No option is required for the other schematic builders. This is an optional parameter.

Parameters:

builderOptions - the schematic builder creation parameters. These are optional; they are only used for diagrams based on the Network Dataset builder to specify whether nodes will be merged. No option is required for the other schematic builders.

getOutDiagram

public Object getOutDiagram()

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

Returns:

the Output 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