|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.trackinganalyst.ActionProcessor
public class ActionProcessor
The Action Processor object processes all actions in the main actioncollection and children.
The Action processor object is the main controller for processing action collections. An Action is an object that performs analysis or processes data as it comes into one of the folowing tracking analyst systems:
Currently Tracking Analyst supports the following types of actions:
Name | Description |
---|---|
TagAction | This action runs in the TrackingServer system and places a Tagged value in the DataMessage Tag property when its condition is satisfied. |
FilterAction | This action runs in all three systems and filters the DataMessage or Feature from further processing. |
HighlightSuppressionAction | This action only runs within the TrackingAnalyst Layer system and provides highlighting or suppression of features as they are displayed or rendered within the Map display. |
VisualBasicAction | This action only runs within the Tracking Analyst Server connection and executes Visual basic code when the condition of the action is satisfied. |
Constructor Summary | |
---|---|
ActionProcessor()
Constructs a ActionProcessor using ArcGIS Engine. |
|
ActionProcessor(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. |
Object |
convertToSupportedObject(int docVersion)
Convert the object to another object that is supported. |
boolean |
equals(Object o)
Compare this object with another |
IActionCollection |
getActions()
Allows access to the action processor's action collection. |
void |
getClassID(GUID[] pClassID)
getClassID |
static String |
getClsid()
getClsid. |
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(Object piObject,
boolean bQueueProcessing,
Object pvarReturnedObjects)
Takes an object as a parameter and runs it through an action list. |
void |
readExternal(ObjectInput in)
|
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(ObjectOutput out)
|
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 |
---|
public ActionProcessor() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic ActionProcessor(Object obj) throws IOException
ActionProcessor theActionProcessor = (ActionProcessor) obj;
obj
to ActionProcessor
.
obj
- an object returned from ArcGIS Engine or Server
IOException
- if there are interop problemsMethod Detail |
---|
public static String getClsid()
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public void processData(Object piObject, boolean bQueueProcessing, Object pvarReturnedObjects) throws IOException, AutomationException
processData
in interface IActionProcessor
piObject
- A reference to another Object (IUnknown) (in)bQueueProcessing
- The bQueueProcessing (in)pvarReturnedObjects
- A Variant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void clearQueue() throws IOException, AutomationException
clearQueue
in interface IActionProcessor
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isSuspended() throws IOException, AutomationException
isSuspended
in interface IActionProcessor
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSuspended(boolean pbvarSuspended) throws IOException, AutomationException
setSuspended
in interface IActionProcessor
pbvarSuspended
- The pbvarSuspended (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IActionCollection getActions() throws IOException, AutomationException
getActions
in interface IActionProcessor
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setActionsByRef(IActionCollection piActions) throws IOException, AutomationException
setActionsByRef
in interface IActionProcessor
piActions
- A reference to a com.esri.arcgis.carto.IActionCollection (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getProcessorWaitTimeOut() throws IOException, AutomationException
getProcessorWaitTimeOut
in interface IActionProcessor
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setProcessorWaitTimeOut(int plProcessorWaitTimeOut) throws IOException, AutomationException
setProcessorWaitTimeOut
in interface IActionProcessor
plProcessorWaitTimeOut
- The plProcessorWaitTimeOut (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isExcludeRealtimeActions() throws IOException, AutomationException
isExcludeRealtimeActions
in interface IActionProcessor
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setExcludeRealtimeActions(boolean pbvarExclude) throws IOException, AutomationException
setExcludeRealtimeActions
in interface IActionProcessor
pbvarExclude
- The pbvarExclude (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void checkLayers() throws IOException, AutomationException
checkLayers
in interface IActionProcessor
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void isDirty() throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
isDirty
in interface IPersistStream
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void load(IStream pstm) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
load
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void save(IStream pstm, int fClearDirty) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
save
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)fClearDirty
- The fClearDirty (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getSizeMax(_ULARGE_INTEGER[] pcbSize) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
getSizeMax
in interface IPersistStream
pcbSize
- A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getClassID(GUID[] pClassID) throws IOException, AutomationException
IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.
getClassID
in interface IPersist
pClassID
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void update() throws IOException, AutomationException
update
in interface IActionUpdate
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void resetToDefaultState() throws IOException, AutomationException
resetToDefaultState
in interface IActionState
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void interfaceSupportsErrorInfo(GUID riid) throws IOException, AutomationException
Indicates whether the interface supports IErrorInfo.
interfaceSupportsErrorInfo
in interface ISupportErrorInfo
riid
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isSupportedAtVersion(int docVersion) throws IOException, AutomationException
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.
isSupportedAtVersion
in interface IDocumentVersionSupportGEN
docVersion
- A com.esri.arcgis.system.esriArcGISVersion constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object convertToSupportedObject(int docVersion) throws IOException, AutomationException
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.
convertToSupportedObject
in interface IDocumentVersionSupportGEN
docVersion
- A com.esri.arcgis.system.esriArcGISVersion constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void writeExternal(ObjectOutput out) throws IOException
writeExternal
in interface Externalizable
IOException
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
readExternal
in interface Externalizable
IOException
ClassNotFoundException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |