com.esri.arcgis.networkanalyst
Interface INACandidateFieldMap

All Superinterfaces:

Serializable

All Known Implementing Classes:

NACandidateFieldMap

public interface INACandidateFieldMap
extends Serializable

Provides access to the default value and candidate fields for a field in an NAClass.

Remarks

INACandidateFieldMap is an interface on the NACandidateFieldMap object used to specify the default value and candidate field names for a particular field in an NAClass.

An NAClassCandidateFieldMap object holds an array of NACandidateFieldMap objects.

Within INAServer::Solve the information provided by INACandidateFieldMap is applied to an NAClassFieldMap object prior to loading network locations to specify the values of the network locations based on these default values and candidate fields.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

IStringArray	getCandidateFieldNames() CandidateFieldNames for the field.
Object	getDefaultValue() Default value for the field.
String	getFieldName() Name of the field.
void	setCandidateFieldNamesByRef(IStringArray ppCandidateFieldNames) CandidateFieldNames for the field.
void	setDefaultValue(Object defaultValue) Default value for the field.
void	setFieldName(String name) Name of the field.

Method Detail

getFieldName

String getFieldName()
                    throws IOException,
                           AutomationException

Name of the field.

Remarks

The FieldName is the name of the field that the default value and candidate field names apply to.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFieldName

void setFieldName(String name)
                  throws IOException,
                         AutomationException

Name of the field.

Remarks

The FieldName is the name of the field that the default value and candidate field names apply to.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultValue

Object getDefaultValue()
                       throws IOException,
                              AutomationException

Default value for the field.

Remarks

The DefaultValue specifies the value to use for this field of the network location. This value will be overridden if a candidate field name matches a field on the input cursor.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultValue

void setDefaultValue(Object defaultValue)
                     throws IOException,
                            AutomationException

Default value for the field.

Remarks

The DefaultValue specifies the value to use for this field of the network location. This value will be overridden if a candidate field name matches a field on the input cursor.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

defaultValue - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCandidateFieldNames

IStringArray getCandidateFieldNames()
                                    throws IOException,
                                           AutomationException

CandidateFieldNames for the field.

Remarks

The CandidateFieldNames specifies the possible field names to try to match with the input cursor. If the input cursor has a field with a name in the CandidateFieldNames, it uses the value from this field on the input feature to set the network location's field specified by FieldName.

If a candidate field name matches one of the input cursor's fields, the feature's field value overrides the DefaultValue unless the value is NULL in which case it uses the DefaultValue.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCandidateFieldNamesByRef

void setCandidateFieldNamesByRef(IStringArray ppCandidateFieldNames)
                                 throws IOException,
                                        AutomationException

CandidateFieldNames for the field.

Remarks

The CandidateFieldNames specifies the possible field names to try to match with the input cursor. If the input cursor has a field with a name in the CandidateFieldNames, it uses the value from this field on the input feature to set the network location's field specified by FieldName.

If a candidate field name matches one of the input cursor's fields, the feature's field value overrides the DefaultValue unless the value is NULL in which case it uses the DefaultValue.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

ppCandidateFieldNames - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.