com.esri.arcgis.trackinganalyst
Class ActionEnvironment

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, IPersist, IPersistStream, ISupportErrorInfo, IActionLookupSupport, Externalizable, Serializable

public class ActionEnvironment
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IActionLookupSupport, IPersistStream, IPersist, ISupportErrorInfo, IDocumentVersionSupportGEN, Externalizable

Manager of lookup tables and other environmental action properties.

Description

The Action Enviroment object serves as a central point of entry for general action properties that apply to all actions within a process. The Action Envirnment currently manages the ActionLookup table support. This support includes the automatic refreshing of lookup values based on user criteria as well as access to the ActionLookupSources that controls what files, or geodatabase tables will be used to create the lookup values.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

ActionEnvironment()
Constructs a ActionEnvironment using ArcGIS Engine.

ActionEnvironment(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ActionEnvironment theActionEnvironment = (ActionEnvironment) obj;

Method Summary

void	close() Close the Action Environment.
Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
boolean	equals(Object o) Compare this object with another
String	expandQuery(String bstrQuery) Insert lookup table values into query string.
IActionLookupSources	getActionLookupSources() Lookup data sources.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
int	getRefreshRate() RefreshRate for lookup tables.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	isDirty() isDirty
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
IEnumVARIANT	listDataValues(String bstrLookupTableName, String bstrFieldName, int[] peFieldType) Retrieve list of data values from lookup table.
IEnumBSTR	listFields(String bstrLookupTableName) Retrieve list of field names from lookup table.
void	load(IStream pstm) load
void	readDataValues(String bstrLookupTableName) Read data values from lookup table.
void	readExternal(ObjectInput in)
void	register(IActionProcessor actionProcessor) Register an Action Processor.
void	save(IStream pstm, int fClearDirty) save
void	setRefreshRate(int pMinutes) RefreshRate for lookup tables.
void	unRegister(IActionProcessor actionProcessor) Unregister an Action Processor.
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

ActionEnvironment

public ActionEnvironment()
                  throws IOException,
                         UnknownHostException

Constructs a ActionEnvironment using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ActionEnvironment

public ActionEnvironment(Object obj)
                  throws IOException

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

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

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

getActionLookupSources

public IActionLookupSources getActionLookupSources()
                                            throws IOException,
                                                   AutomationException

Lookup data sources.

Description

This property retrieves lookup data sources. The returned ActionLookupSources objects contains information about how to read and what contents are stored in an action lookup repository. This repository can be comma delimited text files or geodatabase table.

Product Availability

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

Specified by:

getActionLookupSources in interface IActionLookupSupport

Returns:

A reference to a com.esri.arcgis.trackinganalyst.IActionLookupSources

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRefreshRate

public void setRefreshRate(int pMinutes)
                    throws IOException,
                           AutomationException

RefreshRate for lookup tables.

Product Availability

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

Specified by:

setRefreshRate in interface IActionLookupSupport

Parameters:

pMinutes - The pMinutes (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRefreshRate

public int getRefreshRate()
                   throws IOException,
                          AutomationException

RefreshRate for lookup tables.

Description

This property indicates the refresh rate for lookup tables.

Product Availability

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

Specified by:

getRefreshRate in interface IActionLookupSupport

Returns:

The pMinutes

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

readDataValues

public void readDataValues(String bstrLookupTableName)
                    throws IOException,
                           AutomationException

Read data values from lookup table.

Product Availability

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

Specified by:

readDataValues in interface IActionLookupSupport

Parameters:

bstrLookupTableName - The bstrLookupTableName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

expandQuery

public String expandQuery(String bstrQuery)
                   throws IOException,
                          AutomationException

Insert lookup table values into query string.

Product Availability

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

Specified by:

expandQuery in interface IActionLookupSupport

Parameters:

bstrQuery - The bstrQuery (in)

Returns:

The pExpandedQuery

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

listDataValues

public IEnumVARIANT listDataValues(String bstrLookupTableName,
                                   String bstrFieldName,
                                   int[] peFieldType)
                            throws IOException,
                                   AutomationException

Retrieve list of data values from lookup table.

Product Availability

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

Specified by:

listDataValues in interface IActionLookupSupport

Parameters:

bstrLookupTableName - The bstrLookupTableName (in)

bstrFieldName - The bstrFieldName (in)

peFieldType - A com.esri.arcgis.geodatabase.esriFieldType constant (out: use single element array)

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.IEnumVARIANT

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

listFields

public IEnumBSTR listFields(String bstrLookupTableName)
                     throws IOException,
                            AutomationException

Retrieve list of field names from lookup table.

Product Availability

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

Specified by:

listFields in interface IActionLookupSupport

Parameters:

bstrLookupTableName - The bstrLookupTableName (in)

Returns:

A reference to a com.esri.arcgis.system.IEnumBSTR

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

close

public void close()
           throws IOException,
                  AutomationException

Close the Action Environment.

Product Availability

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

Specified by:

close in interface IActionLookupSupport

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

register

public void register(IActionProcessor actionProcessor)
              throws IOException,
                     AutomationException

Register an Action Processor.

Product Availability

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

Specified by:

register in interface IActionLookupSupport

Parameters:

actionProcessor - A reference to a com.esri.arcgis.carto.IActionProcessor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

unRegister

public void unRegister(IActionProcessor actionProcessor)
                throws IOException,
                       AutomationException

Unregister an Action Processor.

Product Availability

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

Specified by:

unRegister in interface IActionLookupSupport

Parameters:

actionProcessor - A reference to a com.esri.arcgis.carto.IActionProcessor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

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

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws 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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public Object convertToSupportedObject(int docVersion)
                                throws 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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException