com.esri.arcgis.trackinganalyst
Interface ITemporalFeatureClass

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
ITemporalFeatureClass3
All Known Implementing Classes:
ITemporalFeatureClass3Proxy, ITemporalFeatureClassProxy, TemporalFeatureClass

public interface ITemporalFeatureClass
extends java.io.Serializable

COM Interface 'ITemporalFeatureClass'. Generated 3/19/2015 1:20:59 PM from 'C:\ArcGIS\COM\esriTrackingAnalyst.olb'

Description: 'Provides access to properties that allow the temporal column to be identified within a feature class and to set the TemporalObjectColumn name.' 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 =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IIDa677ab61_2fb8_11d5_b7e2_00010265adc5
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 IActionProcessor getPostActionProcessor()
          Evaluates data messages once they are placed in the feature class' internal storage.
 IActionCollection getPostActions()
          Collection of actions that will be evaluated after data messages are placed in the temporal feature class' internal storage.
 double getPurgePercentage()
          Indicates percentage of the maximum number of records to delete when the Purge method is called.
 int getPurgeRule()
          Indicates rule to use when purging records when AutoPurge is true (e.g., purge oldest records).
 java.lang.String getTemporalColumnName()
          Name of the column containing the time-date information.
 java.lang.String getTemporalObjectColumnName()
          Name of the column containing the track information.
 java.lang.Object getThreshold()
          Indicates the high-water mark, or maximum number of observations allowed before records are purged from memory.
 boolean isAutoPurge()
          Controls whether or not to automatically purge records once a user-defined threshold is met.
 boolean isContainsTemporalObjects()
          Indicates whether or not a temporal object table is used to collect or provide static information about temporal observations.
 void pruneTable()
          Apply the purge rule to the temporal table.
 void queryTemporalExtent(java.lang.Object[] pvarStartTime, java.lang.Object[] pvarEndTime)
          Queries the feature class using the full temporal extent.
 void registerListener(IListener piListener)
          Registers a Listener Object with the feature class.
 void setAutoPurge(boolean pVal)
          Controls whether or not to automatically purge records once a user-defined threshold is met.
 void setPostActionProcessorByRef(IActionProcessor ppiProcessor)
          Evaluates data messages once they are placed in the feature class' internal storage.
 void setPostActionsByRef(IActionCollection ppiActions)
          Collection of actions that will be evaluated after data messages are placed in the temporal feature class' internal storage.
 void setPurgePercentage(double pVal)
          Indicates percentage of the maximum number of records to delete when the Purge method is called.
 void setPurgeRule(int pVal)
          Indicates rule to use when purging records when AutoPurge is true (e.g., purge oldest records).
 void setTemporalColumnName(java.lang.String pVal)
          Name of the column containing the time-date information.
 void setThreshold(java.lang.Object pVal)
          Indicates the high-water mark, or maximum number of observations allowed before records are purged from memory.
 

Field Detail

IIDa677ab61_2fb8_11d5_b7e2_00010265adc5

static final int IIDa677ab61_2fb8_11d5_b7e2_00010265adc5
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

queryTemporalExtent

void queryTemporalExtent(java.lang.Object[] pvarStartTime,
                         java.lang.Object[] pvarEndTime)
                         throws java.io.IOException,
                                AutomationException
Queries the feature class using the full temporal extent.

Parameters:
pvarStartTime - A Variant (in/out: use single element array)
pvarEndTime - A Variant (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTemporalColumnName

java.lang.String getTemporalColumnName()
                                       throws java.io.IOException,
                                              AutomationException
Name of the column containing the time-date information.

Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTemporalColumnName

void setTemporalColumnName(java.lang.String pVal)
                           throws java.io.IOException,
                                  AutomationException
Name of the column containing the time-date information.

Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isContainsTemporalObjects

boolean isContainsTemporalObjects()
                                  throws java.io.IOException,
                                         AutomationException
Indicates whether or not a temporal object table is used to collect or provide static information about temporal observations.

Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTemporalObjectColumnName

java.lang.String getTemporalObjectColumnName()
                                             throws java.io.IOException,
                                                    AutomationException
Name of the column containing the track information.

Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPostActionProcessor

IActionProcessor getPostActionProcessor()
                                        throws java.io.IOException,
                                               AutomationException
Evaluates data messages once they are placed in the feature class' internal storage.

Returns:
A reference to a com.esri.arcgis.carto.IActionProcessor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPostActionProcessorByRef

void setPostActionProcessorByRef(IActionProcessor ppiProcessor)
                                 throws java.io.IOException,
                                        AutomationException
Evaluates data messages once they are placed in the feature class' internal storage.

Parameters:
ppiProcessor - A reference to a com.esri.arcgis.carto.IActionProcessor (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPostActions

IActionCollection getPostActions()
                                 throws java.io.IOException,
                                        AutomationException
Collection of actions that will be evaluated after data messages are placed in the temporal feature class' internal storage.

Returns:
A reference to a com.esri.arcgis.carto.IActionCollection
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPostActionsByRef

void setPostActionsByRef(IActionCollection ppiActions)
                         throws java.io.IOException,
                                AutomationException
Collection of actions that will be evaluated after data messages are placed in the temporal feature class' internal storage.

Parameters:
ppiActions - A reference to a com.esri.arcgis.carto.IActionCollection (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

registerListener

void registerListener(IListener piListener)
                      throws java.io.IOException,
                             AutomationException
Registers a Listener Object with the feature class.

Parameters:
piListener - A reference to a com.esri.arcgis.geodatabaseextensions.IListener (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAutoPurge

boolean isAutoPurge()
                    throws java.io.IOException,
                           AutomationException
Controls whether or not to automatically purge records once a user-defined threshold is met.

Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAutoPurge

void setAutoPurge(boolean pVal)
                  throws java.io.IOException,
                         AutomationException
Controls whether or not to automatically purge records once a user-defined threshold is met.

Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getThreshold

java.lang.Object getThreshold()
                              throws java.io.IOException,
                                     AutomationException
Indicates the high-water mark, or maximum number of observations allowed before records are purged from memory.

Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setThreshold

void setThreshold(java.lang.Object pVal)
                  throws java.io.IOException,
                         AutomationException
Indicates the high-water mark, or maximum number of observations allowed before records are purged from memory.

Parameters:
pVal - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPurgePercentage

double getPurgePercentage()
                          throws java.io.IOException,
                                 AutomationException
Indicates percentage of the maximum number of records to delete when the Purge method is called.

Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPurgePercentage

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

Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPurgeRule

int getPurgeRule()
                 throws java.io.IOException,
                        AutomationException
Indicates rule to use when purging records when AutoPurge is true (e.g., purge oldest records).

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

void setPurgeRule(int pVal)
                  throws java.io.IOException,
                         AutomationException
Indicates rule to use when purging records when AutoPurge is true (e.g., purge oldest records).

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

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

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.