com.esri.arcgis.trackinganalyst
Class ActionLookupSources

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

All Implemented Interfaces:

IActionLookupSources, IPersist, IPersistStream, ISupportErrorInfo, java.io.Serializable

public class ActionLookupSources

extends java.lang.Object

implements IActionLookupSources, IPersistStream, ISupportErrorInfo

Contains the sources for lookup tables

Product Availability

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

Description

The ActionLookupSource object contains information about how to read and what contents are stored in an action lookup repository. This repository can be:

• comma delimeted text file
• geodabase table

The repository contains columns of lookup values that will be used to build an SQL in statement within each of the core actions upon user request. This allows users to manage complex in statements using a common repository rather than individual conditional statements per action.

Example text repository.

Sample repository file

EVENT_ID, CENTER
OIL, G
OIL579, F
OIL714, J
OIL1172, K

Where the first row defines the column names and the subsequent rows define the data values to substitute in the SQL expression. This would equate to a SQL where statement like CENTER IN('G', 'F', 'J', 'K') if you use the CENTER column or EVENT_ID IN('OIL', 'OIL579', 'OIL714', 'OIL1172') if you use the EVENT_ID column for your lookup values.

See Also:

Serialized Form

Constructor Summary

ActionLookupSources()
Constructs a ActionLookupSources using ArcGIS Engine.

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

Method Summary

void	addLookupSource(IName name) Add lookup data source.
void	clearLookupSources() Clear all lookup sources.
void	deleteLookupSource(java.lang.String name) Delete lookup data source by name.
boolean	equals(java.lang.Object o) Compare this object with another
IActionLookupSources	getAsIActionLookupSources() 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.
ISupportErrorInfo	getAsISupportErrorInfo() 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()
IPropertySet	getLookupSources() All lookup data sources.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) Supported Platforms
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) Supported Platforms
void	isDirty() Supported Platforms
void	load(IStream pstm) Supported Platforms
void	save(IStream pstm, int fClearDirty) Supported Platforms

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionLookupSources

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

Constructs a ActionLookupSources using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ActionLookupSources

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

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

Construct a ActionLookupSources using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ActionLookupSources.
ActionLookupSources theActionLookupSources = (ActionLookupSources) 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()

getAsIActionLookupSources

public IActionLookupSources getAsIActionLookupSources()

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.

getAsISupportErrorInfo

public ISupportErrorInfo getAsISupportErrorInfo()

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

addLookupSource

public void addLookupSource(IName name)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IActionLookupSources

Add lookup data source.

Specified by:

addLookupSource in interface IActionLookupSources

Parameters:

name - A reference to a com.esri.arcgis.system.IName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLookupSources

public IPropertySet getLookupSources()
                              throws java.io.IOException,
                                     AutomationException

Description copied from interface: IActionLookupSources

All lookup data sources.

Specified by:

getLookupSources in interface IActionLookupSources

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

clearLookupSources

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

Description copied from interface: IActionLookupSources

Clear all lookup sources.

Specified by:

clearLookupSources in interface IActionLookupSources

Throws:

AutomationException - If the ArcObject component throws an exception.

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

deleteLookupSource

public void deleteLookupSource(java.lang.String name)
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IActionLookupSources

Delete lookup data source by name.

Specified by:

deleteLookupSource in interface IActionLookupSources

Parameters:

name - The name (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.

interfaceSupportsErrorInfo

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

Description copied from interface: ISupportErrorInfo

Supported Platforms

Windows, Solaris, Linux

Description

Indicates whether the interface supports IErrorInfo.

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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