com.esri.arcgis.trackinganalyst
Class DatasetColumn

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, IPersist, IPersistStream, ISupportErrorInfo, IDatasetColumn, IEditDataSetColumn, IEditDataSetColumn2, java.io.Externalizable, java.io.Serializable

public class DatasetColumn
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IDatasetColumn, IEditDataSetColumn, IEditDataSetColumn2, IPersistStream, ISupportErrorInfo, IDocumentVersionSupportGEN, java.io.Externalizable

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

Description 'Defines single column in a dataset definition.' 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.trackinganalyst.IDatasetColumn

IID, IIDcc018a09_24fb_11d4_b34c_00104ba2abcc, xxDummy

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

IID, IID7f4f0c00_742c_421f_a2cd_dae54d7742fa, xxDummy

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

IIDcc018a0a_24fb_11d4_b34c_00104ba2abcc

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.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

DatasetColumn()
Constructs a DatasetColumn using ArcGIS Engine.

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

Method Summary

java.lang.Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
boolean	equals(java.lang.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 java.lang.String	getClsid() getClsid.
int	getColumnNumber() Indicates the column number in the data definition.
int	getColumnSize() Indicates the size of data being defined.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.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.
java.lang.Object	getValue(IDataMessage piDataMessage) Returns the value for the data column in the dataset definition.
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	readExternal(java.io.ObjectInput in)
void	release() Release a DatasetColumn.
void	save(IStream pstm, int fClearDirty) save
void	setColumnNumber(int pVal) Indicates the column number in the data definition.
void	setColumnSize(int pVal) Indicates the size of data being defined.
void	setName(java.lang.String pVal) Indicates the name of dataset.
void	setType(int pVal) Type of data described in the dataset definition.
void	setValue(java.lang.Object pValue, IDataMessage piDataMessage) Sets the value for the data column in the dataset definition.
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

DatasetColumn

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

Constructs a DatasetColumn using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

DatasetColumn

public DatasetColumn(java.lang.Object obj)
              throws java.io.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:

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 DatasetColumn.

Specified by:

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

getName

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

Identifies dataset name information for the data column in the dataset definition.

Specified by:

getName in interface IDatasetColumn

Specified by:

getName in interface IEditDataSetColumn

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getType

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

Type of data described in the dataset definition.

Specified by:

getType in interface IDatasetColumn

Specified by:

getType in interface IEditDataSetColumn

Returns:

A com.esri.arcgis.trackinganalyst.enumColumnType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setType

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

Type of data described in the dataset definition.

Specified by:

setType in interface IDatasetColumn

Specified by:

setType in interface IEditDataSetColumn

Parameters:

pVal - A com.esri.arcgis.trackinganalyst.enumColumnType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setValue

public void setValue(java.lang.Object pValue,
                     IDataMessage piDataMessage)
              throws java.io.IOException,
                     AutomationException

Sets the value for the data column in the dataset definition.

Specified by:

setValue in interface IDatasetColumn

Parameters:

pValue - A Variant (in)

piDataMessage - A reference to a com.esri.arcgis.geodatabaseextensions.IDataMessage (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getValue

public java.lang.Object getValue(IDataMessage piDataMessage)
                          throws java.io.IOException,
                                 AutomationException

Returns the value for the data column in the dataset definition.

Specified by:

getValue in interface IDatasetColumn

Parameters:

piDataMessage - A reference to a com.esri.arcgis.geodatabaseextensions.IDataMessage (in)

Returns:

A Variant

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

Indicates the name of dataset.

Specified by:

setName in interface IEditDataSetColumn

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getColumnNumber

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

Indicates the column number in the data definition.

Specified by:

getColumnNumber in interface IEditDataSetColumn

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setColumnNumber

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

Indicates the column number in the data definition.

Specified by:

setColumnNumber in interface IEditDataSetColumn

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IDatasetColumn esri_clone()
                          throws java.io.IOException,
                                 AutomationException

Creates a clone of the dataset column in the data definition.

Specified by:

esri_clone in interface IEditDataSetColumn

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getColumnSize

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

Indicates the size of data being defined.

Specified by:

getColumnSize in interface IEditDataSetColumn2

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setColumnSize

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

Indicates the size of data being defined.

Specified by:

setColumnSize in interface IEditDataSetColumn2

Parameters:

pVal - The pVal (in)

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.

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