com.esri.arcgis.trackinganalyst
Class ActionProcessor

java.lang.Object
  com.esri.arcgis.trackinganalyst.ActionProcessor

All Implemented Interfaces:

IActionProcessor, IActionState, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, IPersist, IPersistStream, ISupportErrorInfo, IActionUpdate, java.io.Externalizable, java.io.Serializable

public class ActionProcessor
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IActionProcessor, IPersistStream, IActionUpdate, IActionState, ISupportErrorInfo, IDocumentVersionSupportGEN, java.io.Externalizable

COM Class 'ActionProcessor'. Generated 3/19/2015 1:20:45 PM from 'C:\ArcGIS\COM\esriTrackingAnalyst.olb'

Description 'The Action Processor object processes all actions in the main actioncollection and children.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.carto.IActionProcessor

IID, IIDcc018a6f_24fb_11d4_b34c_00104ba2abcc, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.trackinganalyst.IActionUpdate

IID, IIDba1e1a12_2d56_4729_8717_c4b0ab4eeb7b, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IActionState

IID, IID4ff83f84_8159_46e6_9d6f_db91860190d7, xxDummy

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

ActionProcessor()
Constructs a ActionProcessor using ArcGIS Engine.

ActionProcessor(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ActionProcessor theActionProcessor = (ActionProcessor) obj;

Method Summary

void	checkLayers() Checks for deleted Layers and disables affected actions.
void	clearQueue() Purges the processing queue and terminates the processing of queued messages.
java.lang.Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
boolean	equals(java.lang.Object o) Compare this object with another
IActionCollection	getActions() Allows access to the action processor's action collection.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	getProcessorWaitTimeOut() Provides a configurable timeout for waiting to be able to process data objects, defaulted to 5 seconds.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	isDirty() isDirty
boolean	isExcludeRealtimeActions() Indicates if real-time actions are excluded from appearing on the interface.
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
boolean	isSuspended() Indicates whether the action processor will process any new data objects or any queued data objects.
void	load(IStream pstm) load
void	processData(java.lang.Object piObject, boolean bQueueProcessing, java.lang.Object pvarReturnedObjects) Takes an object as a parameter and runs it through an action list.
void	readExternal(java.io.ObjectInput in)
void	release() Release a ActionProcessor.
void	resetToDefaultState() Reset the State information to default.
void	save(IStream pstm, int fClearDirty) save
void	setActionsByRef(IActionCollection piActions) Allows access to the action processor's action collection.
void	setExcludeRealtimeActions(boolean pbvarExclude) Indicates if real-time actions are excluded from appearing on the interface.
void	setProcessorWaitTimeOut(int plProcessorWaitTimeOut) Provides a configurable timeout for waiting to be able to process data objects, defaulted to 5 seconds.
void	setSuspended(boolean pbvarSuspended) Indicates whether the action processor will process any new data objects or any queued data objects.
void	update() Notify a tracking action that lookup table values have changed.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

ActionProcessor

public ActionProcessor()
                throws java.io.IOException,
                       java.net.UnknownHostException

Constructs a ActionProcessor using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ActionProcessor

public ActionProcessor(java.lang.Object obj)
                throws java.io.IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a ActionProcessor.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

processData

public void processData(java.lang.Object piObject,
                        boolean bQueueProcessing,
                        java.lang.Object pvarReturnedObjects)
                 throws java.io.IOException,
                        AutomationException

Takes an object as a parameter and runs it through an action list.

Specified by:

processData in interface IActionProcessor

Parameters:

piObject - A reference to another Object (IUnknown) (in)

bQueueProcessing - The bQueueProcessing (in)

pvarReturnedObjects - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearQueue

public void clearQueue()
                throws java.io.IOException,
                       AutomationException

Purges the processing queue and terminates the processing of queued messages.

Specified by:

clearQueue in interface IActionProcessor

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSuspended

public boolean isSuspended()
                    throws java.io.IOException,
                           AutomationException

Indicates whether the action processor will process any new data objects or any queued data objects.

Specified by:

isSuspended in interface IActionProcessor

Returns:

The pbvarSuspended

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSuspended

public void setSuspended(boolean pbvarSuspended)
                  throws java.io.IOException,
                         AutomationException

Indicates whether the action processor will process any new data objects or any queued data objects.

Specified by:

setSuspended in interface IActionProcessor

Parameters:

pbvarSuspended - The pbvarSuspended (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActions

public IActionCollection getActions()
                             throws java.io.IOException,
                                    AutomationException

Allows access to the action processor's action collection.

Specified by:

getActions in interface IActionProcessor

Returns:

A reference to a com.esri.arcgis.carto.IActionCollection

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setActionsByRef

public void setActionsByRef(IActionCollection piActions)
                     throws java.io.IOException,
                            AutomationException

Allows access to the action processor's action collection.

Specified by:

setActionsByRef in interface IActionProcessor

Parameters:

piActions - A reference to a com.esri.arcgis.carto.IActionCollection (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProcessorWaitTimeOut

public int getProcessorWaitTimeOut()
                            throws java.io.IOException,
                                   AutomationException

Provides a configurable timeout for waiting to be able to process data objects, defaulted to 5 seconds.

Specified by:

getProcessorWaitTimeOut in interface IActionProcessor

Returns:

The plProcessorWaitTimeOut

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProcessorWaitTimeOut

public void setProcessorWaitTimeOut(int plProcessorWaitTimeOut)
                             throws java.io.IOException,
                                    AutomationException

Provides a configurable timeout for waiting to be able to process data objects, defaulted to 5 seconds.

Specified by:

setProcessorWaitTimeOut in interface IActionProcessor

Parameters:

plProcessorWaitTimeOut - The plProcessorWaitTimeOut (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isExcludeRealtimeActions

public boolean isExcludeRealtimeActions()
                                 throws java.io.IOException,
                                        AutomationException

Indicates if real-time actions are excluded from appearing on the interface.

Specified by:

isExcludeRealtimeActions in interface IActionProcessor

Returns:

The pbvarExclude

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExcludeRealtimeActions

public void setExcludeRealtimeActions(boolean pbvarExclude)
                               throws java.io.IOException,
                                      AutomationException

Indicates if real-time actions are excluded from appearing on the interface.

Specified by:

setExcludeRealtimeActions in interface IActionProcessor

Parameters:

pbvarExclude - The pbvarExclude (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

checkLayers

public void checkLayers()
                 throws java.io.IOException,
                        AutomationException

Checks for deleted Layers and disables affected actions.

Specified by:

checkLayers in interface IActionProcessor

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

update

public void update()
            throws java.io.IOException,
                   AutomationException

Notify a tracking action that lookup table values have changed.

Specified by:

update in interface IActionUpdate

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resetToDefaultState

public void resetToDefaultState()
                         throws java.io.IOException,
                                AutomationException

Reset the State information to default.

Specified by:

resetToDefaultState in interface IActionState

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws java.io.IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public java.lang.Object convertToSupportedObject(int docVersion)
                                          throws java.io.IOException,
                                                 AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException