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

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

All Implemented Interfaces:

GPTool

public class UpdateDiagrams
extends AbstractGPTool

Updates schematic diagrams stored in a schematic dataset or schematic folder. All diagrams or a subset of diagrams (for example, diagrams related to a specific diagram template or diagrams that have not been updated for a particular number of days) can be updated. The Update Diagrams tool is contained in the Schematics Tools tool box.

Usage tips:

• This tool is mostly used to batch diagram updates. But, when user data has been dropped and reloaded since the diagram generations, it can also be used to resynchronize the schematic features with their related features/objects based on GUIDs.
• If the Diagram Template parameter is specified, only the diagrams based on that template will be updated.
• If the Number of days without update parameter is specified, only the diagrams for which the last update date meets the criterion will be updated.
• By default, when the value specified for Input Schematic Container is a schematic folder, the update process operates recursively on all diagrams contained in that schematic folder and on all those contained in its subfolders. If you do not want the diagrams contained in the subfolders to be updated, set 0 for the recursive parameter.

Field Summary

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

vals

Constructor Summary

UpdateDiagrams()
Creates the Update Diagrams tool with defaults.

UpdateDiagrams(Object inContainer)
Creates the Update Diagrams 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	getInContainer() Returns the Input Schematic Container parameter of this tool .
int	getLastUpdateCriteria() Returns the Number of days without update parameter of this tool .
Object	getOutContainer() Returns the Output Schematic Container parameter of this tool (Read only).
String	getRecursive() Returns the Recursive Search 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	setInContainer(Object inContainer) Sets the Input Schematic Container parameter of this tool .
void	setLastUpdateCriteria(int lastUpdateCriteria) Sets the Number of days without update parameter of this tool .
void	setRecursive(String recursive) Sets the Recursive Search 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

UpdateDiagrams

public UpdateDiagrams()

Creates the Update Diagrams tool with defaults.

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

UpdateDiagrams

public UpdateDiagrams(Object inContainer)

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

inContainer - the schematic dataset or schematic folder in which the diagrams are stored. This container must already exist.

Method Detail

getInContainer

public Object getInContainer()

Returns the Input Schematic Container parameter of this tool . This parameter is the schematic dataset or schematic folder in which the diagrams are stored. This container must already exist. This is a required parameter.

Returns:

the Input Schematic Container

setInContainer

public void setInContainer(Object inContainer)

Sets the Input Schematic Container parameter of this tool . This parameter is the schematic dataset or schematic folder in which the diagrams are stored. This container must already exist. This is a required parameter.

Parameters:

inContainer - the schematic dataset or schematic folder in which the diagrams are stored. This container must already exist.

getBuilderOptions

public String getBuilderOptions()

Returns the Builder Options parameter of this tool . This parameter is the schematic builder update options. They are optional. 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. They are optional. This is an optional parameter.

Parameters:

builderOptions - the schematic builder update options. They are optional.

getRecursive

public String getRecursive()

Returns the Recursive Search parameter of this tool . This is an optional parameter.

Returns:

the Recursive Search

setRecursive

public void setRecursive(String recursive)

Sets the Recursive Search parameter of this tool . This is an optional parameter.

Parameters:

recursive - null

getDiagramType

public String getDiagramType()

Returns the Diagram Template parameter of this tool . This parameter is the diagram template of the schematic diagram to update. This is an optional parameter.

Returns:

the Diagram Template

setDiagramType

public void setDiagramType(String diagramType)

Sets the Diagram Template parameter of this tool . This parameter is the diagram template of the schematic diagram to update. This is an optional parameter.

Parameters:

diagramType - the diagram template of the schematic diagram to update.

getLastUpdateCriteria

public int getLastUpdateCriteria()

Returns the Number of days without update parameter of this tool . This parameter is the number of days between diagram updates. The default is zero (0), meaning all diagrams will be updated daily. This is an optional parameter.

Returns:

the Number of days without update

setLastUpdateCriteria

public void setLastUpdateCriteria(int lastUpdateCriteria)

Sets the Number of days without update parameter of this tool . This parameter is the number of days between diagram updates. The default is zero (0), meaning all diagrams will be updated daily. This is an optional parameter.

Parameters:

lastUpdateCriteria - the number of days between diagram updates. The default is zero (0), meaning all diagrams will be updated daily.

getOutContainer

public Object getOutContainer()

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

Returns:

the Output Schematic Container

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