com.esri.arcgis.trackinganalyst
Class DatasetColumn

java.lang.Object
  extended by com.esri.arcgis.trackinganalyst.DatasetColumn
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IDatasetColumn, IEditDataSetColumn, Externalizable, Serializable

public class DatasetColumn
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDatasetColumn, IEditDataSetColumn, IPersistStream, Externalizable

Defines single column in a dataset definition.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
DatasetColumn()
          Constructs a DatasetColumn using ArcGIS Engine.
DatasetColumn(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DatasetColumn theDatasetColumn = (DatasetColumn) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 IDatasetColumn esri_clone()
          Creates a clone of the dataset column in the data definition.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 int getColumnNumber()
          Indicates the column number in the data definition.
 String getName()
          Identifies dataset name information for the data column in the dataset definition.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int getType()
          Type of data described in the dataset definition.
 Object getValue(IDataMessage piDataMessage)
          Returns the value for the data column in the dataset definition.
 int hashCode()
          the hashcode for this object
 void isDirty()
          isDirty
 void load(IStream pstm)
          load
 void readExternal(ObjectInput in)
           
 void save(IStream pstm, int fClearDirty)
          save
 void setColumnNumber(int pVal)
          Indicates the column number in the data definition.
 void setName(String pVal)
          Indicates the name of dataset.
 void setType(int pVal)
          Type of data described in the dataset definition.
 void setValue(Object pValue, IDataMessage piDataMessage)
          Sets the value for the data column in the dataset definition.
 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

DatasetColumn

public DatasetColumn()
              throws IOException,
                     UnknownHostException
Constructs a DatasetColumn using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

DatasetColumn

public DatasetColumn(Object obj)
              throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DatasetColumn theDatasetColumn = (DatasetColumn) obj;

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

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getName

public String getName()
               throws IOException,
                      AutomationException
Identifies dataset name information for the data column in the dataset definition.

Product Availability

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

Specified by:
getName in interface IDatasetColumn
Specified by:
getName in interface IEditDataSetColumn
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws IOException,
                   AutomationException
Type of data described in the dataset definition.

Product Availability

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

Specified by:
getType in interface IDatasetColumn
Specified by:
getType in interface IEditDataSetColumn
Returns:
A com.esri.arcgis.trackinganalyst.enumColumnType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setType

public void setType(int pVal)
             throws IOException,
                    AutomationException
Type of data described in the dataset definition.

Product Availability

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

Specified by:
setType in interface IDatasetColumn
Specified by:
setType in interface IEditDataSetColumn
Parameters:
pVal - A com.esri.arcgis.trackinganalyst.enumColumnType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setValue

public void setValue(Object pValue,
                     IDataMessage piDataMessage)
              throws IOException,
                     AutomationException
Sets the value for the data column in the dataset definition.

Product Availability

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

Specified by:
setValue in interface IDatasetColumn
Parameters:
pValue - A Variant (in)
piDataMessage - A reference to a com.esri.arcgis.trackinganalyst.IDataMessage (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getValue

public Object getValue(IDataMessage piDataMessage)
                throws IOException,
                       AutomationException
Returns the value for the data column in the dataset definition.

Product Availability

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

Specified by:
getValue in interface IDatasetColumn
Parameters:
piDataMessage - A reference to a com.esri.arcgis.trackinganalyst.IDataMessage (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String pVal)
             throws IOException,
                    AutomationException
Indicates the name of dataset.

Product Availability

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

Specified by:
setName in interface IEditDataSetColumn
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColumnNumber

public int getColumnNumber()
                    throws IOException,
                           AutomationException
Indicates the column number in the data definition.

Product Availability

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

Specified by:
getColumnNumber in interface IEditDataSetColumn
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setColumnNumber

public void setColumnNumber(int pVal)
                     throws IOException,
                            AutomationException
Indicates the column number in the data definition.

Product Availability

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

Specified by:
setColumnNumber in interface IEditDataSetColumn
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_clone

public IDatasetColumn esri_clone()
                          throws IOException,
                                 AutomationException
Creates a clone of the dataset column in the data definition.

Product Availability

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

Specified by:
esri_clone in interface IEditDataSetColumn
Returns:
A reference to a com.esri.arcgis.trackinganalyst.IDatasetColumn
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException
isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDirty in interface IPersistStream
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException
load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

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

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException
getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

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

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Throws:
IOException
ClassNotFoundException