com.esri.arcgis.trackinganalyst
Class ITemporalWorkspaceStatisticsProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.trackinganalyst.ITemporalWorkspaceStatisticsProxy
All Implemented Interfaces:
ITemporalWorkspaceStatistics, Externalizable, Serializable

public class ITemporalWorkspaceStatisticsProxy
extends com.esri.arcgis.interop.Dispatch
implements ITemporalWorkspaceStatistics, Serializable

Provides access to properties and methods needed to manage message rate statistics in workspace.

Description

This interface is new at ArcGIS 9.3.

Remarks

ITemporalWorkspaceStatistics provides a central location to obtain the statistics for all of the feature classes contained in the workspace.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

See Also:
ITemporalFeatureClassStatistics, Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  ITemporalWorkspaceStatisticsProxy()
           
  ITemporalWorkspaceStatisticsProxy(Object obj)
           
protected ITemporalWorkspaceStatisticsProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 IPropertySet getAllMessageRates()
          Indicates message rate for each TemporalFeatureClass under the workspace or workspace factory.
 IPropertySet getAllSampleSizes()
          Indicates sample size used for calculating message rate for each TemporalFeatureClass under the workspace or workspace factory.
 IPropertySet getAllTotalFeatureCounts()
          Indicates the total number of features logged for each TemporalFeatureClass under the workspace or workspace factory.
 IPropertySet getAllTrackCounts()
          Indicates track count for each TemporalFeatureClass under the workspace or workspace factory.
 IPropertySet getConnectionStatus()
          Indicates the connection status of each workspace under the workspace factory
 IPropertySet getCurrentDiscardedMessageCounts()
          Indicates current number of messages discarded.
 IPropertySet getDiscardedMessageCounts()
          Indicates total number of messages discarded.
 IPropertySet getPulledMessageCounts()
          Indicates total number of messages pulled.
 IPropertySet getQueuedMessageCounts()
          Indicates total number of messages queued.
 IPropertySet getReceivedMessageCounts()
          Indicates total number of messages received.
 void readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 void resetAllFeatureCounts()
          Resets total feature count for each TemporalFeatureClass under the workspace or workspace factory.
 void resetAllMessageRates()
          Resets message rate for each TemporalFeatureClass under the workspace or workspace factory.
 void setAllSampleSizes(int lSampleSize)
          Sets sample size for each TemporalFeatureClass under the workspace or workspace factory.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ITemporalWorkspaceStatisticsProxy

public ITemporalWorkspaceStatisticsProxy()

ITemporalWorkspaceStatisticsProxy

public ITemporalWorkspaceStatisticsProxy(Object obj)
                                  throws IOException
Throws:
IOException

ITemporalWorkspaceStatisticsProxy

protected ITemporalWorkspaceStatisticsProxy(Object obj,
                                            String iid)
                                     throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

getAllTrackCounts

public IPropertySet getAllTrackCounts()
                               throws IOException,
                                      AutomationException
Indicates track count for each TemporalFeatureClass under the workspace or workspace factory.

Description

Retrieves the track counts from all of the feature classes in the workspace. The name of each property in the PropertySet is the feature class name and the value is the output from IFeatureClassStatistics::get_TrackCount.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getAllTrackCounts in interface ITemporalWorkspaceStatistics
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ITemporalWorkspaceStatistics.getAllTrackCounts(), ITemporalFeatureClassStatistics.getTrackCount()

getAllMessageRates

public IPropertySet getAllMessageRates()
                                throws IOException,
                                       AutomationException
Indicates message rate for each TemporalFeatureClass under the workspace or workspace factory.

Description

Retrieves the message rates from all of the feature classes in the workspace. The name of each property in the PropertySet is the feature class name and the value is the output from IFeatureClassStatistics::get_MessageRate.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getAllMessageRates in interface ITemporalWorkspaceStatistics
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ITemporalWorkspaceStatistics.getAllSampleSizes(), ITemporalWorkspaceStatistics.setAllSampleSizes(int)

getAllSampleSizes

public IPropertySet getAllSampleSizes()
                               throws IOException,
                                      AutomationException
Indicates sample size used for calculating message rate for each TemporalFeatureClass under the workspace or workspace factory.

Description

Retrieves the sample sizes from all of the feature classes in the workspace. The name of each property in the PropertySet is the feature class name and the value is the output from IFeatureClassStatistics::get_SampleSize.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getAllSampleSizes in interface ITemporalWorkspaceStatistics
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ITemporalWorkspaceStatistics.getAllMessageRates(), ITemporalWorkspaceStatistics.setAllSampleSizes(int)

getAllTotalFeatureCounts

public IPropertySet getAllTotalFeatureCounts()
                                      throws IOException,
                                             AutomationException
Indicates the total number of features logged for each TemporalFeatureClass under the workspace or workspace factory.

Description

Retrieves the total feature counts from all of the feature classes in the workspace. The name of each property in the PropertySet is the feature class name and the value is the output from IFeatureClassStatistics::get_TotalFeatureCount.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getAllTotalFeatureCounts in interface ITemporalWorkspaceStatistics
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ITemporalWorkspaceStatistics.resetAllFeatureCounts()

getConnectionStatus

public IPropertySet getConnectionStatus()
                                 throws IOException,
                                        AutomationException
Indicates the connection status of each workspace under the workspace factory

Description

Returns the current state of workspace's connection to the server. The propery's name is the name of the connection and its value is an esriWorkspaceConnectionStatus.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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

getReceivedMessageCounts

public IPropertySet getReceivedMessageCounts()
                                      throws IOException,
                                             AutomationException
Indicates total number of messages received.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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

getPulledMessageCounts

public IPropertySet getPulledMessageCounts()
                                    throws IOException,
                                           AutomationException
Indicates total number of messages pulled.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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

getDiscardedMessageCounts

public IPropertySet getDiscardedMessageCounts()
                                       throws IOException,
                                              AutomationException
Indicates total number of messages discarded.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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

getCurrentDiscardedMessageCounts

public IPropertySet getCurrentDiscardedMessageCounts()
                                              throws IOException,
                                                     AutomationException
Indicates current number of messages discarded.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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

getQueuedMessageCounts

public IPropertySet getQueuedMessageCounts()
                                    throws IOException,
                                           AutomationException
Indicates total number of messages queued.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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

resetAllFeatureCounts

public void resetAllFeatureCounts()
                           throws IOException,
                                  AutomationException
Resets total feature count for each TemporalFeatureClass under the workspace or workspace factory.

Description

Resets the total feature counts on all of the feature classes in the workspace.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
resetAllFeatureCounts in interface ITemporalWorkspaceStatistics
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ITemporalWorkspaceStatistics.getAllTotalFeatureCounts()

resetAllMessageRates

public void resetAllMessageRates()
                          throws IOException,
                                 AutomationException
Resets message rate for each TemporalFeatureClass under the workspace or workspace factory.

Description

Resets the message rates on all of the feature classes in the workspace.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
resetAllMessageRates in interface ITemporalWorkspaceStatistics
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ITemporalWorkspaceStatistics.getAllMessageRates()

setAllSampleSizes

public void setAllSampleSizes(int lSampleSize)
                       throws IOException,
                              AutomationException
Sets sample size for each TemporalFeatureClass under the workspace or workspace factory.

Description

Sets the message rate sample size for all of the feature classes in the workspace. This method is convenient, but may result in less than optimal sampling sizes if the feature classes in the workspace are receiving data at different rates. In this case you should use ITemporalFeatureClassStatistics::put_SampleSize to fine tune individual sampling sizes.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setAllSampleSizes in interface ITemporalWorkspaceStatistics
Parameters:
lSampleSize - The lSampleSize (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ITemporalWorkspaceStatistics.getAllMessageRates(), ITemporalWorkspaceStatistics.getAllSampleSizes(), ITemporalFeatureClassStatistics.getMessageRate()

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException