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

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

All Implemented Interfaces:

GPTool

public class AddFieldToAnalysisLayer
extends AbstractGPTool

Adds a field to a sublayer of a network analysis layer. The Add Field to Analysis Layer tool is contained in the Network Analyst Tools tool box.

Usage tips:

• The tool is mostly used along with the tool to transfer fields from the input features to the sublayers. For example, if you want to transfer a field called UniqueID from your input features into the Facilities sublayer of the Service Area layer, use this tool to first add the UniqueID field to the Facilities sublayer, and then use the field mappings in the Add Locations tool to provide input values for the UniqueID field.
• Fields can be added to any of the sublayers of the network analysis layers.

Field Summary

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

vals

Constructor Summary

AddFieldToAnalysisLayer()
Creates the Add Field to Analysis Layer tool with defaults.

AddFieldToAnalysisLayer(Object inNetworkAnalysisLayer, String subLayer, String fieldName, String fieldType)
Creates the Add Field to Analysis Layer tool with the required parameters.

Method Summary

String	getFieldAlias() Returns the Field alias parameter of this tool .
String	getFieldIsNullable() Returns the Field IsNullable parameter of this tool .
int	getFieldLength() Returns the Field length parameter of this tool .
String	getFieldName() Returns the Field name parameter of this tool .
int	getFieldPrecision() Returns the Field precision parameter of this tool .
int	getFieldScale() Returns the Field scale parameter of this tool .
String	getFieldType() Returns the Field type parameter of this tool .
Object	getInNetworkAnalysisLayer() Returns the Input network analysis layer parameter of this tool .
Object	getOutputLayer() Returns the Network Analyst Layer parameter of this tool (Read only).
String	getSubLayer() Returns the Sub layer 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	setFieldAlias(String fieldAlias) Sets the Field alias parameter of this tool .
void	setFieldIsNullable(String fieldIsNullable) Sets the Field IsNullable parameter of this tool .
void	setFieldLength(int fieldLength) Sets the Field length parameter of this tool .
void	setFieldName(String fieldName) Sets the Field name parameter of this tool .
void	setFieldPrecision(int fieldPrecision) Sets the Field precision parameter of this tool .
void	setFieldScale(int fieldScale) Sets the Field scale parameter of this tool .
void	setFieldType(String fieldType) Sets the Field type parameter of this tool .
void	setInNetworkAnalysisLayer(Object inNetworkAnalysisLayer) Sets the Input network analysis layer parameter of this tool .
void	setSubLayer(String subLayer) Sets the Sub layer 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

AddFieldToAnalysisLayer

public AddFieldToAnalysisLayer()

Creates the Add Field to Analysis Layer tool with defaults.

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

AddFieldToAnalysisLayer

public AddFieldToAnalysisLayer(Object inNetworkAnalysisLayer,
                               String subLayer,
                               String fieldName,
                               String fieldType)

Creates the Add Field to Analysis Layer 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:

inNetworkAnalysisLayer - network analysis layer to which the new field will be added.

subLayer - the sublayer of the network analysis layer to which the new field will be added.

fieldName - the name of the field that will be added to the specified sublayer of the network analysis layer.

fieldType - the field type used in the creation of the new field.

Method Detail

getInNetworkAnalysisLayer

public Object getInNetworkAnalysisLayer()

Returns the Input network analysis layer parameter of this tool . This parameter is network analysis layer to which the new field will be added. This is a required parameter.

Returns:

the Input network analysis layer

setInNetworkAnalysisLayer

public void setInNetworkAnalysisLayer(Object inNetworkAnalysisLayer)

Sets the Input network analysis layer parameter of this tool . This parameter is network analysis layer to which the new field will be added. This is a required parameter.

Parameters:

inNetworkAnalysisLayer - network analysis layer to which the new field will be added.

getSubLayer

public String getSubLayer()

Returns the Sub layer parameter of this tool . This parameter is the sublayer of the network analysis layer to which the new field will be added. This is a required parameter.

Returns:

the Sub layer

setSubLayer

public void setSubLayer(String subLayer)

Sets the Sub layer parameter of this tool . This parameter is the sublayer of the network analysis layer to which the new field will be added. This is a required parameter.

Parameters:

subLayer - the sublayer of the network analysis layer to which the new field will be added.

getFieldName

public String getFieldName()

Returns the Field name parameter of this tool . This parameter is the name of the field that will be added to the specified sublayer of the network analysis layer. This is a required parameter.

Returns:

the Field name

setFieldName

public void setFieldName(String fieldName)

Sets the Field name parameter of this tool . This parameter is the name of the field that will be added to the specified sublayer of the network analysis layer. This is a required parameter.

Parameters:

fieldName - the name of the field that will be added to the specified sublayer of the network analysis layer.

getFieldType

public String getFieldType()

Returns the Field type parameter of this tool . This parameter is the field type used in the creation of the new field. This is a required parameter.

Returns:

the Field type

setFieldType

public void setFieldType(String fieldType)

Sets the Field type parameter of this tool . This parameter is the field type used in the creation of the new field. This is a required parameter.

Parameters:

fieldType - the field type used in the creation of the new field.

getFieldPrecision

public int getFieldPrecision()

Returns the Field precision parameter of this tool . This parameter is describes the number of digits that can be stored in the field. All digits are counted no matter what side of the decimal they are on. the parameter value is valid only for numeric field types. This is an optional parameter.

Returns:

the Field precision

setFieldPrecision

public void setFieldPrecision(int fieldPrecision)

Sets the Field precision parameter of this tool . This parameter is describes the number of digits that can be stored in the field. All digits are counted no matter what side of the decimal they are on. the parameter value is valid only for numeric field types. This is an optional parameter.

Parameters:

fieldPrecision - describes the number of digits that can be stored in the field. All digits are counted no matter what side of the decimal they are on. the parameter value is valid only for numeric field types.

getFieldScale

public int getFieldScale()

Returns the Field scale parameter of this tool . This parameter is sets the number of decimal places stored in a field. This parameter is only used in Float and Double data field types. This is an optional parameter.

Returns:

the Field scale

setFieldScale

public void setFieldScale(int fieldScale)

Sets the Field scale parameter of this tool . This parameter is sets the number of decimal places stored in a field. This parameter is only used in Float and Double data field types. This is an optional parameter.

Parameters:

fieldScale - sets the number of decimal places stored in a field. This parameter is only used in Float and Double data field types.

getFieldLength

public int getFieldLength()

Returns the Field length parameter of this tool . This parameter is the length of the field being added. This sets the maximum number of allowable characters for each record of the field. This option is only applicable on fields of type text or blob. This is an optional parameter.

Returns:

the Field length

setFieldLength

public void setFieldLength(int fieldLength)

Sets the Field length parameter of this tool . This parameter is the length of the field being added. This sets the maximum number of allowable characters for each record of the field. This option is only applicable on fields of type text or blob. This is an optional parameter.

Parameters:

fieldLength - the length of the field being added. This sets the maximum number of allowable characters for each record of the field. This option is only applicable on fields of type text or blob.

getFieldAlias

public String getFieldAlias()

Returns the Field alias parameter of this tool . This parameter is the alternate name given to the field name. This name is used to give more descriptive names to cryptic field names. The field alias parameter only applies to geodatabases and coverages. This is an optional parameter.

Returns:

the Field alias

setFieldAlias

public void setFieldAlias(String fieldAlias)

Sets the Field alias parameter of this tool . This parameter is the alternate name given to the field name. This name is used to give more descriptive names to cryptic field names. The field alias parameter only applies to geodatabases and coverages. This is an optional parameter.

Parameters:

fieldAlias - the alternate name given to the field name. This name is used to give more descriptive names to cryptic field names. The field alias parameter only applies to geodatabases and coverages.

getFieldIsNullable

public String getFieldIsNullable()

Returns the Field IsNullable parameter of this tool . This parameter is a geographic feature where there is no associated attribute information. These are different from zero or empty fields and are only supported for fields in a geodatabase. This is an optional parameter.

Returns:

the Field IsNullable

setFieldIsNullable

public void setFieldIsNullable(String fieldIsNullable)

Sets the Field IsNullable parameter of this tool . This parameter is a geographic feature where there is no associated attribute information. These are different from zero or empty fields and are only supported for fields in a geodatabase. This is an optional parameter.

Parameters:

fieldIsNullable - a geographic feature where there is no associated attribute information. These are different from zero or empty fields and are only supported for fields in a geodatabase.

getOutputLayer

public Object getOutputLayer()

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

Returns:

the Network Analyst Layer

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