com.esri.arcgis.carto
Class DataObjectTable

java.lang.Object
  com.esri.arcgis.carto.DataObjectTable

All Implemented Interfaces:

IDataObjectTable, IMapTableTimeInfo, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, ISupportErrorInfo, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class DataObjectTable
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDataObjectTable, IMapTableTimeInfo, IXMLSerialize, IPersistStream, IPersist, ISupportErrorInfo, IXMLVersionSupport, Externalizable

DataObjectTable co-class.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

DataObjectTable()
Constructs a DataObjectTable using ArcGIS Engine.

DataObjectTable(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DataObjectTable theDataObjectTable = (DataObjectTable) obj;

Method Summary

void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
String	getCopyrightText() Copyright information associated with the table or layer.
String	getDescription() The description of the table or layer.
String	getDisplayPropName() Primary display field.
String	getEndTimeFieldName() End time field for the table.
ITimeExtent	getFullTimeExtent() The time extent for all the data in the table.
String	getGlobalIDPropName() getGlobalIDPropName
int	getHTMLPopupType() Indicates if the layer/table has HTML popups enabled.
int	getID() getID
String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
String	getName() getName
String	getOIDPropName() getOIDPropName
IPropertyInfos	getPropertyInfos() getPropertyInfos
IRelateInfos	getRelations() getRelations
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
String	getStartTimeFieldName() Name of the field that has start time or time instant for a table.
ITemplateInfos	getTemplates() Feature Templates.
double	getTimeInterval() Suggested draw time interval for refreshing the table contents.
int	getTimeIntervalUnits() Draw time interval units.
ITimeReference	getTimeReference() Native TimeReference of the contents of the table.
String	getTimeValueFormat() Time field(s) values format.
String	getTrackIDFieldName() Field that identifies or groups unique objects for which time values are recorded in a table.
String	getTypeIDPropName() getTypeIDPropName
IDataObjectTypes	getTypes() getTypes
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	isDirty() isDirty
boolean	isHasAttachments() Indicates if the table/ layer has attachments.
boolean	isSupportsTime() Indicates whether the table supports time.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
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

DataObjectTable

public DataObjectTable()
                throws IOException,
                       UnknownHostException

Constructs a DataObjectTable using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

DataObjectTable

public DataObjectTable(Object obj)
                throws IOException

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

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

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

getCopyrightText

public String getCopyrightText()
                        throws IOException,
                               AutomationException

Copyright information associated with the table or layer.

Product Availability

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

Specified by:

getCopyrightText in interface IDataObjectTable

Returns:

The copyright

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException

The description of the table or layer. This property is set in the General tab of the Table/ Layer Properties dialog.

Product Availability

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

Specified by:

getDescription in interface IDataObjectTable

Returns:

The desc

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayPropName

public String getDisplayPropName()
                          throws IOException,
                                 AutomationException

Primary display field.

Product Availability

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

Specified by:

getDisplayPropName in interface IDataObjectTable

Returns:

The propName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGlobalIDPropName

public String getGlobalIDPropName()
                           throws IOException,
                                  AutomationException

getGlobalIDPropName

Product Availability

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

Specified by:

getGlobalIDPropName in interface IDataObjectTable

Returns:

The propName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasAttachments

public boolean isHasAttachments()
                         throws IOException,
                                AutomationException

Indicates if the table/ layer has attachments.

Product Availability

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

Specified by:

isHasAttachments in interface IDataObjectTable

Returns:

The hasAttachments

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHTMLPopupType

public int getHTMLPopupType()
                     throws IOException,
                            AutomationException

Indicates if the layer/table has HTML popups enabled.

Product Availability

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

Specified by:

getHTMLPopupType in interface IDataObjectTable

Returns:

A com.esri.arcgis.carto.esriServerHTMLPopupType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getID

public int getID()
          throws IOException,
                 AutomationException

getID

Product Availability

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

Specified by:

getID in interface IDataObjectTable

Returns:

The iD

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

getName

Product Availability

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

Specified by:

getName in interface IDataObjectTable

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOIDPropName

public String getOIDPropName()
                      throws IOException,
                             AutomationException

getOIDPropName

Product Availability

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

Specified by:

getOIDPropName in interface IDataObjectTable

Returns:

The propName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPropertyInfos

public IPropertyInfos getPropertyInfos()
                                throws IOException,
                                       AutomationException

getPropertyInfos

Product Availability

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

Specified by:

getPropertyInfos in interface IDataObjectTable

Returns:

A reference to a com.esri.arcgis.carto.IPropertyInfos

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelations

public IRelateInfos getRelations()
                          throws IOException,
                                 AutomationException

getRelations

Product Availability

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

Specified by:

getRelations in interface IDataObjectTable

Returns:

A reference to a com.esri.arcgis.carto.IRelateInfos

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemplates

public ITemplateInfos getTemplates()
                            throws IOException,
                                   AutomationException

Feature Templates.

Product Availability

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

Specified by:

getTemplates in interface IDataObjectTable

Returns:

A reference to a com.esri.arcgis.carto.ITemplateInfos

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTypeIDPropName

public String getTypeIDPropName()
                         throws IOException,
                                AutomationException

getTypeIDPropName

Product Availability

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

Specified by:

getTypeIDPropName in interface IDataObjectTable

Returns:

The propName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTypes

public IDataObjectTypes getTypes()
                          throws IOException,
                                 AutomationException

getTypes

Product Availability

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

Specified by:

getTypes in interface IDataObjectTable

Returns:

A reference to a com.esri.arcgis.carto.IDataObjectTypes

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsTime

public boolean isSupportsTime()
                       throws IOException,
                              AutomationException

Indicates whether the table supports time.

Product Availability

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

Specified by:

isSupportsTime in interface IMapTableTimeInfo

Returns:

The supports

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStartTimeFieldName

public String getStartTimeFieldName()
                             throws IOException,
                                    AutomationException

Name of the field that has start time or time instant for a table.

Remarks

Time from this field is used to define when a feature/row is begun in case when the layer/table is time-enabled with two fields.

When a layer/table is time-enabled with single field, value in this field represents the moment the feature/row is recorded.

Product Availability

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

Specified by:

getStartTimeFieldName in interface IMapTableTimeInfo

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEndTimeFieldName

public String getEndTimeFieldName()
                           throws IOException,
                                  AutomationException

End time field for the table.

Product Availability

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

Specified by:

getEndTimeFieldName in interface IMapTableTimeInfo

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeValueFormat

public String getTimeValueFormat()
                          throws IOException,
                                 AutomationException

Time field(s) values format.

Remarks

Only application when a string or numeric field is used for time definition.

Product Availability

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

Specified by:

getTimeValueFormat in interface IMapTableTimeInfo

Returns:

The format

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTrackIDFieldName

public String getTrackIDFieldName()
                           throws IOException,
                                  AutomationException

Field that identifies or groups unique objects for which time values are recorded in a table.

Product Availability

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

Specified by:

getTrackIDFieldName in interface IMapTableTimeInfo

Returns:

The trackIDFieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeReference

public ITimeReference getTimeReference()
                                throws IOException,
                                       AutomationException

Native TimeReference of the contents of the table.

Product Availability

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

Specified by:

getTimeReference in interface IMapTableTimeInfo

Returns:

A reference to a com.esri.arcgis.system.ITimeReference

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFullTimeExtent

public ITimeExtent getFullTimeExtent()
                              throws IOException,
                                     AutomationException

The time extent for all the data in the table.

Product Availability

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

Specified by:

getFullTimeExtent in interface IMapTableTimeInfo

Returns:

A reference to a com.esri.arcgis.system.ITimeExtent

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeInterval

public double getTimeInterval()
                       throws IOException,
                              AutomationException

Suggested draw time interval for refreshing the table contents.

Product Availability

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

Specified by:

getTimeInterval in interface IMapTableTimeInfo

Returns:

The interval

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeIntervalUnits

public int getTimeIntervalUnits()
                         throws IOException,
                                AutomationException

Draw time interval units.

Product Availability

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

Specified by:

getTimeIntervalUnits in interface IMapTableTimeInfo

Returns:

A com.esri.arcgis.system.esriTimeUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

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.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public String getMinNamespaceSupported()
                                throws IOException,
                                       AutomationException

The minimum namespace the class can serialize to (eg the 90 namespace).

Product Availability

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

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

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