|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.trackinganalyst.DataMessage
public class DataMessage
Message containing data routed by the Tracking Server.
The DataMessage class encapsulates all of the needed information to represent a row of data. This data can be spatially or non-spatial and can have tracking information or not. It also can have temporal information or not as well.
Constructor Summary | |
---|---|
DataMessage()
Constructs a DataMessage using ArcGIS Engine. |
|
DataMessage(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. DataMessage theDataMessage = (DataMessage) obj; |
Method Summary | |
---|---|
void |
addArgument(Object pValue)
Adds an argument to the data message. |
void |
addColumn(Object pValue)
Adds a column to the data message. |
Object |
convertToSupportedObject(int docVersion)
Convert the object to another object that is supported. |
void |
disconnectObject(int dwReserved)
disconnectObject |
boolean |
equals(Object o)
Compare this object with another |
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 String |
getClsid()
getClsid. |
Object |
getColumn(int nIndex)
Returns value for columns in the data message. |
int |
getColumnCount()
Number of columns in data message. |
Object |
getCreationDate()
Indicates date of data message's creation. |
String |
getDataDefinitionID()
ID value for the data definition in the message. |
String |
getDestination()
Indicates destination of the data message. |
String |
getID()
ID value for the data message. |
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. |
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(ObjectInput in)
|
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,
Object pValue)
Sets an argument for the data message. |
void |
setColumn(int nIndex,
Object pValue)
Sets the number of columns in a data message. |
void |
setDataDefinitionID(String pVal)
ID value for the data definition in the message. |
void |
setDestination(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(ObjectOutput out)
|
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 DataMessage() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic DataMessage(Object obj) throws IOException
DataMessage theDataMessage = (DataMessage) obj;
obj
to DataMessage
.
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 Object getCreationDate() throws IOException, AutomationException
getCreationDate
in interface IArguments
getCreationDate
in interface IDataMessage
getCreationDate
in interface IMessage
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getID() throws IOException, AutomationException
getID
in interface IArguments
getID
in interface IDataMessage
getID
in interface IMessage
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getMessageType() throws IOException, AutomationException
getMessageType
in interface IArguments
getMessageType
in interface IDataMessage
getMessageType
in interface IMessage
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getPriority() throws IOException, AutomationException
The property indicates priority of data message in queue.
getPriority
in interface IArguments
getPriority
in interface IDataMessage
getPriority
in interface IMessage
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setPriority(int pVal) throws IOException, AutomationException
setPriority
in interface IArguments
setPriority
in interface IDataMessage
setPriority
in interface IMessage
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getDestination() throws IOException, AutomationException
getDestination
in interface IArguments
getDestination
in interface IDataMessage
getDestination
in interface IMessage
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDestination(String pVal) throws IOException, AutomationException
setDestination
in interface IArguments
setDestination
in interface IDataMessage
setDestination
in interface IMessage
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getArgumentCount() throws IOException, AutomationException
The ArgumentCount property provides the number of arguments that the message has.
Same as ColumnCount.
getArgumentCount
in interface IArguments
getArgumentCount
in interface IDataMessage
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setArgument(int nIndex, Object pValue) throws IOException, AutomationException
This method sets value for an argument in a message at specified index.
Same as setColumn.
setArgument
in interface IArguments
setArgument
in interface IDataMessage
nIndex
- The nIndex (in)pValue
- A Variant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void addArgument(Object pValue) throws IOException, AutomationException
The addArgument method allows the user to add an argument to the argument list.
Same as addColumn.
addArgument
in interface IArguments
addArgument
in interface IDataMessage
pValue
- A Variant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void removeArgument(int nIndex) throws IOException, AutomationException
Same as removeColumn.
removeArgument
in interface IArguments
removeArgument
in interface IDataMessage
nIndex
- The nIndex (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object getArgument(int nIndex) throws IOException, AutomationException
The getArgument retrieves an argument from the argument list at the user specified index.
Same as getColumn.
getArgument
in interface IArguments
getArgument
in interface IDataMessage
nIndex
- The nIndex (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getDataDefinitionID() throws IOException, AutomationException
getDataDefinitionID
in interface IDataMessage
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDataDefinitionID(String pVal) throws IOException, AutomationException
setDataDefinitionID
in interface IDataMessage
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getColumnCount() throws IOException, AutomationException
getColumnCount
in interface IDataMessage
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setColumn(int nIndex, Object pValue) throws IOException, AutomationException
setColumn
in interface IDataMessage
nIndex
- The nIndex (in)pValue
- A Variant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void addColumn(Object pValue) throws IOException, AutomationException
addColumn
in interface IDataMessage
pValue
- A Variant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void removeColumn(int nIndex) throws IOException, AutomationException
removeColumn
in interface IDataMessage
nIndex
- The nIndex (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object getColumn(int nIndex) throws IOException, AutomationException
This method returns value for the column specified by the index in the data message.
getColumn
in interface IDataMessage
nIndex
- The nIndex (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object getRawColumn(int nIndex) throws IOException, AutomationException
This method returns the raw column info. For Objects it is an array of bytes conforming to the IPersist Stream format.
getRawColumn
in interface IDataMessage
nIndex
- The nIndex (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void isDirty() throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
isDirty
in interface IPersistStream
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void load(IStream pstm) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
load
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void save(IStream pstm, int fClearDirty) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
save
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)fClearDirty
- The fClearDirty (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getSizeMax(_ULARGE_INTEGER[] pcbSize) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
getSizeMax
in interface IPersistStream
pcbSize
- A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getClassID(GUID[] pClassID) throws IOException, AutomationException
IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.
getClassID
in interface IPersist
pClassID
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getUnmarshalClass(GUID riid, int pv, int dwDestContext, int pvDestContext, int mshlflags, GUID[] pCid) throws IOException, AutomationException
getUnmarshalClass
in interface IMarshal
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)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getMarshalSizeMax(GUID riid, int pv, int dwDestContext, int pvDestContext, int mshlflags, int[] pSize) throws IOException, AutomationException
getMarshalSizeMax
in interface IMarshal
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)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void marshalInterface(IStream pStm, GUID riid, int pv, int dwDestContext, int pvDestContext, int mshlflags) throws IOException, AutomationException
marshalInterface
in interface IMarshal
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)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void unmarshalInterface(IStream pStm, GUID riid, int ppv) throws IOException, AutomationException
unmarshalInterface
in interface IMarshal
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)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void releaseMarshalData(IStream pStm) throws IOException, AutomationException
releaseMarshalData
in interface IMarshal
pStm
- A reference to a com.esri.arcgis.system.IStream (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void disconnectObject(int dwReserved) throws IOException, AutomationException
disconnectObject
in interface IMarshal
dwReserved
- The dwReserved (in)
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 boolean isSupportedAtVersion(int docVersion) throws IOException, AutomationException
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.
isSupportedAtVersion
in interface IDocumentVersionSupportGEN
docVersion
- A com.esri.arcgis.system.esriArcGISVersion constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object convertToSupportedObject(int docVersion) throws IOException, AutomationException
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.
convertToSupportedObject
in interface IDocumentVersionSupportGEN
docVersion
- A com.esri.arcgis.system.esriArcGISVersion constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void writeExternal(ObjectOutput out) throws IOException
writeExternal
in interface Externalizable
IOException
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
readExternal
in interface Externalizable
IOException
ClassNotFoundException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |