|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.interop.Dispatch com.esri.arcgis.trackinganalyst.ITemporalFeatureClassProxy
public class ITemporalFeatureClassProxy
Provides access to properties that allow the temporal column to be identified within a feature class and to set the TemporalObjectColumn name.
This interface provides properties that allow the temporal column to be identified within a feature class, and properties to set the TemporalObjectColumnName otherwise known as the tracking id. This interface also provides functions to prune the underline table of the TemporalFeatureClass, and to query the feature class using the full temporal extent.
Field Summary | |
---|---|
boolean |
noncastable
|
Fields inherited from class com.esri.arcgis.interop.Dispatch |
---|
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef |
Constructor Summary | |
---|---|
|
ITemporalFeatureClassProxy()
|
|
ITemporalFeatureClassProxy(Object obj)
|
protected |
ITemporalFeatureClassProxy(Object obj,
String iid)
|
Method Summary | |
---|---|
void |
addListener(String iidStr,
Object theListener,
Object theSource)
|
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). |
String |
getTemporalColumnName()
Name of the column containing the time-date information. |
String |
getTemporalObjectColumnName()
Name of the column containing the track information. |
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(Object[] pvarStartTime,
Object[] pvarEndTime)
Queries the feature class using the full temporal extent. |
void |
registerListener(IListener piListener)
Registers a Listener Object with the feature class. |
void |
removeListener(String iidStr,
Object theListener)
|
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(String pVal)
Name of the column containing the time-date information. |
void |
setThreshold(Object pVal)
Indicates the high-water mark, or maximum number of observations allowed before records are purged from memory. |
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, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public boolean noncastable
Constructor Detail |
---|
public ITemporalFeatureClassProxy()
public ITemporalFeatureClassProxy(Object obj) throws IOException
IOException
protected ITemporalFeatureClassProxy(Object obj, String iid) throws IOException
IOException
Method Detail |
---|
public void addListener(String iidStr, Object theListener, Object theSource) throws IOException
addListener
in class com.esri.arcgis.interop.Dispatch
IOException
public void removeListener(String iidStr, Object theListener) throws IOException
removeListener
in class com.esri.arcgis.interop.Dispatch
IOException
public void queryTemporalExtent(Object[] pvarStartTime, Object[] pvarEndTime) throws IOException, AutomationException
This function returns the full temporal extent of data stored in the feature class. The returned objects are VT_DATE type (e.g., “mm/dd/yyyy hh:mm:ss AM/PM”).
queryTemporalExtent
in interface ITemporalFeatureClass
pvarStartTime
- A Variant (in/out: use single element array)pvarEndTime
- A Variant (in/out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getTemporalColumnName() throws IOException, AutomationException
This property is the name of the column that contains the temporal data. This data can be a timestamp or a time period.
getTemporalColumnName
in interface ITemporalFeatureClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTemporalColumnName(String pVal) throws IOException, AutomationException
This property is the name of the column that contains the temporal data. This data can be a timestamp or a time period.
setTemporalColumnName
in interface ITemporalFeatureClass
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isContainsTemporalObjects() throws IOException, AutomationException
This property indicates whether or not a temporal object table is used to collect or provide static information about temporal observations. This simply means that for a given temporal observation there is a set of static attributes that do not change from observation to observation.
isContainsTemporalObjects
in interface ITemporalFeatureClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getTemporalObjectColumnName() throws IOException, AutomationException
This property returns the column name that provides the temporal data. This property is set during the feature classes creation and is read-only.
getTemporalObjectColumnName
in interface ITemporalFeatureClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IActionProcessor getPostActionProcessor() throws IOException, AutomationException
The post action processor is the action processor that will evaluate data messages once they are placed in the feature class's internal storage. These data messages are queued to the actions processor's work queue, and a separate thread is used to perform this processing.
getPostActionProcessor
in interface ITemporalFeatureClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setPostActionProcessorByRef(IActionProcessor ppiProcessor) throws IOException, AutomationException
The post action processor is the action processor that will evaluate data messages once they are placed in the feature class's internal storage. These data messages are queued to the actions processor's work queue, and a separate thread is used to perform this processing.
setPostActionProcessorByRef
in interface ITemporalFeatureClass
ppiProcessor
- A reference to a com.esri.arcgis.carto.IActionProcessor (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IActionCollection getPostActions() throws IOException, AutomationException
This property is a collection of actions that will be evaluated after data messages are placed in the temporal feature class's internal storage.
getPostActions
in interface ITemporalFeatureClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setPostActionsByRef(IActionCollection ppiActions) throws IOException, AutomationException
This property is a collection of actions that will be evaluated after data messages are place in the temporal feature class's internal storage.
setPostActionsByRef
in interface ITemporalFeatureClass
ppiActions
- A reference to a com.esri.arcgis.carto.IActionCollection (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void registerListener(IListener piListener) throws IOException, AutomationException
registerListener
in interface ITemporalFeatureClass
piListener
- A reference to a com.esri.arcgis.geodatabaseextensions.IListener (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isAutoPurge() throws IOException, AutomationException
This property controls whether or not to automatically purge observations that meet a specified criteria--the user-defined Purge Rule--when the high-water mark has been exceeded.
isAutoPurge
in interface ITemporalFeatureClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setAutoPurge(boolean pVal) throws IOException, AutomationException
This property controls whether or not to automatically purge observations that meet a specified criteria--the user-defined Purge Rule--when the high-water mark has been exceeded.
setAutoPurge
in interface ITemporalFeatureClass
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object getThreshold() throws IOException, AutomationException
This property indicates the high-water mark or the number of observations that should not be exceeded. When the auto purge property is enabled or true, this level is the maximum number of records that can exist in the table. The auto purge process occurs or is triggered, and it will prune the table according to the Purge Rule. If Auto Purge is not true or enabled then record inserts will fail and no further data will be allowed into the table.
getThreshold
in interface ITemporalFeatureClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setThreshold(Object pVal) throws IOException, AutomationException
This property indicates the high-water mark or the number of observations that should not be exceeded. When the auto purge property is enabled or true, this level is the maximum number of records that can exist in the table. The auto purge process occurs or is triggered, and it will prune the table according to the Purge Rule. If Auto Purge is not true or enabled then record inserts will fail and no further data will be allowed into the table.
setThreshold
in interface ITemporalFeatureClass
pVal
- A Variant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getPurgePercentage() throws IOException, AutomationException
This property indicates the percentage of the maximum allowed number of records to delete when the Purge method is called. This maximum allowed limit is also the same as the Threshold property.
getPurgePercentage
in interface ITemporalFeatureClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setPurgePercentage(double pVal) throws IOException, AutomationException
This property indicates the percentage of the maximum allowed number of records to delete when the Purge method is called. This maximum allowed limit is also the same as the Threshold property.
setPurgePercentage
in interface ITemporalFeatureClass
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getPurgeRule() throws IOException, AutomationException
This property identifies the purge rule to apply when the Purge method is called via user, or the auto purge criteria. See the purge rule enumeration constants for details about each rule.
getPurgeRule
in interface ITemporalFeatureClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setPurgeRule(int pVal) throws IOException, AutomationException
This property identifies the purge rule to apply when the Purge method is called via user ,or the auto purge criteria.
See the purge rule enumeration constants for details about each rule.
setPurgeRule
in interface ITemporalFeatureClass
pVal
- A com.esri.arcgis.geodatabaseextensions.enumPurgeRule constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void pruneTable() throws IOException, AutomationException
This function applies the purge rule to the temporal table to purge observations that meet a specified criteria--the user-defined Purge Rule--when the high-water mark has been exceeded.
pruneTable
in interface ITemporalFeatureClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |