com.esri.arcgis.networkanalyst
Interface INAClassFieldMap

All Superinterfaces:

Serializable

All Known Implementing Classes:

NAClassFieldMap

public interface INAClassFieldMap
extends Serializable

Provides access to the the mapping of input fields to output fields.

Remarks

The INAClassFieldMap interface provides access to a collection of field map items. When used with NAClassLoader::Load, each field map item associates a field in the input row with a field in a NAClass.

The DefaultValue property is used when the input row has a null field value or no field mapping is specified.

Product Availability

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

Method Summary

void	createMapping(INAClassDefinition classDef, IFields fields) Creates a new field name mapping.
int	getCount() The count of field mappings defined.
Object	getDefaultValue(String fieldName) The default field value for a given input field name.
String	getFieldName(int index) The mapping for the given index.
String	getMappedField(String fieldName) The output field name mapped to a given input field name.
void	remove(String fieldName) Removes the entry for an existing field name mapping.
void	setDefaultValue(String fieldName, Object value) The default field value for a given input field name.
void	setMappedField(String fieldName, String mappedField) The output field name mapped to a given input field name.

Method Detail

setMappedField

void setMappedField(String fieldName,
                    String mappedField)
                    throws IOException,
                           AutomationException

The output field name mapped to a given input field name.

Product Availability

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

Parameters:

fieldName - The fieldName (in)

mappedField - The mappedField (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMappedField

String getMappedField(String fieldName)
                      throws IOException,
                             AutomationException

The output field name mapped to a given input field name.

Product Availability

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

Parameters:

fieldName - The fieldName (in)

Returns:

The mappedField

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultValue

void setDefaultValue(String fieldName,
                     Object value)
                     throws IOException,
                            AutomationException

The default field value for a given input field name.

Product Availability

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

Parameters:

fieldName - The fieldName (in)

value - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultValue

Object getDefaultValue(String fieldName)
                       throws IOException,
                              AutomationException

The default field value for a given input field name.

Product Availability

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

Parameters:

fieldName - The fieldName (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

void remove(String fieldName)
            throws IOException,
                   AutomationException

Removes the entry for an existing field name mapping.

Remarks

Resets and clears any exising field mapping definitions.

Product Availability

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

Parameters:

fieldName - The fieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createMapping

void createMapping(INAClassDefinition classDef,
                   IFields fields)
                   throws IOException,
                          AutomationException

Creates a new field name mapping.

Remarks

CreateMapping generates the default mapping for fields based on the inbound INAClassDefinition parameter. The default mapping is based on matching the INAClassDefinition::CandidateFieldNames of the input INAClassDefinition to the field names in the input IFields parameter. Each matched field will be stored in the NAClassFieldMap object and is accessible via the MappedField method.

Product Availability

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

Parameters:

classDef - A reference to a com.esri.arcgis.networkanalyst.INAClassDefinition (in)

fields - A reference to a com.esri.arcgis.geodatabase.IFields (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

int getCount()
             throws IOException,
                    AutomationException

The count of field mappings defined.

Remarks

Count returns the number of fields that have default values or mapped fields.

Product Availability

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

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldName

String getFieldName(int index)
                    throws IOException,
                           AutomationException

The mapping for the given index.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.