com.esri.arcgis.trackinganalyst
Class TemporalObjectTable

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, IInternalTable, ITemporalObjectTable, ITemporalTable, Serializable

public class TemporalObjectTable
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ITemporalObjectTable, IInternalTable, ITemporalTable, ISupportErrorInfo

Description

The TemporalObject Table object is a wrapper around an internal memory based database table that contains data about all of the temporal objects that the temporal feature class contains. This object is provided to facilitate the management of this data in a conventional ESRI look and feel. The temporal feature class used direct methods to build the feature data. This object can be used for analysis operations.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

TemporalObjectTable()
Constructs a TemporalObjectTable using ArcGIS Engine.

TemporalObjectTable(Object obj)
Construct a TemporalObjectTable using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

void	addField(IField field) Adds a field to this object class.
int	addRow(IDataMessage piDataMessage) Adds a row to the temporal table.
IRow	createRow() Creates a row in the database with a system assigned object ID and null property values.
IRowBuffer	createRowBuffer() Creates a row buffer that can be used with an insert cursor.
void	deleteField(IField field) Deletes a field from this object class.
boolean	equals(Object o) Compare this object with another
int	findField(String name) The index of the field with the specified name.
static String	getClsid() getClsid.
IFields	getFields() The fields collection for this object class.
String	getGeometryColumnName() Column name of the table's field containing the geometry.
IRow	getRow(int oID) The row from the database with the specified object ID.
String	getTrackingColumnName() The column name used to 'join' the temporal observations with static features.
int	hashCode() the hashcode for this object
ICursor	insert(boolean useBuffering) Returns a cursor that can be used to insert new Rows.
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isHasGeometry() Identifies if the table contains a geometry field.
int	rowCount(IQueryFilter queryFilter) The number of Rows selected by the specified query.
ICursor	search(IQueryFilter queryFilter, boolean recycling) An object cursor that can be used to fetch row objects selected by the specified query.
ISelectionSet	select(IQueryFilter queryFilter, int selType, int selOption, IWorkspace selectionContainer) A selection that contains the object ids selected by the specified query.
void	setGeometryColumnName(String pbstrColumnName) Column name of the table's field containing the geometry.
ICursor	update(IQueryFilter queryFilter, boolean recycling) Returns a cursor that can be used to update Rows selected by the specified query.

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

TemporalObjectTable

public TemporalObjectTable()
                    throws IOException,
                           UnknownHostException

Constructs a TemporalObjectTable using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

TemporalObjectTable

public TemporalObjectTable(Object obj)
                    throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems TemporalObjectTable theTemporalObjectTable = (TemporalObjectTable) obj;

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

getTrackingColumnName

public String getTrackingColumnName()
                             throws IOException,
                                    AutomationException

The column name used to 'join' the temporal observations with static features. Note, the column can only contain strings or numbers.

Description

This property indicates the column name used to 'join' the temporal observations with static features. Note, the column can only contain strings or numbers.

Product Availability

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

Specified by:

getTrackingColumnName in interface ITemporalObjectTable

Returns:

The pbstrColumnName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findField

public int findField(String name)
              throws IOException,
                     AutomationException

The index of the field with the specified name.

Description

This method returns the index of the field with the specified name in the object class.

Product Availability

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

Specified by:

findField in interface ITemporalTable

Parameters:

name - The name (in)

Returns:

The fieldIndex

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFields

public IFields getFields()
                  throws IOException,
                         AutomationException

The fields collection for this object class.

Description

This property returns the fields collection for the object class.

Product Availability

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

Specified by:

getFields in interface ITemporalTable

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.

addField

public void addField(IField field)
              throws IOException,
                     AutomationException

Adds a field to this object class.

Product Availability

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

Specified by:

addField in interface ITemporalTable

Parameters:

field - A reference to a com.esri.arcgis.geodatabase.IField (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteField

public void deleteField(IField field)
                 throws IOException,
                        AutomationException

Deletes a field from this object class.

Product Availability

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

Specified by:

deleteField in interface ITemporalTable

Parameters:

field - A reference to a com.esri.arcgis.geodatabase.IField (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createRow

public IRow createRow()
               throws IOException,
                      AutomationException

Creates a row in the database with a system assigned object ID and null property values.

Product Availability

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

Specified by:

createRow in interface ITemporalTable

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRow

public IRow getRow(int oID)
            throws IOException,
                   AutomationException

The row from the database with the specified object ID.

Product Availability

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

Specified by:

getRow in interface ITemporalTable

Parameters:

oID - The oID (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createRowBuffer

public IRowBuffer createRowBuffer()
                           throws IOException,
                                  AutomationException

Creates a row buffer that can be used with an insert cursor.

Product Availability

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

Specified by:

createRowBuffer in interface ITemporalTable

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

rowCount

public int rowCount(IQueryFilter queryFilter)
             throws IOException,
                    AutomationException

The number of Rows selected by the specified query.

Product Availability

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

Specified by:

rowCount in interface ITemporalTable

Parameters:

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Returns:

The numRows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

search

public ICursor search(IQueryFilter queryFilter,
                      boolean recycling)
               throws IOException,
                      AutomationException

An object cursor that can be used to fetch row objects selected by the specified query.

Product Availability

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

Specified by:

search in interface ITemporalTable

Parameters:

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

recycling - The recycling (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

update

public ICursor update(IQueryFilter queryFilter,
                      boolean recycling)
               throws IOException,
                      AutomationException

Returns a cursor that can be used to update Rows selected by the specified query.

Product Availability

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

Specified by:

update in interface ITemporalTable

Parameters:

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

recycling - The recycling (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insert

public ICursor insert(boolean useBuffering)
               throws IOException,
                      AutomationException

Returns a cursor that can be used to insert new Rows.

Product Availability

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

Specified by:

insert in interface ITemporalTable

Parameters:

useBuffering - The useBuffering (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

select

public ISelectionSet select(IQueryFilter queryFilter,
                            int selType,
                            int selOption,
                            IWorkspace selectionContainer)
                     throws IOException,
                            AutomationException

A selection that contains the object ids selected by the specified query.

Product Availability

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

Specified by:

select in interface ITemporalTable

Parameters:

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

selType - A com.esri.arcgis.geodatabase.esriSelectionType constant (in)

selOption - A com.esri.arcgis.geodatabase.esriSelectionOption constant (in)

selectionContainer - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasGeometry

public boolean isHasGeometry()
                      throws IOException,
                             AutomationException

Identifies if the table contains a geometry field.

Product Availability

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

Specified by:

isHasGeometry in interface ITemporalTable

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGeometryColumnName

public String getGeometryColumnName()
                             throws IOException,
                                    AutomationException

Column name of the table's field containing the geometry.

Description

This property indicates the column name of the table’s field containing the geometry.

Product Availability

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

Specified by:

getGeometryColumnName in interface ITemporalTable

Returns:

The pbstrColumnName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGeometryColumnName

public void setGeometryColumnName(String pbstrColumnName)
                           throws IOException,
                                  AutomationException

Column name of the table's field containing the geometry.

Product Availability

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

Specified by:

setGeometryColumnName in interface ITemporalTable

Parameters:

pbstrColumnName - The pbstrColumnName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addRow

public int addRow(IDataMessage piDataMessage)
           throws IOException,
                  AutomationException

Adds a row to the temporal table.

Product Availability

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

Specified by:

addRow in interface IInternalTable

Parameters:

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

Returns:

The plRowID

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.