com.esri.arcgis.carto
Class StandaloneTableInfo

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

All Implemented Interfaces:

IMapTableInfo, IMapTableTimeInfo, IStandaloneTableInfo, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class StandaloneTableInfo
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IStandaloneTableInfo, IXMLSerialize, IPersistStream, IPersist, IMapTableTimeInfo, IXMLVersionSupport, Externalizable

The coclass contains information for standalone table in a map.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

StandaloneTableInfo()
Constructs a StandaloneTableInfo using ArcGIS Engine.

StandaloneTableInfo(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
StandaloneTableInfo theStandaloneTableInfo = (StandaloneTableInfo) 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	getDescription() The description of the Stand Alone table.
String	getDisplayField() Primary display field.
String	getEndTimeFieldName() End time field for the table.
IFields	getFields() Array of attribute fields contained in the table.
ITimeExtent	getFullTimeExtent() The time extent for all the data in the table.
int	getHTMLPopupType() Indicates if the layer has HTML popups enabled.
int	getID() The table ID.
String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
String	getName() Descriptive name of the table.
String	getOIDFieldName() The name of the OID Field.
IRelateInfos	getRelateInfos() Array of relates associated to the table.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
String	getStartTimeFieldName() Name of the field that has start time or time instant for a table.
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.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isHasAttachments() Indicates if the layer has attachments.
boolean	isHasSubtype() Indicates if the layer has Subtype.
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

StandaloneTableInfo

public StandaloneTableInfo()
                    throws IOException,
                           UnknownHostException

Constructs a StandaloneTableInfo using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

StandaloneTableInfo

public StandaloneTableInfo(Object obj)
                    throws IOException

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

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

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

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException

The description of the Stand Alone table. This property is set in the General tab of the Properties dialog.

Product Availability

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

Specified by:

getDescription in interface IStandaloneTableInfo

Returns:

The desc

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getID

public int getID()
          throws IOException,
                 AutomationException

The table ID. This is a unique ID among layers and tables, and is used to identify the table in a number of methods.

Product Availability

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

Specified by:

getID in interface IMapTableInfo

Returns:

The tableID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

Descriptive name of the table.

Product Availability

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

Specified by:

getName in interface IMapTableInfo

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFields

public IFields getFields()
                  throws IOException,
                         AutomationException

Array of attribute fields contained in the table.

Remarks

Note: ObjectID field is always included even when the field is invisible in the source map document.

Product Availability

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

Specified by:

getFields in interface IMapTableInfo

Returns:

A reference to a com.esri.arcgis.geodatabase.IFields

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelateInfos

public IRelateInfos getRelateInfos()
                            throws IOException,
                                   AutomationException

Array of relates associated to the table.

Remarks

In order for MapServer to advertise a relationship, both source and destination layer/standalone table must be added to the source map document. For example, Layer A is related to Table B in the GeoDatabase; Layer A is added to the map while Table B is not, in this scenario, MapServer will not publicize this relationship and therefore QueryRelatedRows function cannot be used to get related row(s) for feature from Layer A.

Product Availability

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

Specified by:

getRelateInfos in interface IMapTableInfo

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.

isHasAttachments

public boolean isHasAttachments()
                         throws IOException,
                                AutomationException

Indicates if the layer has attachments.

Product Availability

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

Specified by:

isHasAttachments in interface IMapTableInfo

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 has HTML popups enabled.

Remarks

StandaloneTable does not support HTMLPopup

Product Availability

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

Specified by:

getHTMLPopupType in interface IMapTableInfo

Returns:

A com.esri.arcgis.carto.esriServerHTMLPopupType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayField

public String getDisplayField()
                       throws IOException,
                              AutomationException

Primary display field.

Remarks

When DisplayExpression is used in the source map document, MapServer returns the first field used in the expression.

Product Availability

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

Specified by:

getDisplayField in interface IMapTableInfo

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOIDFieldName

public String getOIDFieldName()
                       throws IOException,
                              AutomationException

The name of the OID Field.

Product Availability

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

Specified by:

getOIDFieldName in interface IMapTableInfo

Returns:

The oIDFieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasSubtype

public boolean isHasSubtype()
                     throws IOException,
                            AutomationException

Indicates if the layer has Subtype.

Remarks

Note: in case when the subtype field name is invisible in the source map document, HasSubtype will return False even though the layer has Subtypes.

Product Availability

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

Specified by:

isHasSubtype in interface IMapTableInfo

Returns:

The hasSubtype

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.

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.

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