com.esri.arcgis.trackinganalyst
Class TemporalObservationTable

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

All Implemented Interfaces:

IInternalTable, ITemporalObservationsTable, ITemporalObservationsTable2, ITemporalTable, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, java.io.Serializable

public class TemporalObservationTable
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ITemporalObservationsTable, ITemporalObservationsTable2, IInternalTable, ITemporalTable, ISupportErrorInfo

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

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

Fields inherited from interface com.esri.arcgis.geodatabaseextensions.ITemporalObservationsTable2

IID, IIDaec7a38a_f684_40fc_b2f2_96000ebf22d8, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabaseextensions.ITemporalObservationsTable

IIDa677ab5f_2fb8_11d5_b7e2_00010265adc5

Fields inherited from interface com.esri.arcgis.geodatabaseextensions.ITemporalTable

IID18fb46e0_461a_11d5_b7e5_00010265adc5

Fields inherited from interface com.esri.arcgis.geodatabaseextensions.IInternalTable

IID, IIDa677ab63_2fb8_11d5_b7e2_00010265adc5, xxDummy

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

TemporalObservationTable()
Constructs a TemporalObservationTable using ArcGIS Engine.

TemporalObservationTable(java.lang.Object obj)
Construct a TemporalObservationTable 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(java.lang.Object o) Compare this object with another
int	findField(java.lang.String name) The index of the field with the specified name.
static java.lang.String	getClsid() getClsid.
IFields	getFields() The fields collection for this object class.
java.lang.String	getGeometryColumnName() Column name of the table's field containing the geometry.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
double	getPurgePercentage() The percentage of the maximum allowed number of records to delete when the Purge method is called.
int	getPurgeRule() Identifies the purge rule to apply when PruneTable method is called (via user S/W or auto purge criteria).
IRow	getRow(int oID) The row from the database with the specified object ID.
java.lang.String	getTemporalColumnName() The column that is responsible for providing the temporal information.
java.lang.Object	getThreshold() The high-water mark or the number of observations that should not be exceeded Threshold.
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	isAutoPurge() Indicates if the observation table will automatically purge observations that meet a specified criteria, Purge Rule, when the high-water mark has been exceeded.
boolean	isHasGeometry() Identifies if the table contains a geometry field.
boolean	isPersistant() Reserved for future.
void	pruneTable() Apply the purge rule to the temporal table.
void	queryTemporalExtent(java.lang.Object[] pvarStartTime, java.lang.Object[] pvarEndTime) Provides the time range of all records in the temporal table.
void	release() Release a TemporalObservationTable.
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	setAutoPurge(boolean pVal) Indicates if the observation table will automatically purge observations that meet a specified criteria, Purge Rule, when the high-water mark has been exceeded.
void	setGeometryColumnName(java.lang.String pbstrColumnName) Column name of the table's field containing the geometry.
void	setPersistant(boolean pVal) Reserved for future.
void	setPurgePercentage(double pVal) The percentage of the maximum allowed number of records to delete when the Purge method is called.
void	setPurgeRule(int pVal) Identifies the purge rule to apply when PruneTable method is called (via user S/W or auto purge criteria).
void	setTemporalColumnName(java.lang.String pVal) The column that is responsible for providing the temporal information.
void	setThreshold(java.lang.Object pvarVal) The high-water mark or the number of observations that should not be exceeded Threshold.
void	setTrackingColumnIndex(int rhs1) Receives the column index of the Track ID.
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

Constructor Detail

TemporalObservationTable

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

Constructs a TemporalObservationTable using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

TemporalObservationTable

public TemporalObservationTable(java.lang.Object obj)
                         throws java.io.IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems TemporalObservationTable theTemporalObservationTable = (TemporalObservationTable) obj;

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

Specified by:

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

isAutoPurge

public boolean isAutoPurge()
                    throws java.io.IOException,
                           AutomationException

Indicates if the observation table will automatically purge observations that meet a specified criteria, Purge Rule, when the high-water mark has been exceeded.

Specified by:

isAutoPurge in interface ITemporalObservationsTable

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAutoPurge

public void setAutoPurge(boolean pVal)
                  throws java.io.IOException,
                         AutomationException

Indicates if the observation table will automatically purge observations that meet a specified criteria, Purge Rule, when the high-water mark has been exceeded.

Specified by:

setAutoPurge in interface ITemporalObservationsTable

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getThreshold

public java.lang.Object getThreshold()
                              throws java.io.IOException,
                                     AutomationException

The high-water mark or the number of observations that should not be exceeded Threshold.

Specified by:

getThreshold in interface ITemporalObservationsTable

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setThreshold

public void setThreshold(java.lang.Object pvarVal)
                  throws java.io.IOException,
                         AutomationException

The high-water mark or the number of observations that should not be exceeded Threshold.

Specified by:

setThreshold in interface ITemporalObservationsTable

Parameters:

pvarVal - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPurgePercentage

public double getPurgePercentage()
                          throws java.io.IOException,
                                 AutomationException

The percentage of the maximum allowed number of records to delete when the Purge method is called.

Specified by:

getPurgePercentage in interface ITemporalObservationsTable

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPurgePercentage

public void setPurgePercentage(double pVal)
                        throws java.io.IOException,
                               AutomationException

The percentage of the maximum allowed number of records to delete when the Purge method is called.

Specified by:

setPurgePercentage in interface ITemporalObservationsTable

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isPersistant

public boolean isPersistant()
                     throws java.io.IOException,
                            AutomationException

Reserved for future.

Specified by:

isPersistant in interface ITemporalObservationsTable

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPersistant

public void setPersistant(boolean pVal)
                   throws java.io.IOException,
                          AutomationException

Reserved for future.

Specified by:

setPersistant in interface ITemporalObservationsTable

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTemporalColumnName

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

The column that is responsible for providing the temporal information. This column must be a character (date/time string parsable) , date-time, timestamp, or time period.

Specified by:

getTemporalColumnName in interface ITemporalObservationsTable

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTemporalColumnName

public void setTemporalColumnName(java.lang.String pVal)
                           throws java.io.IOException,
                                  AutomationException

The column that is responsible for providing the temporal information. This column must be a character (date/time string parsable) , date-time, timestamp, or time period.

Specified by:

setTemporalColumnName in interface ITemporalObservationsTable

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPurgeRule

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

Identifies the purge rule to apply when PruneTable method is called (via user S/W or auto purge criteria).

Specified by:

getPurgeRule in interface ITemporalObservationsTable

Returns:

A com.esri.arcgis.geodatabaseextensions.enumPurgeRule constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPurgeRule

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

Identifies the purge rule to apply when PruneTable method is called (via user S/W or auto purge criteria).

Specified by:

setPurgeRule in interface ITemporalObservationsTable

Parameters:

pVal - A com.esri.arcgis.geodatabaseextensions.enumPurgeRule constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

pruneTable

public void pruneTable()
                throws java.io.IOException,
                       AutomationException

Apply the purge rule to the temporal table.

Specified by:

pruneTable in interface ITemporalObservationsTable

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryTemporalExtent

public void queryTemporalExtent(java.lang.Object[] pvarStartTime,
                                java.lang.Object[] pvarEndTime)
                         throws java.io.IOException,
                                AutomationException

Provides the time range of all records in the temporal table.

Specified by:

queryTemporalExtent in interface ITemporalObservationsTable

Parameters:

pvarStartTime - A Variant (out: use single element array)

pvarEndTime - A Variant (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findField

public int findField(java.lang.String name)
              throws java.io.IOException,
                     AutomationException

The index of the field with the specified name.

Specified by:

findField in interface ITemporalTable

Parameters:

name - The name (in)

Returns:

The fieldIndex

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFields

public IFields getFields()
                  throws java.io.IOException,
                         AutomationException

The fields collection for this object class.

Specified by:

getFields in interface ITemporalTable

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addField

public void addField(IField field)
              throws java.io.IOException,
                     AutomationException

Adds a field to this object class.

Specified by:

addField in interface ITemporalTable

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteField

public void deleteField(IField field)
                 throws java.io.IOException,
                        AutomationException

Deletes a field from this object class.

Specified by:

deleteField in interface ITemporalTable

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createRow

public IRow createRow()
               throws java.io.IOException,
                      AutomationException

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

Specified by:

createRow in interface ITemporalTable

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRow

public IRow getRow(int oID)
            throws java.io.IOException,
                   AutomationException

The row from the database with the specified object ID.

Specified by:

getRow in interface ITemporalTable

Parameters:

oID - The oID (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createRowBuffer

public IRowBuffer createRowBuffer()
                           throws java.io.IOException,
                                  AutomationException

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

Specified by:

createRowBuffer in interface ITemporalTable

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

rowCount

public int rowCount(IQueryFilter queryFilter)
             throws java.io.IOException,
                    AutomationException

The number of Rows selected by the specified query.

Specified by:

rowCount in interface ITemporalTable

Parameters:

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

Returns:

The numRows

Throws:

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

AutomationException - If the ArcObject component throws an exception.

search

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

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

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:

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

AutomationException - If the ArcObject component throws an exception.

update

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

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

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:

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

AutomationException - If the ArcObject component throws an exception.

insert

public ICursor insert(boolean useBuffering)
               throws java.io.IOException,
                      AutomationException

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

Specified by:

insert in interface ITemporalTable

Parameters:

useBuffering - The useBuffering (in)

Returns:

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

Throws:

java.io.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 java.io.IOException,
                            AutomationException

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

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:

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

AutomationException - If the ArcObject component throws an exception.

isHasGeometry

public boolean isHasGeometry()
                      throws java.io.IOException,
                             AutomationException

Identifies if the table contains a geometry field.

Specified by:

isHasGeometry in interface ITemporalTable

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGeometryColumnName

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

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

Specified by:

getGeometryColumnName in interface ITemporalTable

Returns:

The pbstrColumnName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGeometryColumnName

public void setGeometryColumnName(java.lang.String pbstrColumnName)
                           throws java.io.IOException,
                                  AutomationException

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

Specified by:

setGeometryColumnName in interface ITemporalTable

Parameters:

pbstrColumnName - The pbstrColumnName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTrackingColumnIndex

public void setTrackingColumnIndex(int rhs1)
                            throws java.io.IOException,
                                   AutomationException

Receives the column index of the Track ID.

Specified by:

setTrackingColumnIndex in interface ITemporalObservationsTable2

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addRow

public int addRow(IDataMessage piDataMessage)
           throws java.io.IOException,
                  AutomationException

Adds a row to the temporal table.

Specified by:

addRow in interface IInternalTable

Parameters:

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

Returns:

The plRowID

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.