com.esri.arcgis.geodatabase
Interface IStreetNameFields

All Superinterfaces:

Serializable

All Known Subinterfaces:

IStreetNameFields2

All Known Implementing Classes:

StreetNameFields

public interface IStreetNameFields
extends Serializable

Provides access to a container for describing the street name fields used in generating driving directions.

Remarks

The IStreetNameFields interface provides access to properties for setting the collection of name fields used in the generation of directions. Any number of IStreetNameFields can be associated with the INetworkSourceDirections interface. This allows directions with alternate street names to be generated on an analysis result.

At a minimum, the StreetNameFieldName and Priority properties should be set on an IStreetNameFields object.

Product Availability

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

Method Summary

String	getPrefixDirectionFieldName() The field name used for prefix direction.
String	getPrefixTypeFieldName() The field name used for prefix type.
int	getPriority() The priority for when these street name fields are used.
String	getStreetNameFieldName() The field name used for street name.
String	getSuffixDirectionFieldName() The field name used for suffix direction.
String	getSuffixTypeFieldName() The field name used for suffix type.
void	setPrefixDirectionFieldName(String name) The field name used for prefix direction.
void	setPrefixTypeFieldName(String name) The field name used for prefix type.
void	setPriority(int priority) The priority for when these street name fields are used.
void	setStreetNameFieldName(String name) The field name used for street name.
void	setSuffixDirectionFieldName(String name) The field name used for suffix direction.
void	setSuffixTypeFieldName(String name) The field name used for suffix type.

Method Detail

getPrefixDirectionFieldName

String getPrefixDirectionFieldName()
                                   throws IOException,
                                          AutomationException

The field name used for prefix direction.

Remarks

The field name containing the direcitonal prefix information. Typical values in these types of fields are: N, S, SE, etc.

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.

setPrefixDirectionFieldName

void setPrefixDirectionFieldName(String name)
                                 throws IOException,
                                        AutomationException

The field name used for prefix direction.

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.

getPrefixTypeFieldName

String getPrefixTypeFieldName()
                              throws IOException,
                                     AutomationException

The field name used for prefix type.

Remarks

The field name containing the prefix type information. Typical values in these types of fields are: Calle, STHY, etc.

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.

setPrefixTypeFieldName

void setPrefixTypeFieldName(String name)
                            throws IOException,
                                   AutomationException

The field name used for prefix type.

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.

getStreetNameFieldName

String getStreetNameFieldName()
                              throws IOException,
                                     AutomationException

The field name used for street name.

Remarks

The primary name for referring to a street in the directions. In order to associate other names with a particular street, create another IStreetNameFields object, associate the alterate name field with the StreetNameFieldName and set the priority to a value higher than the preceeding IStreetNameFields object.

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.

setStreetNameFieldName

void setStreetNameFieldName(String name)
                            throws IOException,
                                   AutomationException

The field name used for street name.

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.

getSuffixTypeFieldName

String getSuffixTypeFieldName()
                              throws IOException,
                                     AutomationException

The field name used for suffix type.

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.

setSuffixTypeFieldName

void setSuffixTypeFieldName(String name)
                            throws IOException,
                                   AutomationException

The field name used for suffix type.

Remarks

The field name containing the suffix type information. Typical values in these types of fields are: Str, Drive, Way, etc.

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.

getSuffixDirectionFieldName

String getSuffixDirectionFieldName()
                                   throws IOException,
                                          AutomationException

The field name used for suffix direction.

Remarks

The field name containing the direcitonal suffix information. Typical values in these types of fields are: N, S, SE, etc.

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.

setSuffixDirectionFieldName

void setSuffixDirectionFieldName(String name)
                                 throws IOException,
                                        AutomationException

The field name used for suffix direction.

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.

getPriority

int getPriority()
                throws IOException,
                       AutomationException

The priority for when these street name fields are used.

Remarks

The priority of the StreetNameFields collection. In order to designate a collection of fields as the primary StreetNameFields, set the Priority property to be 1. Other alternate collections of StreetNameFields may be specified.

Product Availability

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

Returns:

The priority

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPriority

void setPriority(int priority)
                 throws IOException,
                        AutomationException

The priority for when these street name fields are used.

Product Availability

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

Parameters:

priority - The priority (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.