com.esri.arcgis.geodatabase
Interface IShields

All Superinterfaces:

Serializable

All Known Implementing Classes:

Shields

public interface IShields
extends Serializable

Provides access to a container for refining directions with shields.

Description

The IShields interface provides members that are used for refining Directions, by allow the specification of Shield information, such as the type and number of a highway. Unlike the network source level directions information, such as IStreetNameFields , only one set of Shields information can be specified for a network dataset. Shield information is not required for Directions generation.

If shield data exists for a network source, it can be in one of two forms:

• All shield information is stored within a single field, with values such as T-C HWY 1 or US HWY 10
• The Type and Number are stored in separate fields

Product Availability

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

Method Summary

void	addShield(String type, String description) Adds a shield of the given type.
void	deleteShield(int index) Deletes a shield by index.
String	getCombinedFieldName() The field name whose values contain the whole address description.
String	getNumberFieldName() The field name whose values contain the house number.
int	getShieldCount() The number of shields.
String	getShieldDescription(int index) The shield description by index.
String	getShieldType(int index) The shield type by index.
String	getTypeFieldName() The field name whose values contain the street type.
boolean	isUseCombinedField() Indicates if the combined field should be used for directions.
void	setCombinedFieldName(String name) The field name whose values contain the whole address description.
void	setNumberFieldName(String name) The field name whose values contain the house number.
void	setTypeFieldName(String name) The field name whose values contain the street type.
void	setUseCombinedField(boolean useCombined) Indicates if the combined field should be used for directions.

Method Detail

getTypeFieldName

String getTypeFieldName()
                        throws IOException,
                               AutomationException

The field name whose values contain the street type.

Remarks

If Shields information is specified in two different fields, the field containing the Type information can be accessed and specified with the TypeFieldName property.

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.

setTypeFieldName

void setTypeFieldName(String name)
                      throws IOException,
                             AutomationException

The field name whose values contain the street 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.

getNumberFieldName

String getNumberFieldName()
                          throws IOException,
                                 AutomationException

The field name whose values contain the house number.

Remarks

If Shields information is specified in two different fields, the field containing the Number information can be accessed and specified with the NumberFieldName property.

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.

setNumberFieldName

void setNumberFieldName(String name)
                        throws IOException,
                               AutomationException

The field name whose values contain the house number.

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.

getCombinedFieldName

String getCombinedFieldName()
                            throws IOException,
                                   AutomationException

The field name whose values contain the whole address description.

Remarks

If the Shields information is specified within a single field, the field name can be specified and accessed through hte CombinedFieldName property.

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.

setCombinedFieldName

void setCombinedFieldName(String name)
                          throws IOException,
                                 AutomationException

The field name whose values contain the whole address description.

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.

isUseCombinedField

boolean isUseCombinedField()
                           throws IOException,
                                  AutomationException

Indicates if the combined field should be used for directions.

Remarks

If the Shields information is specified in a single field, the UseCombinedField should be set to True. If the Shields information is contained within two different fields, the UseCombinedField should be set to False.

Product Availability

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

Returns:

The useCombined

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseCombinedField

void setUseCombinedField(boolean useCombined)
                         throws IOException,
                                AutomationException

Indicates if the combined field should be used for directions.

Product Availability

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

Parameters:

useCombined - The useCombined (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShieldCount

int getShieldCount()
                   throws IOException,
                          AutomationException

The number of shields.

Remarks

Returns a count of the number of shields that have been specified.

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.

getShieldType

String getShieldType(int index)
                     throws IOException,
                            AutomationException

The shield type by index.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The type

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShieldDescription

String getShieldDescription(int index)
                            throws IOException,
                                   AutomationException

The shield description by index.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The type

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addShield

void addShield(String type,
               String description)
               throws IOException,
                      AutomationException

Adds a shield of the given type.

Remarks

The AddShield method should be used to add ShieldType, ShieldDescription pairs. When Directions are generated, the ShieldType value will be replaced by it's corresponding ShieldDescription. Examples of ShieldType and ShieldDescription pairs include:

ShieldType	ShieldDescription
I	Interstate
S	State
T	Trans Canada

Product Availability

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

Parameters:

type - The type (in)

description - The description (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteShield

void deleteShield(int index)
                  throws IOException,
                         AutomationException

Deletes a shield by index.

Remarks

DeleteShield removes the shield of the specified index from the collection.

Product Availability

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

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.