com.esri.arcgis.geodatabase
Class Shields

java.lang.Object
  com.esri.arcgis.geodatabase.Shields

All Implemented Interfaces:

IShields, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class Shields
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IShields

A container for describing how driving directions are refined using shields.

Description

Sheilds provides access to members that refine the driving directions generated on a network result analysis, by allowing the number and type of a highway to be specified. In some cases, this can also include a general direction of travel, such as North (N) or South (S).

Product Availability

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

See Also:

Serialized Form

Constructor Summary

Shields()
Constructs a Shields using ArcGIS Engine.

Shields(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
Shields theShields = (Shields) obj;

Method Summary

void	addShield(String type, String description) Adds a shield of the given type.
void	deleteShield(int index) Deletes a shield by index.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
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.
int	hashCode() the hashcode for this object
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

Shields

public Shields()
        throws IOException,
               UnknownHostException

Constructs a Shields using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

Shields

public Shields(Object obj)
        throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
Shields theShields = (Shields) obj;

Construct a Shields using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to Shields.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getTypeFieldName

public 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.

Specified by:

getTypeFieldName in interface IShields

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTypeFieldName

public 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.

Specified by:

setTypeFieldName in interface IShields

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumberFieldName

public 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.

Specified by:

getNumberFieldName in interface IShields

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNumberFieldName

public 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.

Specified by:

setNumberFieldName in interface IShields

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCombinedFieldName

public 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.

Specified by:

getCombinedFieldName in interface IShields

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCombinedFieldName

public 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.

Specified by:

setCombinedFieldName in interface IShields

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseCombinedField

public 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.

Specified by:

isUseCombinedField in interface IShields

Returns:

The useCombined

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseCombinedField

public 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.

Specified by:

setUseCombinedField in interface IShields

Parameters:

useCombined - The useCombined (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShieldCount

public 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.

Specified by:

getShieldCount in interface IShields

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShieldType

public String getShieldType(int index)
                     throws IOException,
                            AutomationException

The shield type by index.

Product Availability

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

Specified by:

getShieldType in interface IShields

Parameters:

index - The index (in)

Returns:

The type

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShieldDescription

public String getShieldDescription(int index)
                            throws IOException,
                                   AutomationException

The shield description by index.

Product Availability

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

Specified by:

getShieldDescription in interface IShields

Parameters:

index - The index (in)

Returns:

The type

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addShield

public 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.

Specified by:

addShield in interface IShields

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

public 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.

Specified by:

deleteShield in interface IShields

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.