com.esri.arcgis.datasourcesfile
Class SDCNetworkAttribute

java.lang.Object
  com.esri.arcgis.datasourcesfile.SDCNetworkAttribute

All Implemented Interfaces:

IGPDescribe, INetworkAttribute, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class SDCNetworkAttribute
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INetworkAttribute, IGPDescribe

A container for describing a SDC network dataset attribute.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

SDCNetworkAttribute()
Constructs a SDCNetworkAttribute using ArcGIS Engine.

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

Method Summary

Object	describe(String name) The description of the named object.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
int	getDataType() Type of data used in this network attribute.
int	getID() Unique identifier of this network attribute.
String	getName() Name of this network attribute.
int	getUnits() Units of this network attribute.
int	getUsageType() Usage type of this network attribute.
int	hashCode() the hashcode for this object
void	setDataType(int dataType) Type of data used in this network attribute.
void	setName(String attributeName) Name of this network attribute.
void	setUnits(int units) Units of this network attribute.
void	setUsageType(int usageType) Usage type of this network attribute.

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

SDCNetworkAttribute

public SDCNetworkAttribute()
                    throws IOException,
                           UnknownHostException

Constructs a SDCNetworkAttribute using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

SDCNetworkAttribute

public SDCNetworkAttribute(Object obj)
                    throws IOException

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

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

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

getName

public String getName()
               throws IOException,
                      AutomationException

Name of this network attribute.

Product Availability

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

Specified by:

getName in interface INetworkAttribute

Returns:

The attributeName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String attributeName)
             throws IOException,
                    AutomationException

Name of this network attribute.

Product Availability

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

Specified by:

setName in interface INetworkAttribute

Parameters:

attributeName - The attributeName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getID

public int getID()
          throws IOException,
                 AutomationException

Unique identifier of this network attribute.

Product Availability

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

Specified by:

getID in interface INetworkAttribute

Returns:

The attributeID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataType

public int getDataType()
                throws IOException,
                       AutomationException

Type of data used in this network attribute.

Remarks

The DataType for the network attribute can be either Integer, Float, Double, or Boolean.

Depending on the UsageType for the network attribute, only certain DataTypes are allowed:

UsageType:	Allowed DataTypes:
esriNAUTCost	esriNADTInteger, esriNADTFloat, esriNADTDouble
esriNAUTDescriptor	esriNADTInteger, esriNADTFloat, esriNADTDouble, esriNADTBoolean
esriNAUTRestriction	esriNADTBoolean
esriNAUTHierarchy	esriNADTInteger

Product Availability

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

Specified by:

getDataType in interface INetworkAttribute

Returns:

A com.esri.arcgis.geodatabase.esriNetworkAttributeDataType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDataType

public void setDataType(int dataType)
                 throws IOException,
                        AutomationException

Type of data used in this network attribute.

Product Availability

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

Specified by:

setDataType in interface INetworkAttribute

Parameters:

dataType - A com.esri.arcgis.geodatabase.esriNetworkAttributeDataType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUsageType

public int getUsageType()
                 throws IOException,
                        AutomationException

Usage type of this network attribute.

Remarks

The UsageType for the network attribute can be either Cost, Descriptor, Restriction, or Hierarchy.

Depending on the UsageType for the network attribute, only certain DataTypes are allowed:

UsageType:	Allowed DataTypes:
esriNAUTCost	esriNADTInteger, esriNADTFloat, esriNADTDouble
esriNAUTDescriptor	esriNADTInteger, esriNADTFloat, esriNADTDouble, esriNADTBoolean
esriNAUTRestriction	esriNADTBoolean
esriNAUTHierarchy	esriNADTInteger

Product Availability

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

Specified by:

getUsageType in interface INetworkAttribute

Returns:

A com.esri.arcgis.geodatabase.esriNetworkAttributeUsageType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUsageType

public void setUsageType(int usageType)
                  throws IOException,
                         AutomationException

Usage type of this network attribute.

Product Availability

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

Specified by:

setUsageType in interface INetworkAttribute

Parameters:

usageType - A com.esri.arcgis.geodatabase.esriNetworkAttributeUsageType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUnits

public int getUnits()
             throws IOException,
                    AutomationException

Units of this network attribute.

Remarks

If the attribute is not measured in units of distance or time, specify the Units as esriNAUUnknown.

Product Availability

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

Specified by:

getUnits in interface INetworkAttribute

Returns:

A com.esri.arcgis.geodatabase.esriNetworkAttributeUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUnits

public void setUnits(int units)
              throws IOException,
                     AutomationException

Units of this network attribute.

Product Availability

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

Specified by:

setUnits in interface INetworkAttribute

Parameters:

units - A com.esri.arcgis.geodatabase.esriNetworkAttributeUnits constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

describe

public Object describe(String name)
                throws IOException,
                       AutomationException

The description of the named object.

Product Availability

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

Specified by:

describe in interface IGPDescribe

Parameters:

name - The name (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.