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

The Create Diagram tool is contained in the Schematics Tools tool box.

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 Type 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 Type 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 - null

outName - null

diagramType - null

Method Detail

getOutLocation

public Object getOutLocation()

Returns the Output Location parameter of this tool . This is a required parameter.

Returns:

the Output Location

setOutLocation

public void setOutLocation(Object outLocation)

Sets the Output Location parameter of this tool . This is a required parameter.

Parameters:

outLocation - null

getOutName

public String getOutName()

Returns the Output Diagram Name parameter of this tool . 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 is a required parameter.

Parameters:

outName - null

getDiagramType

public String getDiagramType()

Returns the Diagram Type parameter of this tool . This is a required parameter.

Returns:

the Diagram Type

setDiagramType

public void setDiagramType(String diagramType)

Sets the Diagram Type parameter of this tool . This is a required parameter.

Parameters:

diagramType - null

getInData

public Object getInData()

Returns the Input Data parameter of this tool . This is an optional parameter.

Returns:

the Input Data

setInData

public void setInData(Object inData)

Sets the Input Data parameter of this tool . This is an optional parameter.

Parameters:

inData - null

getBuilderOptions

public String getBuilderOptions()

Returns the Builder Options parameter of this tool . This is an optional parameter.

Returns:

the Builder Options

setBuilderOptions

public void setBuilderOptions(String builderOptions)

Sets the Builder Options parameter of this tool . This is an optional parameter.

Parameters:

builderOptions - null

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