com.esri.arcgis.geodatabase
Class Shields

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

All Implemented Interfaces:

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

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

COM Class 'Shields'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriGeoDatabase.olb'

Description 'A container for describing how driving directions are refined using shields.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.geodatabase.IShields

IID, IID9e82750b_bddc_40a1_9a63_ff699ffc55e1, xxDummy

Constructor Summary

Shields()
Constructs a Shields using ArcGIS Engine.

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

Method Summary

void	addShield(java.lang.String type, java.lang.String description) Adds a shield of the given type.
void	deleteShield(int index) Deletes a shield by index.
boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
java.lang.String	getCombinedFieldName() The field name whose values contain the whole address description.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getNumberFieldName() The field name whose values contain the house number.
int	getShieldCount() The number of shields.
java.lang.String	getShieldDescription(int index) The shield description by index.
java.lang.String	getShieldType(int index) The shield type by index.
java.lang.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	release() Release a Shields.
void	setCombinedFieldName(java.lang.String name) The field name whose values contain the whole address description.
void	setNumberFieldName(java.lang.String name) The field name whose values contain the house number.
void	setTypeFieldName(java.lang.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

Constructor Detail

Shields

public Shields()
        throws java.io.IOException,
               java.net.UnknownHostException

Constructs a Shields using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

Shields

public Shields(java.lang.Object obj)
        throws java.io.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:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a Shields.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getTypeFieldName

public java.lang.String getTypeFieldName()
                                  throws java.io.IOException,
                                         AutomationException

The field name whose values contain the street type.

Specified by:

getTypeFieldName in interface IShields

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTypeFieldName

public void setTypeFieldName(java.lang.String name)
                      throws java.io.IOException,
                             AutomationException

The field name whose values contain the street type.

Specified by:

setTypeFieldName in interface IShields

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumberFieldName

public java.lang.String getNumberFieldName()
                                    throws java.io.IOException,
                                           AutomationException

The field name whose values contain the house number.

Specified by:

getNumberFieldName in interface IShields

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNumberFieldName

public void setNumberFieldName(java.lang.String name)
                        throws java.io.IOException,
                               AutomationException

The field name whose values contain the house number.

Specified by:

setNumberFieldName in interface IShields

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCombinedFieldName

public java.lang.String getCombinedFieldName()
                                      throws java.io.IOException,
                                             AutomationException

The field name whose values contain the whole address description.

Specified by:

getCombinedFieldName in interface IShields

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCombinedFieldName

public void setCombinedFieldName(java.lang.String name)
                          throws java.io.IOException,
                                 AutomationException

The field name whose values contain the whole address description.

Specified by:

setCombinedFieldName in interface IShields

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseCombinedField

public boolean isUseCombinedField()
                           throws java.io.IOException,
                                  AutomationException

Indicates if the combined field should be used for directions.

Specified by:

isUseCombinedField in interface IShields

Returns:

The useCombined

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseCombinedField

public void setUseCombinedField(boolean useCombined)
                         throws java.io.IOException,
                                AutomationException

Indicates if the combined field should be used for directions.

Specified by:

setUseCombinedField in interface IShields

Parameters:

useCombined - The useCombined (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShieldCount

public int getShieldCount()
                   throws java.io.IOException,
                          AutomationException

The number of shields.

Specified by:

getShieldCount in interface IShields

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShieldType

public java.lang.String getShieldType(int index)
                               throws java.io.IOException,
                                      AutomationException

The shield type by index.

Specified by:

getShieldType in interface IShields

Parameters:

index - The index (in)

Returns:

The type

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShieldDescription

public java.lang.String getShieldDescription(int index)
                                      throws java.io.IOException,
                                             AutomationException

The shield description by index.

Specified by:

getShieldDescription in interface IShields

Parameters:

index - The index (in)

Returns:

The type

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addShield

public void addShield(java.lang.String type,
                      java.lang.String description)
               throws java.io.IOException,
                      AutomationException

Adds a shield of the given type.

Specified by:

addShield in interface IShields

Parameters:

type - The type (in)

description - The description (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteShield

public void deleteShield(int index)
                  throws java.io.IOException,
                         AutomationException

Deletes a shield by index.

Specified by:

deleteShield in interface IShields

Parameters:

index - The index (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.