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

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

All Implemented Interfaces:

GPTool

public class UpdateDiagram
extends AbstractGPTool

Updates a schematic diagram. Depending on the schematic builder, the diagram update can be based on feature layers, feature classes, object tables, a solved network analysis, or an XML file. The Update Diagram tool is contained in the Schematics Tools tool box.

Usage tips:

• The Input Data parameter is mandatory for diagrams working with the and . It is optional for diagrams working with the . It must not be specified for diagrams that work with the .
• When using the Update Diagram tool on diagrams implemented by the that have been generated from a trace, the update operates from the updated trace result based on the trace parameters that persisted in the schematic dataset the first time the diagram was generated from a highlighted trace.
• When the update must operate from features that compose a geometric network, it is not necessary to specify all the feature layers in the Input Data parameter. If the Add connected nodes option is specified for the Standard builder properties, only the feature layers related to edge features can be specified, even if all the feature layers related to the geometric network (junctions and edges) will be used for update.
• If a particular layout was saved for the specified schematic diagram, the schematic features that were in the diagram before updating are displayed according to their last saved position, and new schematic features that may have been introduced during the update are positioned at their geographic coordinates.

Field Summary

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

vals

Constructor Summary

UpdateDiagram()
Creates the Update Diagram tool with defaults.

UpdateDiagram(Object inDiagram)
Creates the Update Diagram tool with the required parameters.

Method Summary

String	getBuilderOptions() Returns the Builder Options parameter of this tool .
Object	getInData() Returns the Input Data parameter of this tool .
Object	getInDiagram() Returns the Input Schematic Diagram parameter of this tool .
Object	getOutDiagram() Returns the Output Schematic Diagram parameter of this tool (Read only).
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	setInData(Object inData) Sets the Input Data parameter of this tool .
void	setInDiagram(Object inDiagram) Sets the Input Schematic Diagram 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

UpdateDiagram

public UpdateDiagram()

Creates the Update Diagram tool with defaults.

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

UpdateDiagram

public UpdateDiagram(Object inDiagram)

Creates the Update 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:

inDiagram - the schematic diagram to be updated.

Method Detail

getInDiagram

public Object getInDiagram()

Returns the Input Schematic Diagram parameter of this tool . This parameter is the schematic diagram to be updated. 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 updated. This is a required parameter.

Parameters:

inDiagram - the schematic diagram to be updated.

getInData

public Object getInData()

Returns the Input Data parameter of this tool . This parameter is the input data on which the diagram update will be based. the Input Data parameter is not required for all predefined builders; it's an optional parameter: 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 on which the diagram update will be based. the Input Data parameter is not required for all predefined builders; it's an optional parameter: This is an optional parameter.

Parameters:

inData - the input data on which the diagram update will be based. the Input Data parameter is not required for all predefined builders; it's an optional parameter:

• For diagram templates that work with the Standard builder configured to operate from custom queries, no input tables must be set.
• For diagram templates that work with the XML builder, the Input Data parameter must reference an XML file.
• For diagram templates that work with the Network Dataset builder, the input data must be specified. It must reference a unique network analyst 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 that work with the Standard builder configured to operate from geometric networks, when the Input Data parameter is not specified, the Update Diagram tool works from the initial set of features/objects used to generate the diagram or from the updated trace result based on the trace parameters that persisted in the schematic database if the diagram was generated from a highlighted trace. When the Input Data parameter is specified, it must reference at least a feature layer, feature class, or object table so the update operates on this data according to the Builder Options value.

getBuilderOptions

public String getBuilderOptions()

Returns the Builder Options parameter of this tool . This parameter is the schematic builder update options. Update options are optional. They depend on the builder related to the diagram template that implements the specified schematic diagram. diagrams generated from custom queries (Standard builder): KEEP_MANUAL_MODIF or NO_KEEP_MANUAL_MODIF. diagrams generated from XML data (XML builder): KEEP_MANUAL_MODIF or NO_KEEP_MANUAL_MODIF. diagrams generated from solver results on network datasets (Network Dataset builder): MERGE_NODES or NO_MERGE_NODES, KEEP_MANUAL_MODIF or NO_KEEP_MANUAL_MODIF diagrams generated from features organized into a geometric network (Standard builder): REBUILD or APPEND, KEEP_MANUAL_MODIF or NO_KEEP_MANUAL_MODIF. 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 update options. Update options are optional. They depend on the builder related to the diagram template that implements the specified schematic diagram. diagrams generated from custom queries (Standard builder): KEEP_MANUAL_MODIF or NO_KEEP_MANUAL_MODIF. diagrams generated from XML data (XML builder): KEEP_MANUAL_MODIF or NO_KEEP_MANUAL_MODIF. diagrams generated from solver results on network datasets (Network Dataset builder): MERGE_NODES or NO_MERGE_NODES, KEEP_MANUAL_MODIF or NO_KEEP_MANUAL_MODIF diagrams generated from features organized into a geometric network (Standard builder): REBUILD or APPEND, KEEP_MANUAL_MODIF or NO_KEEP_MANUAL_MODIF. This is an optional parameter.

Parameters:

builderOptions - the schematic builder update options. Update options are optional. They depend on the builder related to the diagram template that implements the specified schematic diagram. diagrams generated from custom queries (Standard builder): KEEP_MANUAL_MODIF or NO_KEEP_MANUAL_MODIF. diagrams generated from XML data (XML builder): KEEP_MANUAL_MODIF or NO_KEEP_MANUAL_MODIF. diagrams generated from solver results on network datasets (Network Dataset builder): MERGE_NODES or NO_MERGE_NODES, KEEP_MANUAL_MODIF or NO_KEEP_MANUAL_MODIF diagrams generated from features organized into a geometric network (Standard builder): REBUILD or APPEND, KEEP_MANUAL_MODIF or NO_KEEP_MANUAL_MODIF.

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