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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.networkanalysttools.UpdateByAlternateIDFields
All Implemented Interfaces:
GPTool

public class UpdateByAlternateIDFields
extends AbstractGPTool

Updates all the edge references in each turn feature class in a network dataset using an alternate ID field. The Update by Alternate ID Fields tool is contained in the Network Analyst Tools tool box.

Software restrictions: none

Usage tips:


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 - Network Dataset Layer, the network dataset whose turn feature classes are having their alternate ID fields updated.
alternateIDFieldName - String, the name of the alternate ID fields 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 Network Dataset Layer, the network dataset whose turn feature classes are having their alternate ID fields updated. 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 Network Dataset Layer, the network dataset whose turn feature classes are having their alternate ID fields updated. This is a required parameter.

Parameters:
inNetworkDataset - Network Dataset Layer, the network dataset whose turn feature classes are having their alternate ID fields updated.

getAlternateIDFieldName

public String getAlternateIDFieldName()
Returns the Alternate ID Field Name parameter of this tool . This parameter is String, the name of the alternate ID fields 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 String, the name of the alternate ID fields 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 - String, the name of the alternate ID fields 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