com.esri.arcgis.trackinganalyst
Class ActionEnvironment

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

All Implemented Interfaces:

IActionLookupSupport, IPersist, IPersistStream, java.io.Serializable

public class ActionEnvironment

extends java.lang.Object

implements IActionLookupSupport, IPersistStream

Manager of lookup tables and other environmental action properties

Product Availability

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

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.

See Also:

Serialized Form

Constructor Summary

ActionEnvironment()
Constructs a ActionEnvironment using ArcGIS Engine.

ActionEnvironment(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary

void	close() Close the Action Environment.
boolean	equals(java.lang.Object o) Compare this object with another
java.lang.String	expandQuery(java.lang.String bstrQuery) Insert lookup table values into query string.
IActionLookupSources	getActionLookupSources() Lookup data sources.
IActionLookupSupport	getAsIActionLookupSupport() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersistStream	getAsIPersistStream() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
void	getClassID(GUID[] pClassID) Supported Platforms
static java.lang.String	getClsid()
int	getRefreshRate() RefreshRate for lookup tables.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) Supported Platforms
int	hashCode() the hashcode for this object
void	isDirty() Supported Platforms
IEnumVARIANT	listDataValues(java.lang.String bstrLookupTableName, java.lang.String bstrFieldName, int[] peFieldType) Retrieve list of data values from lookup table.
IEnumBSTR	listFields(java.lang.String bstrLookupTableName) Retrieve list of field names from lookup table.
void	load(IStream pstm) Supported Platforms
void	readDataValues(java.lang.String bstrLookupTableName) Read data values from lookup table.
void	register(IActionProcessor actionProcessor) Register an Action Processor.
void	save(IStream pstm, int fClearDirty) Supported Platforms
void	setRefreshRate(int pMinutes) RefreshRate for lookup tables.
void	unRegister(IActionProcessor actionProcessor) Unregister an Action Processor.

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionEnvironment

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

Constructs a ActionEnvironment using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ActionEnvironment

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

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

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.
ActionEnvironment theActionEnvironment = (ActionEnvironment) obj;

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

getAsIActionLookupSupport

public IActionLookupSupport getAsIActionLookupSupport()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersistStream

public IPersistStream getAsIPersistStream()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

getActionLookupSources

public IActionLookupSources getActionLookupSources()
                                            throws java.io.IOException,
                                                   AutomationException

Description copied from interface: IActionLookupSupport

Lookup data sources.

Specified by:

getActionLookupSources in interface IActionLookupSupport

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRefreshRate

public void setRefreshRate(int pMinutes)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IActionLookupSupport

RefreshRate for lookup tables.

Specified by:

setRefreshRate in interface IActionLookupSupport

Parameters:

pMinutes - The pMinutes (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getRefreshRate

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

Description copied from interface: IActionLookupSupport

RefreshRate for lookup tables.

Specified by:

getRefreshRate in interface IActionLookupSupport

Returns:

The pMinutes

Throws:

AutomationException - If the ArcObject component throws an exception.

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

readDataValues

public void readDataValues(java.lang.String bstrLookupTableName)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IActionLookupSupport

Read data values from lookup table.

Specified by:

readDataValues in interface IActionLookupSupport

Parameters:

bstrLookupTableName - The bstrLookupTableName (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

expandQuery

public java.lang.String expandQuery(java.lang.String bstrQuery)
                             throws java.io.IOException,
                                    AutomationException

Description copied from interface: IActionLookupSupport

Insert lookup table values into query string.

Specified by:

expandQuery in interface IActionLookupSupport

Parameters:

bstrQuery - The bstrQuery (in)

Returns:

The pExpandedQuery

Throws:

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

AutomationException - If the ArcObject component throws an exception.

listDataValues

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

Description copied from interface: IActionLookupSupport

Retrieve list of data values from lookup table.

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:

AutomationException - If the ArcObject component throws an exception.

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

listFields

public IEnumBSTR listFields(java.lang.String bstrLookupTableName)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IActionLookupSupport

Retrieve list of field names from lookup table.

Specified by:

listFields in interface IActionLookupSupport

Parameters:

bstrLookupTableName - The bstrLookupTableName (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

close

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

Description copied from interface: IActionLookupSupport

Close the Action Environment.

Specified by:

close in interface IActionLookupSupport

Throws:

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

AutomationException - If the ArcObject component throws an exception.

register

public void register(IActionProcessor actionProcessor)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IActionLookupSupport

Register an Action Processor.

Specified by:

register in interface IActionLookupSupport

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

unRegister

public void unRegister(IActionProcessor actionProcessor)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IActionLookupSupport

Unregister an Action Processor.

Specified by:

unRegister in interface IActionLookupSupport

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isDirty

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

save

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getClassID

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

Description copied from interface: IPersist

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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