com.esri.arcgis.geoprocessing.tools.networkanalysttools
Class UpdateByAlternateIDFields

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.networkanalysttools.UpdateByAlternateIDFields

All Implemented Interfaces:

GPTool

public class UpdateByAlternateIDFields
extends AbstractGPTool

Updates all the edge references in turn feature classes using an alternate ID field. This tool should be used after making edits to the input line features that are referenced by the turn features to synchronize the turn features based on the alternate ID fields. The Update by Alternate ID Fields tool is contained in the Network Analyst Tools tool box.

Usage tips:

• This tool updates the Edge#FID field values on the turn feature class based on the alternate IDs stored on each turn feature. If the turn feature classes do not reference the edges based on alternate IDs, use the tool first to create and populate alternate ID fields.

Field Summary

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

vals

Constructor Summary

UpdateByAlternateIDFields()
Creates the Update by Alternate ID Fields tool with defaults.

UpdateByAlternateIDFields(Object inNetworkDataset, String alternateIDFieldName)
Creates the Update by Alternate ID Fields tool with the required parameters.

Method Summary

String	getAlternateIDFieldName() Returns the Alternate ID Field Name parameter of this tool .
Object	getInNetworkDataset() Returns the Input Network Dataset parameter of this tool .
Object	getOutNetworkDataset() Returns the Output Network Dataset 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	setAlternateIDFieldName(String alternateIDFieldName) Sets the Alternate ID Field Name parameter of this tool .
void	setInNetworkDataset(Object inNetworkDataset) Sets the Input Network Dataset 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

UpdateByAlternateIDFields

public UpdateByAlternateIDFields()

Creates the Update by Alternate ID Fields tool with defaults.

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

UpdateByAlternateIDFields

public UpdateByAlternateIDFields(Object inNetworkDataset,
                                 String alternateIDFieldName)

Creates the Update by Alternate ID Fields 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:

inNetworkDataset - the network dataset whose turn feature classes are being updated by their alternate ID fields.

alternateIDFieldName - the name of the alternate ID field on the edge feature sources of the network dataset. All edge feature sources referenced by turns must have the same name for the alternate ID field.

Method Detail

getInNetworkDataset

public Object getInNetworkDataset()

Returns the Input Network Dataset parameter of this tool . This parameter is the network dataset whose turn feature classes are being updated by their alternate ID fields. This is a required parameter.

Returns:

the Input Network Dataset

setInNetworkDataset

public void setInNetworkDataset(Object inNetworkDataset)

Sets the Input Network Dataset parameter of this tool . This parameter is the network dataset whose turn feature classes are being updated by their alternate ID fields. This is a required parameter.

Parameters:

inNetworkDataset - the network dataset whose turn feature classes are being updated by their alternate ID fields.

getAlternateIDFieldName

public String getAlternateIDFieldName()

Returns the Alternate ID Field Name parameter of this tool . This parameter is the name of the alternate ID field on the edge feature sources of the network dataset. All edge feature sources referenced by turns must have the same name for the alternate ID field. This is a required parameter.

Returns:

the Alternate ID Field Name

setAlternateIDFieldName

public void setAlternateIDFieldName(String alternateIDFieldName)

Sets the Alternate ID Field Name parameter of this tool . This parameter is the name of the alternate ID field on the edge feature sources of the network dataset. All edge feature sources referenced by turns must have the same name for the alternate ID field. This is a required parameter.

Parameters:

alternateIDFieldName - the name of the alternate ID field on the edge feature sources of the network dataset. All edge feature sources referenced by turns must have the same name for the alternate ID field.

getOutNetworkDataset

public Object getOutNetworkDataset()

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

Returns:

the Output Network Dataset

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