|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.trackinganalyst.PlugIn
public class PlugIn
Base class for data links for Tracking Server.
Constructor Summary | |
---|---|
PlugIn()
Constructs a PlugIn using ArcGIS Engine. |
|
PlugIn(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(String szConnectionString)
Connects the client to the Tracking Server. |
void |
disableDataDefinition(String bstrDataDefinitionID)
Disables data definition for the data link. |
void |
disconnect()
Disconnects data link. |
void |
enableDataDefinition(String bstrDataDefinitionID)
Enables data definition for the data link. |
void |
enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
enumConnectionPoints |
boolean |
equals(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 String |
getClsid()
getClsid. |
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(String bstrName)
Gets dataset definition information for the data link. |
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. |
String |
getID()
Unique identifier of the current instance of the data link. |
IMessage |
getMessage(int nTimeOut)
Returns a message from the Tracking Server. |
IMessage |
getMessageWithStatus(int timeOut,
long[] status)
Returns a message from the Tracking Server. |
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. |
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 |
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(String pVal)
ID value for the data in the connection. |
void |
setName(String pVal)
Name of data link plugin. |
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 PlugIn() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic PlugIn(Object obj) throws IOException
PlugIn thePlugIn = (PlugIn) obj;
obj
to PlugIn
.
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 add_IPlugInEventsListener(_IPlugInEvents theListener) throws IOException
theListener
- An object that implements the com.esri.arcgis.trackinganalyst._IPlugInEvents interface.
IOException
- If there are communications problems.public void remove_IPlugInEventsListener(_IPlugInEvents theListener) throws IOException
theListener
- An object that implements the com.esri.arcgis.trackinganalyst._IPlugInEvents interface.
IOException
- If there are communications problems.public Object getDataFilters() throws IOException, AutomationException
getDataFilters
in interface IClientConnection
getDataFilters
in interface IConnection
getDataFilters
in interface IPlugin
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getID() throws IOException, AutomationException
getID
in interface IClientConnection
getID
in interface ICOMClient
getID
in interface IConnection
getID
in interface IPlugin
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getName() throws IOException, AutomationException
getName
in interface IClientConnection
getName
in interface ICOMClient
getName
in interface IConnection
getName
in interface IPlugin
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setName(String pVal) throws IOException, AutomationException
setName
in interface IClientConnection
setName
in interface ICOMClient
setName
in interface IConnection
setName
in interface IPlugin
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getServerQueueCount() throws IOException, AutomationException
getServerQueueCount
in interface IClientConnection
getServerQueueCount
in interface IConnection
getServerQueueCount
in interface IPlugin
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getClientQueueCount() throws IOException, AutomationException
getClientQueueCount
in interface IClientConnection
getClientQueueCount
in interface IConnection
getClientQueueCount
in interface IPlugin
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object getTimeEstablished() throws IOException, AutomationException
getTimeEstablished
in interface IClientConnection
getTimeEstablished
in interface IConnection
getTimeEstablished
in interface IPlugin
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getTotalServerMessageCount() throws IOException, AutomationException
getTotalServerMessageCount
in interface IClientConnection
getTotalServerMessageCount
in interface IConnection
getTotalServerMessageCount
in interface IPlugin
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getTotalClientMessageCount() throws IOException, AutomationException
getTotalClientMessageCount
in interface IClientConnection
getTotalClientMessageCount
in interface IConnection
getTotalClientMessageCount
in interface IPlugin
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getStatus() throws IOException, AutomationException
getStatus
in interface IClientConnection
getStatus
in interface IConnection
getStatus
in interface IPlugin
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void disconnect() throws IOException, AutomationException
disconnect
in interface IClientConnection
disconnect
in interface IConnection
disconnect
in interface IPlugin
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void postClientMessage(IMessage piMessage) throws IOException, AutomationException
postClientMessage
in interface IClientConnection
postClientMessage
in interface IPlugin
piMessage
- A reference to a com.esri.arcgis.trackinganalyst.IMessage (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IMessage popClientMessage(int nTimeOut) throws IOException, AutomationException
popClientMessage
in interface IClientConnection
popClientMessage
in interface IPlugin
nTimeOut
- The nTimeOut (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object getDataSetDefinitionList() throws IOException, AutomationException
getDataSetDefinitionList
in interface IPlugin
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isEnableDataFiltering() throws IOException, AutomationException
isEnableDataFiltering
in interface IPlugin
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setEnableDataFiltering(boolean pbvVal) throws IOException, AutomationException
setEnableDataFiltering
in interface IPlugin
pbvVal
- The pbvVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void enableDataDefinition(String bstrDataDefinitionID) throws IOException, AutomationException
enableDataDefinition
in interface IPlugin
bstrDataDefinitionID
- The bstrDataDefinitionID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void disableDataDefinition(String bstrDataDefinitionID) throws IOException, AutomationException
disableDataDefinition
in interface IPlugin
bstrDataDefinitionID
- The bstrDataDefinitionID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void returnDataSetDefinition(IDatasetDef piDataSetDef) throws IOException, AutomationException
returnDataSetDefinition
in interface IPlugin
piDataSetDef
- A reference to a com.esri.arcgis.trackinganalyst.IDatasetDef (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IDatasetDef getDataSetDefinition(String bstrName) throws IOException, AutomationException
getDataSetDefinition
in interface IPlugin
bstrName
- The bstrName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IResponseMessage sendCommand(ICommandMessage piCmdMsg, int nTimeOut) throws IOException, AutomationException
sendCommand
in interface IPlugin
piCmdMsg
- A reference to a com.esri.arcgis.trackinganalyst.ICommandMessage (in)nTimeOut
- The nTimeOut (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setID(String pVal) throws IOException, AutomationException
This property contains a unique identifier for this instance of the Object in which this interface is implemented with. This Unique ID is used internally by the Tracking Server to route command, data, status, and response message. This is the same ID that should be used in the message's destination property for routing a message to a specific Datalink. The implementation must verify that the ID is a valid GUID before changing the internal value.
setID
in interface ICOMClient
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getEventHandle() throws IOException, AutomationException
Reserved for future use.
getEventHandle
in interface ICOMClient
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getErrorCode() throws IOException, AutomationException
This property indicates the last error code that has occured.
getErrorCode
in interface ICOMClient
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setErrorCode(int pVal) throws IOException, AutomationException
This property indicates the last error code that has occured.
setErrorCode
in interface ICOMClient
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void postMessage(IMessage piMessage) throws IOException, AutomationException
The postMessage method allows the Tracking server to send messages to the implementation's client. This method should only be valid if the Status is CONNECTED, see the IConnection interface definition. The implementation should return an S_OK if successful and an E_FAIL if not successful or if the implementation is not connected.
postMessage
in interface ICOMClient
piMessage
- A reference to a com.esri.arcgis.trackinganalyst.IMessage (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IMessage getMessage(int nTimeOut) throws IOException, AutomationException
The getMessage method is called by the tracking server process and retrieves a message from the implementations client. This method is only valid if the Status is CONNECTED. The implementation should return an S_OK if successful and an E_FAIL if not successful or the implementation is not connected. Additionally this routine should only block for the timeout, in milliseconds, passed in as nTimeOut. If a timeout occurs then the IMessage* value should be NULL and the return result must be S_FALSE; This is a requirement in order for the Tracking Server to properly process timeouts. Timeouts are normal operation as messages are not normally streaming steadily through the implementation.
getMessage
in interface ICOMClient
nTimeOut
- The nTimeOut (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void connect(String szConnectionString) throws IOException, AutomationException
The connect method provides the entry point for connecting to the implementations client. This method takes one argument, the connection string. This connection string will contain the PROGID as the first section of the string and may contain additional information needed to connect the implementation. This additional information is dependent on the user-developed object. The format past the PROGID is at the discretion of the developer however it is recommended that TAGS be used to identify properties. The TAG format is an ALL CAPS TAG that is terminated with a colon e.g. CONNECTIONSTRING:user=self. The connect method returns S_OK on a successful connection or E_FAIL on a failed connection. Additionally it is desired for the implementation to use the Error Macros defined in ATL 3.0 for returning a descriptive error message. This message is logged into the TMS log and the Windows NT Event Log mechanism.
connect
in interface ICOMClient
szConnectionString
- The szConnectionString (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IMessage getMessageWithStatus(int timeOut, long[] status) throws IOException, AutomationException
getMessageWithStatus
in interface ICOMClient2
timeOut
- The timeOut (in)status
- An error code (out: use single element array)
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 void enumConnectionPoints(IEnumConnectionPoints[] ppEnum) throws IOException, AutomationException
IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.
enumConnectionPoints
in interface IConnectionPointContainer
ppEnum
- A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) throws IOException, AutomationException
IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.
findConnectionPoint
in interface IConnectionPointContainer
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)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |