com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class MakeGraph

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.MakeGraph

All Implemented Interfaces:

GPTool

public class MakeGraph
extends AbstractGPTool

Creates a graph as a visual output using a graph template or an existing graph. The Make Graph tool is contained in the Data Management Tools tool box.

Field Summary

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

vals

Constructor Summary

MakeGraph()
Creates the Make Graph tool with defaults.

MakeGraph(Object inGraphTemplateSource, Object inDatasets, Object outGraphName)
Creates the Make Graph tool with the required parameters.

Method Summary

Object	getInDatasets() Returns the Input series parameter of this tool .
Object	getInGraphTemplateSource() Returns the Input graph template or graph parameter of this tool .
Object	getOutGraphName() Returns the Output graph 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	setInDatasets(Object inDatasets) Sets the Input series parameter of this tool .
void	setInGraphTemplateSource(Object inGraphTemplateSource) Sets the Input graph template or graph parameter of this tool .
void	setOutGraphName(Object outGraphName) Sets the Output graph 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

MakeGraph

public MakeGraph()

Creates the Make Graph tool with defaults.

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

MakeGraph

public MakeGraph(Object inGraphTemplateSource,
                 Object inDatasets,
                 Object outGraphName)

Creates the Make Graph 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:

inGraphTemplateSource - the input graph template (*.tee) or graph file (*.grf).

inDatasets - the input data for individual series in the graph. The input data varies based on the graph type.

outGraphName - the name of the graph to be created.

Method Detail

getInGraphTemplateSource

public Object getInGraphTemplateSource()

Returns the Input graph template or graph parameter of this tool . This parameter is the input graph template (*.tee) or graph file (*.grf). This is a required parameter.

Returns:

the Input graph template or graph

setInGraphTemplateSource

public void setInGraphTemplateSource(Object inGraphTemplateSource)

Sets the Input graph template or graph parameter of this tool . This parameter is the input graph template (*.tee) or graph file (*.grf). This is a required parameter.

Parameters:

inGraphTemplateSource - the input graph template (*.tee) or graph file (*.grf).

getInDatasets

public Object getInDatasets()

Returns the Input series parameter of this tool . This parameter is the input data for individual series in the graph. The input data varies based on the graph type. This is a required parameter.

Returns:

the Input series

setInDatasets

public void setInDatasets(Object inDatasets)

Sets the Input series parameter of this tool . This parameter is the input data for individual series in the graph. The input data varies based on the graph type. This is a required parameter.

Parameters:

inDatasets - the input data for individual series in the graph. The input data varies based on the graph type.

getOutGraphName

public Object getOutGraphName()

Returns the Output graph name parameter of this tool . This parameter is the name of the graph to be created. This is a required parameter.

Returns:

the Output graph name

setOutGraphName

public void setOutGraphName(Object outGraphName)

Sets the Output graph name parameter of this tool . This parameter is the name of the graph to be created. This is a required parameter.

Parameters:

outGraphName - the name of the graph to 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