com.esri.arcgis.geodatabase
Class TrafficData

java.lang.Object
  extended by com.esri.arcgis.geodatabase.TrafficData
All Implemented Interfaces:
IDynamicTrafficData, IHistoricalTrafficData, IHistoricalTrafficData2, ITrafficData, ITrafficData2, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class TrafficData
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ITrafficData, ITrafficData2, IHistoricalTrafficData, IHistoricalTrafficData2, IDynamicTrafficData

A container for members in traffic data.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
TrafficData()
          Constructs a TrafficData using ArcGIS Engine.
TrafficData(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TrafficData theTrafficData = (TrafficData) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 String getDynamicTrafficTableName()
          The name of the dynamic traffic table.
 String getDynamicTrafficTMCFieldName()
          The field name for the dynamic traffic TMCs in the dynamic traffic.
 String getFirstTimeSliceFieldName()
          The field name of the first time slice of the given period in the profile table.
 Date getFirstTimeSliceStartTime()
          The start time of valid period of a day for traffic data.
 String getJoinTableBaseSpeedFieldName()
          The field name for base speed in the join table.
 int getJoinTableBaseSpeedUnits()
          Base speed units.
 String getJoinTableBaseTravelTimeFieldName()
          The field name for base travel time in the join table.
 int getJoinTableBaseTravelTimeUnits()
          Base travel time units.
 String getJoinTableName()
          The name of the join table between edges and profiles.
 IStringArray getJoinTableProfileIDFieldNames()
          The field names of the historic join table pointing to speed profiles.
 String getLastTimeSliceFieldName()
          The field name of the last time slice of the given period in the profile table.
 String getLengthAttributeName()
          The field name for the length attribute.
 String getProfilesTableName()
          The name of the table containing profiles.
 double getTimeInterval()
          The time interval of the traffic data.
 int getTimeIntervalUnits()
          The units of the time interval of the traffic data.
 int getTimeSliceDurationInMinutes()
          The duration of time slice in minutes.
 ITrafficFeedLocation getTrafficFeedLocation()
          The traffic feed location.
 int hashCode()
          the hashcode for this object
 void setDynamicTrafficTableName(String dynamicTrafficTableName)
          The name of the dynamic traffic table.
 void setDynamicTrafficTMCFieldName(String dynamicTrafficTMCFieldName)
          The field name for the dynamic traffic TMCs in the dynamic traffic.
 void setFirstTimeSliceFieldName(String firstTimeSliceFieldName)
          The field name of the first time slice of the given period in the profile table.
 void setFirstTimeSliceStartTime(Date firstTimeSliceStartTime)
          The start time of valid period of a day for traffic data.
 void setJoinTableBaseSpeedFieldName(String fieldName)
          The field name for base speed in the join table.
 void setJoinTableBaseSpeedUnits(int units)
          Base speed units.
 void setJoinTableBaseTravelTimeFieldName(String fieldName)
          The field name for base travel time in the join table.
 void setJoinTableBaseTravelTimeUnits(int units)
          Base travel time units.
 void setJoinTableName(String joinTableName)
          The name of the join table between edges and profiles.
 void setJoinTableProfileIDFieldNamesByRef(IStringArray profileIDFields)
          The field names of the historic join table pointing to speed profiles.
 void setLastTimeSliceFieldName(String lastTimeSliceFieldName)
          The field name of the last time slice of the given period in the profile table.
 void setLengthAttributeName(String lengthAttributeName)
          The field name for the length attribute.
 void setProfilesTableName(String profilesTableName)
          The name of the table containing profiles.
 void setTimeSliceDurationInMinutes(int timeSliceDurationInMinutes)
          The duration of time slice in minutes.
 void setTrafficFeedLocationByRef(ITrafficFeedLocation trafficFeedLocation)
          The traffic feed location.
 
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

TrafficData

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

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

TrafficData

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

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

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

getTimeInterval

public double getTimeInterval()
                       throws IOException,
                              AutomationException
The time interval of the traffic data.

Product Availability

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

Specified by:
getTimeInterval in interface ITrafficData
Returns:
The timeInterval
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTimeIntervalUnits

public int getTimeIntervalUnits()
                         throws IOException,
                                AutomationException
The units of the time interval of the traffic data.

Product Availability

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

Specified by:
getTimeIntervalUnits in interface ITrafficData
Returns:
A com.esri.arcgis.system.esriTimeUnits constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLengthAttributeName

public String getLengthAttributeName()
                              throws IOException,
                                     AutomationException
The field name for the length attribute.

Product Availability

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

Specified by:
getLengthAttributeName in interface ITrafficData2
Returns:
The lengthAttributeName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLengthAttributeName

public void setLengthAttributeName(String lengthAttributeName)
                            throws IOException,
                                   AutomationException
The field name for the length attribute.

Product Availability

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

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

getProfilesTableName

public String getProfilesTableName()
                            throws IOException,
                                   AutomationException
The name of the table containing profiles.

Product Availability

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

Specified by:
getProfilesTableName in interface IHistoricalTrafficData
Returns:
The profilesTableName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setProfilesTableName

public void setProfilesTableName(String profilesTableName)
                          throws IOException,
                                 AutomationException
The name of the table containing profiles.

Product Availability

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

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

getTimeSliceDurationInMinutes

public int getTimeSliceDurationInMinutes()
                                  throws IOException,
                                         AutomationException
The duration of time slice in minutes.

Product Availability

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

Specified by:
getTimeSliceDurationInMinutes in interface IHistoricalTrafficData
Returns:
The timeSliceDurationInMinutes
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTimeSliceDurationInMinutes

public void setTimeSliceDurationInMinutes(int timeSliceDurationInMinutes)
                                   throws IOException,
                                          AutomationException
The duration of time slice in minutes.

Product Availability

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

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

getFirstTimeSliceStartTime

public Date getFirstTimeSliceStartTime()
                                throws IOException,
                                       AutomationException
The start time of valid period of a day for traffic data.

Product Availability

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

Specified by:
getFirstTimeSliceStartTime in interface IHistoricalTrafficData
Returns:
The firstTimeSliceStartTime
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFirstTimeSliceStartTime

public void setFirstTimeSliceStartTime(Date firstTimeSliceStartTime)
                                throws IOException,
                                       AutomationException
The start time of valid period of a day for traffic data.

Product Availability

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

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

getFirstTimeSliceFieldName

public String getFirstTimeSliceFieldName()
                                  throws IOException,
                                         AutomationException
The field name of the first time slice of the given period in the profile table.

Product Availability

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

Specified by:
getFirstTimeSliceFieldName in interface IHistoricalTrafficData
Returns:
The firstTimeSliceFieldName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFirstTimeSliceFieldName

public void setFirstTimeSliceFieldName(String firstTimeSliceFieldName)
                                throws IOException,
                                       AutomationException
The field name of the first time slice of the given period in the profile table.

Product Availability

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

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

getLastTimeSliceFieldName

public String getLastTimeSliceFieldName()
                                 throws IOException,
                                        AutomationException
The field name of the last time slice of the given period in the profile table.

Product Availability

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

Specified by:
getLastTimeSliceFieldName in interface IHistoricalTrafficData
Returns:
The lastTimeSliceFieldName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLastTimeSliceFieldName

public void setLastTimeSliceFieldName(String lastTimeSliceFieldName)
                               throws IOException,
                                      AutomationException
The field name of the last time slice of the given period in the profile table.

Product Availability

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

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

getJoinTableName

public String getJoinTableName()
                        throws IOException,
                               AutomationException
The name of the join table between edges and profiles.

Product Availability

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

Specified by:
getJoinTableName in interface IHistoricalTrafficData
Returns:
The joinTableName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setJoinTableName

public void setJoinTableName(String joinTableName)
                      throws IOException,
                             AutomationException
The name of the join table between edges and profiles.

Product Availability

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

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

getJoinTableBaseTravelTimeFieldName

public String getJoinTableBaseTravelTimeFieldName()
                                           throws IOException,
                                                  AutomationException
The field name for base travel time in the join table.

Product Availability

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

Specified by:
getJoinTableBaseTravelTimeFieldName in interface IHistoricalTrafficData
Returns:
The fieldName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setJoinTableBaseTravelTimeFieldName

public void setJoinTableBaseTravelTimeFieldName(String fieldName)
                                         throws IOException,
                                                AutomationException
The field name for base travel time in the join table.

Product Availability

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

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

getJoinTableBaseTravelTimeUnits

public int getJoinTableBaseTravelTimeUnits()
                                    throws IOException,
                                           AutomationException
Base travel time units.

Product Availability

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

Specified by:
getJoinTableBaseTravelTimeUnits in interface IHistoricalTrafficData
Returns:
A com.esri.arcgis.geodatabase.esriNetworkAttributeUnits constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setJoinTableBaseTravelTimeUnits

public void setJoinTableBaseTravelTimeUnits(int units)
                                     throws IOException,
                                            AutomationException
Base travel time units.

Product Availability

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

Specified by:
setJoinTableBaseTravelTimeUnits in interface IHistoricalTrafficData
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.

getJoinTableProfileIDFieldNames

public IStringArray getJoinTableProfileIDFieldNames()
                                             throws IOException,
                                                    AutomationException
The field names of the historic join table pointing to speed profiles.

Product Availability

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

Specified by:
getJoinTableProfileIDFieldNames in interface IHistoricalTrafficData
Returns:
A reference to a com.esri.arcgis.system.IStringArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setJoinTableProfileIDFieldNamesByRef

public void setJoinTableProfileIDFieldNamesByRef(IStringArray profileIDFields)
                                          throws IOException,
                                                 AutomationException
The field names of the historic join table pointing to speed profiles.

Product Availability

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

Specified by:
setJoinTableProfileIDFieldNamesByRef in interface IHistoricalTrafficData
Parameters:
profileIDFields - A reference to a com.esri.arcgis.system.IStringArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getJoinTableBaseSpeedFieldName

public String getJoinTableBaseSpeedFieldName()
                                      throws IOException,
                                             AutomationException
The field name for base speed in the join table.

Product Availability

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

Specified by:
getJoinTableBaseSpeedFieldName in interface IHistoricalTrafficData2
Returns:
The fieldName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setJoinTableBaseSpeedFieldName

public void setJoinTableBaseSpeedFieldName(String fieldName)
                                    throws IOException,
                                           AutomationException
The field name for base speed in the join table.

Product Availability

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

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

getJoinTableBaseSpeedUnits

public int getJoinTableBaseSpeedUnits()
                               throws IOException,
                                      AutomationException
Base speed units.

Product Availability

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

Specified by:
getJoinTableBaseSpeedUnits in interface IHistoricalTrafficData2
Returns:
A com.esri.arcgis.geodatabase.esriNetworkAttributeUnits constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setJoinTableBaseSpeedUnits

public void setJoinTableBaseSpeedUnits(int units)
                                throws IOException,
                                       AutomationException
Base speed units.

Product Availability

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

Specified by:
setJoinTableBaseSpeedUnits in interface IHistoricalTrafficData2
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.

getDynamicTrafficTableName

public String getDynamicTrafficTableName()
                                  throws IOException,
                                         AutomationException
The name of the dynamic traffic table.

Product Availability

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

Specified by:
getDynamicTrafficTableName in interface IDynamicTrafficData
Returns:
The dynamicTrafficTableName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDynamicTrafficTableName

public void setDynamicTrafficTableName(String dynamicTrafficTableName)
                                throws IOException,
                                       AutomationException
The name of the dynamic traffic table.

Product Availability

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

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

getDynamicTrafficTMCFieldName

public String getDynamicTrafficTMCFieldName()
                                     throws IOException,
                                            AutomationException
The field name for the dynamic traffic TMCs in the dynamic traffic.

Product Availability

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

Specified by:
getDynamicTrafficTMCFieldName in interface IDynamicTrafficData
Returns:
The dynamicTrafficTMCFieldName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDynamicTrafficTMCFieldName

public void setDynamicTrafficTMCFieldName(String dynamicTrafficTMCFieldName)
                                   throws IOException,
                                          AutomationException
The field name for the dynamic traffic TMCs in the dynamic traffic.

Product Availability

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

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

getTrafficFeedLocation

public ITrafficFeedLocation getTrafficFeedLocation()
                                            throws IOException,
                                                   AutomationException
The traffic feed location.

Product Availability

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

Specified by:
getTrafficFeedLocation in interface IDynamicTrafficData
Returns:
A reference to a com.esri.arcgis.geodatabase.ITrafficFeedLocation
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTrafficFeedLocationByRef

public void setTrafficFeedLocationByRef(ITrafficFeedLocation trafficFeedLocation)
                                 throws IOException,
                                        AutomationException
The traffic feed location.

Product Availability

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

Specified by:
setTrafficFeedLocationByRef in interface IDynamicTrafficData
Parameters:
trafficFeedLocation - A reference to a com.esri.arcgis.geodatabase.ITrafficFeedLocation (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.