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

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

All Implemented Interfaces:

GPTool

public class PopulateAlternateIDFields
extends AbstractGPTool

Creates and populates additional fields on the turn feature classes that reference the edges by alternate IDs. The alternate IDs allow for another set of IDs that can help maintain the integrity of the turn features in case the source edges are being edited. The Populate Alternate ID Fields tool is contained in the Network Analyst Tools tool box.

Usage tips:

• The tool creates and populates new fields called AltID, where n is the maximum number of edges per turn. For example, for two-edge turn feature classes, the tool creates and populates fields called AltID1 and AltID2.
• Shapefiles do not have a persistent unique identifier, unlike the geodatabase's ObjectID field. Alternate IDs can avoid the ID shift problem commonly encountered when working with turn feature classes in a shapefile workspace.
• If the edge feature sources do not have an alternate ID field, for example, a unique identifier provided by a data vendor, then you must create and populate such a field so that it can used by this tool to reference the turn features.

Field Summary

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

vals

Constructor Summary

PopulateAlternateIDFields()
Creates the Populate Alternate ID Fields tool with defaults.

PopulateAlternateIDFields(Object inNetworkDataset, String alternateIDFieldName)
Creates the Populate 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

PopulateAlternateIDFields

public PopulateAlternateIDFields()

Creates the Populate Alternate ID Fields tool with defaults.

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

PopulateAlternateIDFields

public PopulateAlternateIDFields(Object inNetworkDataset,
                                 String alternateIDFieldName)

Creates the Populate 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 to receive alternate ID fields. The fields will be created on all of the turn feature classes added as a turn source to the network dataset.

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 to receive alternate ID fields. The fields will be created on all of the turn feature classes added as a turn source to the network dataset. 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 to receive alternate ID fields. The fields will be created on all of the turn feature classes added as a turn source to the network dataset. This is a required parameter.

Parameters:

inNetworkDataset - the network dataset whose turn feature classes are to receive alternate ID fields. The fields will be created on all of the turn feature classes added as a turn source to the network dataset.

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