com.esri.arcgis.trackinganalyst
Class ITemporalWorkspaceStatisticsProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      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 provides properties to indicate track count, message rate, sample size, total number of messages received, total number of messages pulled, total messages discarded, total number of messages queued for each temporal feature class under the workspace or workspace factory. This interface also provides methods to reset total feature count, message rate and sample size for all temporal feature classes under the workspace or workspace factory.

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

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

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

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, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noncastable

public boolean noncastable

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

This property provides the caller track count for each temporal feature class under the workspace or workspace factory. If the function is called by a workspace factory object, the name of each property shows as “WorkspaceName_FeatureClassName” in the property set. If the function is called by a workspace object, the name of each property shows as “FeatureClassName” in the property set.

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

This property provides the caller message rate (per second) for each temporal feature class under the workspace or workspace factory. If the function is called by a workspace factory object, the name of each property shows as “WorkspaceName_FeatureClassName” in the property set. If the function is called by a workspace object, the name of each property shows as “FeatureClassName” in the property set.

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

This property provides the caller sample size for each temporal feature class under the workspace or workspace factory. Sample size is the maximum number of most current samples used for computing message rate. If the total number of samples is less than the sample size, the total number of samples will be used for computing message rate. The default sample size is 500. If the function is called by a workspace factory object, the name of each property shows as “WorkspaceName_FeatureClassName” in the property set. If the function is called by a workspace object, the name of each property shows as “FeatureClassName” in the property set.

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

This property provides the caller total feature count for each temporal feature class under the workspace or workspace factory. If the function is called by a workspace factory object, the name of each property shows as “WorkspaceName_FeatureClassName” in the property set. If the function is called by a workspace object, the name of each property shows as “FeatureClassName” in the property set.

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

This property provides the caller connection status (esriWorkspaceConnectionStatus.esriWCSUp or esriWorkspaceConnectionStatus.esriWCSDown) for the workspace or each workspace under the workspace factory. If the function is called by a workspace factory object, the name of each property shows as “WorkspaceName_ConnectionName” in the property set. If the function is called by a workspace object, the name of each property shows as “ConnectionName” in the property set.

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.

Description

This property provides the caller total received message count for the workspace or each workspace under the workspace factory. If the function is called by a workspace factory object, the name of each property shows as “WorkspaceName_Received Message Count” in the property set. If the function is called by a workspace object, the name of each property shows as “Received Message Count” in the property set.

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.

Description

This property provides the caller total pulled message count for the workspace or each workspace under the workspace factory. Tracking Analyst stores received messages in an internal queue. Pulled message count is needed because some received messages could be discarded from the queue once the queue grows to exceed its pre-defined size. It could happen when, for instance, Tracking Analyst cannot process received messages at a rate faster than they are arriving. If the function is called by a workspace factory object, the name of each property shows as “WorkspaceName_Pulled Message Count” in the property set. If the function is called by a workspace object, the name of each property shows as “Pulled Message Count” in the property set.

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.

Description

This property provides the caller discarded message count for the workspace or each workspace under the workspace factory. Tracking Analyst stores received messages in an internal queue. Some messages could be discarded from the queue once the queue grows to exceed its pre-defined size. It could happen when, for instance, Tracking Analyst cannot process received messages at a rate faster than they are arriving. If the function is called by a workspace factory object, the name of each property shows as “WorkspaceName_Discarded Message Count” in the property set. If the function is called by a workspace object, the name of each property shows as “Discarded Message Count” in the property set.

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.

Description

This property provides the caller current discarded message count for the workspace or each workspace under the workspace factory. Tracking Analyst stores received messages in an internal queue. Some messages could be discarded from the queue once the queue grows to exceed its pre-defined size. It could happen when, for instance, Tracking Analyst cannot process received messages at a rate faster than they are arriving. The difference between current discarded message count and discarded message count is that current discarded message count resets once the internal message queue is no long full whereas discarded message count does not reset. If the function is called by a workspace factory object, the name of each property shows as “WorkspaceName_Discarded Message Count” in the property set. If the function is called by a workspace object, the name of each property shows as “Discarded Message Count” in the property set.

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.

Description

This property provides the caller queued message count for the workspace or each workspace under the workspace factory. Tracking Analyst stores received messages in an internal queue before they are pulled for processing. Queued message count indicates the number of messages currently in the queue waiting to be processed. If the function is called by a workspace factory object, the name of each property shows as “WorkspaceName_Discarded Message Count” in the property set. If the function is called by a workspace object, the name of each property shows as “Discarded Message Count” in the property set.

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

This method resets total feature count to zero for each temporal feature class under the workspace or workspace factory. This method is typically used when the user wants to count the total number of new features after a specific event or time.

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

This method resets message rate for each temporal feature class under the workspace or workspace factory. The message rate is determined by sampling a number (sample size) of received features. After the method is called, message rates will be calculated using only new features received after the method call. This method is typically used when the rate of incoming message changes so that historical data may affect the accuracy of the current message rate.

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

This method sets sample size for each temporal feature class under the workspace or workspace factory. Sample size is the number of samples used for calculating the message rate for a temporal feature class. (If the total number of messages received is less than the sample size, the message rate will be calculated based on the messages received.) The default value of sample size is 500.

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()