com.esri.arcgis.trackinganalyst
Class PlugIn

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

All Implemented Interfaces:

IConnectionPointContainer, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, IClientConnection, ICOMClient, ICOMClient2, IConnection, IPlugin, java.io.Serializable

public class PlugIn
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IPlugin, IConnection, ICOMClient, ICOMClient2, IClientConnection, ISupportErrorInfo, IConnectionPointContainer

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

Description 'Base class for data links for Tracking Server.' 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

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

IID, IIDcc018a10_24fb_11d4_b34c_00104ba2abcc, xxDummy

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

IID, IIDcc018a0b_24fb_11d4_b34c_00104ba2abcc, xxDummy

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

IID, IID39ead7c7_1dfd_4767_996e_2f634454bf35, xxDummy

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

IIDcc018a0d_24fb_11d4_b34c_00104ba2abcc

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

IID, IIDcc018a0c_24fb_11d4_b34c_00104ba2abcc, xxDummy

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

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer

IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy

Constructor Summary

PlugIn()
Constructs a PlugIn using ArcGIS Engine.

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

Method Summary

void	add_IPlugInEventsListener(_IPlugInEvents theListener) add_IPlugInEventsListener.
void	connect(java.lang.String szConnectionString) Connects the client to the Tracking Server.
void	disableDataDefinition(java.lang.String bstrDataDefinitionID) Disables data definition for the data link.
void	disconnect() Disconnects data link.
void	enableDataDefinition(java.lang.String bstrDataDefinitionID) Enables data definition for the data link.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(java.lang.Object o) Compare this object with another
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
int	getClientQueueCount() Number of messages in the client queue.waiting to be read by the client object or system of this data link.
static java.lang.String	getClsid() getClsid.
java.lang.Object	getDataFilters() An array of Dataset Definition IDs that are currently Allowed to be read by the plugin when data filtering is enabled.
IDatasetDef	getDataSetDefinition(java.lang.String bstrName) Gets dataset definition information for the data link.
java.lang.Object	getDataSetDefinitionList() An array of all dataset defintion names that are defined in the TrackingServer that the data link is connected to.
int	getErrorCode() Value for the error code in the data connection.
int	getEventHandle() The handle to the event that is signaled when data is ready to be received.
java.lang.String	getID() Unique identifier of the current instance of the data link.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
IMessage	getMessage(int nTimeOut) Returns a message from the Tracking Server.
IMessage	getMessageWithStatus(int timeOut, long[] status) Returns a message from the Tracking Server.
java.lang.String	getName() Name of data link plugin.
int	getServerQueueCount() Number of messages waiting to be published to the server.
int	getStatus() Indicates status of the data link plugin.
java.lang.Object	getTimeEstablished() Indicates the time the data link plugin was established.
int	getTotalClientMessageCount() Total number of client messages in the data link plugin.
int	getTotalServerMessageCount() Total number of server messages in the data link plugin.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isEnableDataFiltering() Indicates whether data filtering is enabled for the data link.
IMessage	popClientMessage(int nTimeOut) Retrieves a client message from the data link.
void	postClientMessage(IMessage piMessage) Posts a client message to the data link.
void	postMessage(IMessage piMessage) Posts a message to the Tracking Server.
void	release() Release a PlugIn.
void	remove_IPlugInEventsListener(_IPlugInEvents theListener) remove_IPlugInEventsListener.
void	returnDataSetDefinition(IDatasetDef piDataSetDef) Returns dataset definition information for the dta link.
IResponseMessage	sendCommand(ICommandMessage piCmdMsg, int nTimeOut) Sends a command to the data link.
void	setEnableDataFiltering(boolean pbvVal) Indicates whether data filtering is enabled for the data link.
void	setErrorCode(int pVal) Value for the error code in the data connection.
void	setID(java.lang.String pVal) ID value for the data in the connection.
void	setName(java.lang.String pVal) Name of data link plugin.

Methods inherited from class java.lang.Object

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

Constructor Detail

PlugIn

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

Constructs a PlugIn using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

PlugIn

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

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

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

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

add_IPlugInEventsListener

public void add_IPlugInEventsListener(_IPlugInEvents theListener)
                               throws java.io.IOException

add_IPlugInEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.trackinganalyst._IPlugInEvents interface.

Throws:

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

remove_IPlugInEventsListener

public void remove_IPlugInEventsListener(_IPlugInEvents theListener)
                                  throws java.io.IOException

remove_IPlugInEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.trackinganalyst._IPlugInEvents interface.

Throws:

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

release

public void release()

Release a PlugIn.

Specified by:

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

getDataFilters

public java.lang.Object getDataFilters()
                                throws java.io.IOException,
                                       AutomationException

An array of Dataset Definition IDs that are currently Allowed to be read by the plugin when data filtering is enabled.

Specified by:

getDataFilters in interface IClientConnection

Specified by:

getDataFilters in interface IConnection

Specified by:

getDataFilters in interface IPlugin

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getID

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

Unique identifier of the current instance of the data link.

Specified by:

getID in interface IClientConnection

Specified by:

getID in interface ICOMClient

Specified by:

getID in interface IConnection

Specified by:

getID in interface IPlugin

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

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

Name of data link plugin.

Specified by:

getName in interface IClientConnection

Specified by:

getName in interface ICOMClient

Specified by:

getName in interface IConnection

Specified by:

getName in interface IPlugin

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String pVal)
             throws java.io.IOException,
                    AutomationException

Name of data link plugin.

Specified by:

setName in interface IClientConnection

Specified by:

setName in interface ICOMClient

Specified by:

setName in interface IConnection

Specified by:

setName in interface IPlugin

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServerQueueCount

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

Number of messages waiting to be published to the server.

Specified by:

getServerQueueCount in interface IClientConnection

Specified by:

getServerQueueCount in interface IConnection

Specified by:

getServerQueueCount in interface IPlugin

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClientQueueCount

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

Number of messages in the client queue.waiting to be read by the client object or system of this data link.

Specified by:

getClientQueueCount in interface IClientConnection

Specified by:

getClientQueueCount in interface IConnection

Specified by:

getClientQueueCount in interface IPlugin

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeEstablished

public java.lang.Object getTimeEstablished()
                                    throws java.io.IOException,
                                           AutomationException

Indicates the time the data link plugin was established.

Specified by:

getTimeEstablished in interface IClientConnection

Specified by:

getTimeEstablished in interface IConnection

Specified by:

getTimeEstablished in interface IPlugin

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTotalServerMessageCount

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

Total number of server messages in the data link plugin.

Specified by:

getTotalServerMessageCount in interface IClientConnection

Specified by:

getTotalServerMessageCount in interface IConnection

Specified by:

getTotalServerMessageCount in interface IPlugin

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTotalClientMessageCount

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

Total number of client messages in the data link plugin.

Specified by:

getTotalClientMessageCount in interface IClientConnection

Specified by:

getTotalClientMessageCount in interface IConnection

Specified by:

getTotalClientMessageCount in interface IPlugin

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStatus

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

Indicates status of the data link plugin.

Specified by:

getStatus in interface IClientConnection

Specified by:

getStatus in interface IConnection

Specified by:

getStatus in interface IPlugin

Returns:

A com.esri.arcgis.trackinganalyst.enumConnectionStatus constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

disconnect

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

Disconnects data link.

Specified by:

disconnect in interface IClientConnection

Specified by:

disconnect in interface IConnection

Specified by:

disconnect in interface IPlugin

Throws:

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

AutomationException - If the ArcObject component throws an exception.

postClientMessage

public void postClientMessage(IMessage piMessage)
                       throws java.io.IOException,
                              AutomationException

Posts a client message to the data link.

Specified by:

postClientMessage in interface IClientConnection

Specified by:

postClientMessage in interface IPlugin

Parameters:

piMessage - A reference to a com.esri.arcgis.trackinganalyst.IMessage (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

popClientMessage

public IMessage popClientMessage(int nTimeOut)
                          throws java.io.IOException,
                                 AutomationException

Retrieves a client message from the data link.

Specified by:

popClientMessage in interface IClientConnection

Specified by:

popClientMessage in interface IPlugin

Parameters:

nTimeOut - The nTimeOut (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDataSetDefinitionList

public java.lang.Object getDataSetDefinitionList()
                                          throws java.io.IOException,
                                                 AutomationException

An array of all dataset defintion names that are defined in the TrackingServer that the data link is connected to.

Specified by:

getDataSetDefinitionList in interface IPlugin

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEnableDataFiltering

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

Indicates whether data filtering is enabled for the data link.

Specified by:

isEnableDataFiltering in interface IPlugin

Returns:

The pbvVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEnableDataFiltering

public void setEnableDataFiltering(boolean pbvVal)
                            throws java.io.IOException,
                                   AutomationException

Indicates whether data filtering is enabled for the data link.

Specified by:

setEnableDataFiltering in interface IPlugin

Parameters:

pbvVal - The pbvVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

enableDataDefinition

public void enableDataDefinition(java.lang.String bstrDataDefinitionID)
                          throws java.io.IOException,
                                 AutomationException

Enables data definition for the data link.

Specified by:

enableDataDefinition in interface IPlugin

Parameters:

bstrDataDefinitionID - The bstrDataDefinitionID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

disableDataDefinition

public void disableDataDefinition(java.lang.String bstrDataDefinitionID)
                           throws java.io.IOException,
                                  AutomationException

Disables data definition for the data link.

Specified by:

disableDataDefinition in interface IPlugin

Parameters:

bstrDataDefinitionID - The bstrDataDefinitionID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

returnDataSetDefinition

public void returnDataSetDefinition(IDatasetDef piDataSetDef)
                             throws java.io.IOException,
                                    AutomationException

Returns dataset definition information for the dta link.

Specified by:

returnDataSetDefinition in interface IPlugin

Parameters:

piDataSetDef - A reference to a com.esri.arcgis.trackinganalyst.IDatasetDef (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDataSetDefinition

public IDatasetDef getDataSetDefinition(java.lang.String bstrName)
                                 throws java.io.IOException,
                                        AutomationException

Gets dataset definition information for the data link.

Specified by:

getDataSetDefinition in interface IPlugin

Parameters:

bstrName - The bstrName (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

sendCommand

public IResponseMessage sendCommand(ICommandMessage piCmdMsg,
                                    int nTimeOut)
                             throws java.io.IOException,
                                    AutomationException

Sends a command to the data link.

Specified by:

sendCommand in interface IPlugin

Parameters:

piCmdMsg - A reference to a com.esri.arcgis.trackinganalyst.ICommandMessage (in)

nTimeOut - The nTimeOut (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setID

public void setID(java.lang.String pVal)
           throws java.io.IOException,
                  AutomationException

ID value for the data in the connection.

Specified by:

setID in interface ICOMClient

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEventHandle

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

The handle to the event that is signaled when data is ready to be received.

Specified by:

getEventHandle in interface ICOMClient

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getErrorCode

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

Value for the error code in the data connection.

Specified by:

getErrorCode in interface ICOMClient

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setErrorCode

public void setErrorCode(int pVal)
                  throws java.io.IOException,
                         AutomationException

Value for the error code in the data connection.

Specified by:

setErrorCode in interface ICOMClient

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

postMessage

public void postMessage(IMessage piMessage)
                 throws java.io.IOException,
                        AutomationException

Posts a message to the Tracking Server.

Specified by:

postMessage in interface ICOMClient

Parameters:

piMessage - A reference to a com.esri.arcgis.trackinganalyst.IMessage (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMessage

public IMessage getMessage(int nTimeOut)
                    throws java.io.IOException,
                           AutomationException

Returns a message from the Tracking Server.

Specified by:

getMessage in interface ICOMClient

Parameters:

nTimeOut - The nTimeOut (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

connect

public void connect(java.lang.String szConnectionString)
             throws java.io.IOException,
                    AutomationException

Connects the client to the Tracking Server.

Specified by:

connect in interface ICOMClient

Parameters:

szConnectionString - The szConnectionString (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMessageWithStatus

public IMessage getMessageWithStatus(int timeOut,
                                     long[] status)
                              throws java.io.IOException,
                                     AutomationException

Returns a message from the Tracking Server.

Specified by:

getMessageWithStatus in interface ICOMClient2

Parameters:

timeOut - The timeOut (in)

status - An error code (out: use single element array)

Returns:

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

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.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws java.io.IOException,
                                 AutomationException

enumConnectionPoints

Specified by:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws java.io.IOException,
                                AutomationException

findConnectionPoint

Specified by:

findConnectionPoint in interface IConnectionPointContainer

Parameters:

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

ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.