com.esri.arcgis.trackinganalyst
Class DataMessage

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

All Implemented Interfaces:

IDataMessage, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, IPersist, IPersistStream, ISupportErrorInfo, IArguments, IMarshal, IMessage, java.io.Externalizable, java.io.Serializable

public class DataMessage
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IDataMessage, IMessage, IArguments, IPersistStream, IMarshal, ISupportErrorInfo, IDocumentVersionSupportGEN, java.io.Externalizable

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

Description 'Message containing data routed by the 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

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.geodatabaseextensions.IDataMessage

IID, IIDcc018a04_24fb_11d4_b34c_00104ba2abcc, xxDummy

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

IID, IIDcc018a01_24fb_11d4_b34c_00104ba2abcc, xxDummy

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

IID, IIDcc018a00_24fb_11d4_b34c_00104ba2abcc, xxDummy

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

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

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

IID0000010c_0000_0000_c000_000000000046

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

IID, IID00000003_0000_0000_c000_000000000046, xxDummy

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

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

DataMessage()
Constructs a DataMessage using ArcGIS Engine.

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

Method Summary

void	addArgument(java.lang.Object pValue) Adds an argument to the data message.
void	addColumn(java.lang.Object pValue) Adds a column to the data message.
java.lang.Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
void	disconnectObject(int dwReserved) disconnectObject
boolean	equals(java.lang.Object o) Compare this object with another
java.lang.Object	getArgument(int nIndex) Gets an argument for the data message.
int	getArgumentCount() Number of arguments in the data message.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
java.lang.Object	getColumn(int nIndex) Returns value for columns in the data message.
int	getColumnCount() Number of columns in data message.
java.lang.Object	getCreationDate() Indicates date of data message's creation.
java.lang.String	getDataDefinitionID() ID value for the data definition in the message.
java.lang.String	getDestination() Indicates destination of the data message.
java.lang.String	getID() ID value for the data message.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
void	getMarshalSizeMax(GUID riid, int pv, int dwDestContext, int pvDestContext, int mshlflags, int[] pSize) getMarshalSizeMax
int	getMessageType() Indicates type of data message.
int	getPriority() Indictes priority of data message.
java.lang.Object	getRawColumn(int nIndex) Returns the Raw column info.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
void	getUnmarshalClass(GUID riid, int pv, int dwDestContext, int pvDestContext, int mshlflags, GUID[] pCid) getUnmarshalClass
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.
void	load(IStream pstm) load
void	marshalInterface(IStream pStm, GUID riid, int pv, int dwDestContext, int pvDestContext, int mshlflags) marshalInterface
void	readExternal(java.io.ObjectInput in)
void	release() Release a DataMessage.
void	releaseMarshalData(IStream pStm) releaseMarshalData
void	removeArgument(int nIndex) Removes an argument from the data message.
void	removeColumn(int nIndex) Removes a column from the data message.
void	save(IStream pstm, int fClearDirty) save
void	setArgument(int nIndex, java.lang.Object pValue) Sets an argument for the data message.
void	setColumn(int nIndex, java.lang.Object pValue) Sets the number of columns in a data message.
void	setDataDefinitionID(java.lang.String pVal) ID value for the data definition in the message.
void	setDestination(java.lang.String pVal) Indicates destination of the data message.
void	setPriority(int pVal) Indictes priority of data message.
void	unmarshalInterface(IStream pStm, GUID riid, int ppv) unmarshalInterface
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

DataMessage

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

Constructs a DataMessage using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

DataMessage

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

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

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

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

release

public void release()

Release a DataMessage.

Specified by:

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

getCreationDate

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

Indicates date of data message's creation.

Specified by:

getCreationDate in interface IDataMessage

Specified by:

getCreationDate in interface IArguments

Specified by:

getCreationDate in interface IMessage

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

ID value for the data message.

Specified by:

getID in interface IDataMessage

Specified by:

getID in interface IArguments

Specified by:

getID in interface IMessage

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMessageType

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

Indicates type of data message.

Specified by:

getMessageType in interface IDataMessage

Specified by:

getMessageType in interface IArguments

Specified by:

getMessageType in interface IMessage

Returns:

A com.esri.arcgis.geodatabaseextensions.enumMessageType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPriority

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

Indictes priority of data message.

Specified by:

getPriority in interface IDataMessage

Specified by:

getPriority in interface IArguments

Specified by:

getPriority in interface IMessage

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPriority

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

Indictes priority of data message.

Specified by:

setPriority in interface IDataMessage

Specified by:

setPriority in interface IArguments

Specified by:

setPriority in interface IMessage

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDestination

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

Indicates destination of the data message.

Specified by:

getDestination in interface IDataMessage

Specified by:

getDestination in interface IArguments

Specified by:

getDestination in interface IMessage

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDestination

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

Indicates destination of the data message.

Specified by:

setDestination in interface IDataMessage

Specified by:

setDestination in interface IArguments

Specified by:

setDestination in interface IMessage

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getArgumentCount

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

Number of arguments in the data message.

Specified by:

getArgumentCount in interface IDataMessage

Specified by:

getArgumentCount in interface IArguments

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setArgument

public void setArgument(int nIndex,
                        java.lang.Object pValue)
                 throws java.io.IOException,
                        AutomationException

Sets an argument for the data message.

Specified by:

setArgument in interface IDataMessage

Specified by:

setArgument in interface IArguments

Parameters:

nIndex - The nIndex (in)

pValue - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addArgument

public void addArgument(java.lang.Object pValue)
                 throws java.io.IOException,
                        AutomationException

Adds an argument to the data message.

Specified by:

addArgument in interface IDataMessage

Specified by:

addArgument in interface IArguments

Parameters:

pValue - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeArgument

public void removeArgument(int nIndex)
                    throws java.io.IOException,
                           AutomationException

Removes an argument from the data message.

Specified by:

removeArgument in interface IDataMessage

Specified by:

removeArgument in interface IArguments

Parameters:

nIndex - The nIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getArgument

public java.lang.Object getArgument(int nIndex)
                             throws java.io.IOException,
                                    AutomationException

Gets an argument for the data message.

Specified by:

getArgument in interface IDataMessage

Specified by:

getArgument in interface IArguments

Parameters:

nIndex - The nIndex (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDataDefinitionID

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

ID value for the data definition in the message.

Specified by:

getDataDefinitionID in interface IDataMessage

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDataDefinitionID

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

ID value for the data definition in the message.

Specified by:

setDataDefinitionID in interface IDataMessage

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getColumnCount

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

Number of columns in data message.

Specified by:

getColumnCount in interface IDataMessage

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setColumn

public void setColumn(int nIndex,
                      java.lang.Object pValue)
               throws java.io.IOException,
                      AutomationException

Sets the number of columns in a data message.

Specified by:

setColumn in interface IDataMessage

Parameters:

nIndex - The nIndex (in)

pValue - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addColumn

public void addColumn(java.lang.Object pValue)
               throws java.io.IOException,
                      AutomationException

Adds a column to the data message.

Specified by:

addColumn in interface IDataMessage

Parameters:

pValue - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeColumn

public void removeColumn(int nIndex)
                  throws java.io.IOException,
                         AutomationException

Removes a column from the data message.

Specified by:

removeColumn in interface IDataMessage

Parameters:

nIndex - The nIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getColumn

public java.lang.Object getColumn(int nIndex)
                           throws java.io.IOException,
                                  AutomationException

Returns value for columns in the data message.

Specified by:

getColumn in interface IDataMessage

Parameters:

nIndex - The nIndex (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRawColumn

public java.lang.Object getRawColumn(int nIndex)
                              throws java.io.IOException,
                                     AutomationException

Returns the Raw column info. For Objects it is a array of bytes conforming to the IPersist Stream format.

Specified by:

getRawColumn in interface IDataMessage

Parameters:

nIndex - The nIndex (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

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

isDirty

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

load

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

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

save

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

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getUnmarshalClass

public void getUnmarshalClass(GUID riid,
                              int pv,
                              int dwDestContext,
                              int pvDestContext,
                              int mshlflags,
                              GUID[] pCid)
                       throws java.io.IOException,
                              AutomationException

getUnmarshalClass

Specified by:

getUnmarshalClass in interface IMarshal

Parameters:

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

pv - A COM void* (in)

dwDestContext - The dwDestContext (in)

pvDestContext - A COM void* (in)

mshlflags - The mshlflags (in)

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMarshalSizeMax

public void getMarshalSizeMax(GUID riid,
                              int pv,
                              int dwDestContext,
                              int pvDestContext,
                              int mshlflags,
                              int[] pSize)
                       throws java.io.IOException,
                              AutomationException

getMarshalSizeMax

Specified by:

getMarshalSizeMax in interface IMarshal

Parameters:

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

pv - A COM void* (in)

dwDestContext - The dwDestContext (in)

pvDestContext - A COM void* (in)

mshlflags - The mshlflags (in)

pSize - The pSize (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

marshalInterface

public void marshalInterface(IStream pStm,
                             GUID riid,
                             int pv,
                             int dwDestContext,
                             int pvDestContext,
                             int mshlflags)
                      throws java.io.IOException,
                             AutomationException

marshalInterface

Specified by:

marshalInterface in interface IMarshal

Parameters:

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

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

pv - A COM void* (in)

dwDestContext - The dwDestContext (in)

pvDestContext - A COM void* (in)

mshlflags - The mshlflags (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

unmarshalInterface

public void unmarshalInterface(IStream pStm,
                               GUID riid,
                               int ppv)
                        throws java.io.IOException,
                               AutomationException

unmarshalInterface

Specified by:

unmarshalInterface in interface IMarshal

Parameters:

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

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

ppv - A COM void* (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

releaseMarshalData

public void releaseMarshalData(IStream pStm)
                        throws java.io.IOException,
                               AutomationException

releaseMarshalData

Specified by:

releaseMarshalData in interface IMarshal

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

disconnectObject

public void disconnectObject(int dwReserved)
                      throws java.io.IOException,
                             AutomationException

disconnectObject

Specified by:

disconnectObject in interface IMarshal

Parameters:

dwReserved - The dwReserved (in)

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.

isSupportedAtVersion

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

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

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

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

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException