com.esri.arcgis.geodatabase
Class StreetNameFields

java.lang.Object
  extended by com.esri.arcgis.geodatabase.StreetNameFields
All Implemented Interfaces:
IStreetNameFields, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class StreetNameFields
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IStreetNameFields

A container for describing street name fields used to generate driving directions.

Description

StreetNameFields allows fine grained specification of network directions and the ability to associate multiple alternate names for a street in a network dataset. The StreetNameFields object should be added to an IArray object which is then supplied to the INetworkSourceDirections::StreetNameFields method.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
StreetNameFields()
          Constructs a StreetNameFields using ArcGIS Engine.
StreetNameFields(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
StreetNameFields theStreetNameFields = (StreetNameFields) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 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.
 int hashCode()
          the hashcode for this object
 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.
 
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

StreetNameFields

public StreetNameFields()
                 throws IOException,
                        UnknownHostException
Constructs a StreetNameFields using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

StreetNameFields

public StreetNameFields(Object obj)
                 throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
StreetNameFields theStreetNameFields = (StreetNameFields) obj;

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

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

getPrefixDirectionFieldName

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

Specified by:
getPrefixDirectionFieldName in interface IStreetNameFields
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPrefixDirectionFieldName

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

Specified by:
setPrefixDirectionFieldName in interface IStreetNameFields
Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPrefixTypeFieldName

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

Specified by:
getPrefixTypeFieldName in interface IStreetNameFields
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPrefixTypeFieldName

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

Specified by:
setPrefixTypeFieldName in interface IStreetNameFields
Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStreetNameFieldName

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

Specified by:
getStreetNameFieldName in interface IStreetNameFields
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStreetNameFieldName

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

Specified by:
setStreetNameFieldName in interface IStreetNameFields
Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSuffixTypeFieldName

public String getSuffixTypeFieldName()
                              throws IOException,
                                     AutomationException
The field name used for suffix type.

Product Availability

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

Specified by:
getSuffixTypeFieldName in interface IStreetNameFields
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSuffixTypeFieldName

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

Specified by:
setSuffixTypeFieldName in interface IStreetNameFields
Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSuffixDirectionFieldName

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

Specified by:
getSuffixDirectionFieldName in interface IStreetNameFields
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSuffixDirectionFieldName

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

Specified by:
setSuffixDirectionFieldName in interface IStreetNameFields
Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPriority

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

Specified by:
getPriority in interface IStreetNameFields
Returns:
The priority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPriority

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

Specified by:
setPriority in interface IStreetNameFields
Parameters:
priority - The priority (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.