com.esri.arcgis.trackinganalyst
Class ITemporalObservationsTableProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.trackinganalyst.ITemporalTableProxy
          extended by com.esri.arcgis.trackinganalyst.ITemporalObservationsTableProxy
All Implemented Interfaces:
ITemporalObservationsTable, ITemporalTable, Externalizable, Serializable
Direct Known Subclasses:
ITemporalObservationsTable2Proxy

public class ITemporalObservationsTableProxy
extends ITemporalTableProxy
implements ITemporalObservationsTable, Serializable

Superseded By

ITemporalObservationsTable2

Product Availability

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

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  ITemporalObservationsTableProxy()
           
  ITemporalObservationsTableProxy(Object obj)
           
protected ITemporalObservationsTableProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 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).
 String getTemporalColumnName()
          The column that is responsible for providing the temporal information.
 Object getThreshold()
          The high-water mark or the number of observations that should not be exceeded Threshold.
 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 isPersistant()
          Reserved for future.
 void pruneTable()
          Apply the purge rule to the temporal table.
 void queryTemporalExtent(Object[] pvarStartTime, Object[] pvarEndTime)
          Provides the time range of all records in the temporal table.
 void readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 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 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(String pVal)
          The column that is responsible for providing the temporal information.
 void setThreshold(Object pvarVal)
          The high-water mark or the number of observations that should not be exceeded Threshold.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.trackinganalyst.ITemporalTableProxy
addField, createRow, createRowBuffer, deleteField, findField, getFields, getGeometryColumnName, getRow, insert, isHasGeometry, rowCount, search, select, setGeometryColumnName, update
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.trackinganalyst.ITemporalTable
addField, createRow, createRowBuffer, deleteField, findField, getFields, getGeometryColumnName, getRow, insert, isHasGeometry, rowCount, search, select, setGeometryColumnName, update
 

Constructor Detail

ITemporalObservationsTableProxy

public ITemporalObservationsTableProxy()

ITemporalObservationsTableProxy

public ITemporalObservationsTableProxy(Object obj)
                                throws IOException
Throws:
IOException

ITemporalObservationsTableProxy

protected ITemporalObservationsTableProxy(Object obj,
                                          String iid)
                                   throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class ITemporalTableProxy
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class ITemporalTableProxy
Throws:
IOException

isAutoPurge

public boolean isAutoPurge()
                    throws 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.

Product Availability

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

Specified by:
isAutoPurge in interface ITemporalObservationsTable
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAutoPurge

public void setAutoPurge(boolean pVal)
                  throws 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.

Product Availability

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

Specified by:
setAutoPurge in interface ITemporalObservationsTable
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getThreshold

public Object getThreshold()
                    throws IOException,
                           AutomationException
The high-water mark or the number of observations that should not be exceeded Threshold.

Product Availability

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

Specified by:
getThreshold in interface ITemporalObservationsTable
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setThreshold

public void setThreshold(Object pvarVal)
                  throws IOException,
                         AutomationException
The high-water mark or the number of observations that should not be exceeded Threshold.

Product Availability

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

Specified by:
setThreshold in interface ITemporalObservationsTable
Parameters:
pvarVal - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPurgePercentage

public double getPurgePercentage()
                          throws IOException,
                                 AutomationException
The percentage of the maximum allowed number of records to delete when the Purge method is called.

Product Availability

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

Specified by:
getPurgePercentage in interface ITemporalObservationsTable
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPurgePercentage

public void setPurgePercentage(double pVal)
                        throws IOException,
                               AutomationException
The percentage of the maximum allowed number of records to delete when the Purge method is called.

Product Availability

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

Specified by:
setPurgePercentage in interface ITemporalObservationsTable
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isPersistant

public boolean isPersistant()
                     throws IOException,
                            AutomationException
Reserved for future.

Product Availability

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

Specified by:
isPersistant in interface ITemporalObservationsTable
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPersistant

public void setPersistant(boolean pVal)
                   throws IOException,
                          AutomationException
Reserved for future.

Product Availability

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

Specified by:
setPersistant in interface ITemporalObservationsTable
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTemporalColumnName

public String getTemporalColumnName()
                             throws 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.

Product Availability

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

Specified by:
getTemporalColumnName in interface ITemporalObservationsTable
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTemporalColumnName

public void setTemporalColumnName(String pVal)
                           throws 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.

Product Availability

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

Specified by:
setTemporalColumnName in interface ITemporalObservationsTable
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPurgeRule

public int getPurgeRule()
                 throws IOException,
                        AutomationException
Identifies the purge rule to apply when PruneTable method is called (via user S/W or auto purge criteria).

Product Availability

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

Specified by:
getPurgeRule in interface ITemporalObservationsTable
Returns:
A com.esri.arcgis.trackinganalyst.enumPurgeRule constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPurgeRule

public void setPurgeRule(int pVal)
                  throws IOException,
                         AutomationException
Identifies the purge rule to apply when PruneTable method is called (via user S/W or auto purge criteria).

Product Availability

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

Specified by:
setPurgeRule in interface ITemporalObservationsTable
Parameters:
pVal - A com.esri.arcgis.trackinganalyst.enumPurgeRule constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

pruneTable

public void pruneTable()
                throws IOException,
                       AutomationException
Apply the purge rule to the temporal table.

Product Availability

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

Specified by:
pruneTable in interface ITemporalObservationsTable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryTemporalExtent

public void queryTemporalExtent(Object[] pvarStartTime,
                                Object[] pvarEndTime)
                         throws IOException,
                                AutomationException
Provides the time range of all records in the temporal table.

Product Availability

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

Specified by:
queryTemporalExtent in interface ITemporalObservationsTable
Parameters:
pvarStartTime - A Variant (out: use single element array)
pvarEndTime - A Variant (out: use single element array)
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
Overrides:
writeExternal in class ITemporalTableProxy
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class ITemporalTableProxy
Throws:
IOException
ClassNotFoundException