com.esri.arcgis.trackinganalyst
Interface ITemporalQueryFilter

All Superinterfaces:
Serializable
All Known Implementing Classes:
TemporalQueryFilter

public interface ITemporalQueryFilter
extends Serializable

Provides access to properties and methods needed to manage temporal query filters.

Product Availability

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


Method Summary
 Object getEndingDate()
          Indicates the latest date included in the query.
 ITemporalOperator getRelativeTimeOperator()
          The object that contains a relative time to offset the temporal values.
 Object getStartingDate()
          Indicates the earliest date included in the query.
 int getTemporalConversion()
          The temporal conversion mode to use (if any) by the temporal query.
 int getTemporalOrder()
          Defines order in which temporal records are sorted.
 int getTemporalRelationship()
          The temporal relation used in the temporal query.
 void setEndingDate(Object pVal)
          Indicates the latest date included in the query.
 void setRelativeTimeOperator(ITemporalOperator pVal)
          The object that contains a relative time to offset the temporal values.
 void setStartingDate(Object pVal)
          Indicates the earliest date included in the query.
 void setTemporalConversion(int pVal)
          The temporal conversion mode to use (if any) by the temporal query.
 void setTemporalOrder(int pVal)
          Defines order in which temporal records are sorted.
 void setTemporalRelationship(int pVal)
          The temporal relation used in the temporal query.
 

Method Detail

getTemporalOrder

int getTemporalOrder()
                     throws IOException,
                            AutomationException
Defines order in which temporal records are sorted.

Description

Returns or sets whether the data should be returned in ascending or descending temporal order.

Product Availability

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

Returns:
A com.esri.arcgis.trackinganalyst.enumTemporalOrder constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTemporalOrder

void setTemporalOrder(int pVal)
                      throws IOException,
                             AutomationException
Defines order in which temporal records are sorted.

Product Availability

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

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

getTemporalRelationship

int getTemporalRelationship()
                            throws IOException,
                                   AutomationException
The temporal relation used in the temporal query.

Description

Reserved for future use. This should be set to enumTemporalRelationContains.

Product Availability

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

Returns:
A com.esri.arcgis.trackinganalyst.enumTemporalRelation constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTemporalRelationship

void setTemporalRelationship(int pVal)
                             throws IOException,
                                    AutomationException
The temporal relation used in the temporal query.

Product Availability

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

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

getStartingDate

Object getStartingDate()
                       throws IOException,
                              AutomationException
Indicates the earliest date included in the query.

Description

Returns or sets the start date and time of the temporal extent the query filter will search.

Remarks

The extent for the TemporalQueryFilter is inclusive so events that occur on the end date will be returned in the query. For example, a start date of 8/1/2000 00:00:00 will return events that occur at 8/1/2000 00:00:00, but not at 7/31/2000 11:59:59. If the time is not specified in the date, midnight is assumed.

Product Availability

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

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

setStartingDate

void setStartingDate(Object pVal)
                     throws IOException,
                            AutomationException
Indicates the earliest date included in the query.

Product Availability

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

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

getEndingDate

Object getEndingDate()
                     throws IOException,
                            AutomationException
Indicates the latest date included in the query.

Description

Returns or sets the end date and time of the temporal extent the query filter will search.

Remarks

The extent for the TemporalQueryFilter is inclusive so events that occur on the end date will be returned in the query. For example, an end date of 8/1/2000 00:00:00 will return events that occur at 8/1/2000 00:00:00, but not at 8/1/2000 00:00:01. If the time is not specified in the date, midnight is assumed.

Product Availability

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

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

setEndingDate

void setEndingDate(Object pVal)
                   throws IOException,
                          AutomationException
Indicates the latest date included in the query.

Product Availability

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

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

getTemporalConversion

int getTemporalConversion()
                          throws IOException,
                                 AutomationException
The temporal conversion mode to use (if any) by the temporal query.

Description

Returns or sets the format of the temporal column in the cursor returned by the executed query. The default format is as an OLEDateTime.

Product Availability

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

Returns:
A com.esri.arcgis.trackinganalyst.enumTemporalConversion constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTemporalConversion

void setTemporalConversion(int pVal)
                           throws IOException,
                                  AutomationException
The temporal conversion mode to use (if any) by the temporal query.

Product Availability

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

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

getRelativeTimeOperator

ITemporalOperator getRelativeTimeOperator()
                                          throws IOException,
                                                 AutomationException
The object that contains a relative time to offset the temporal values.

Description

Returns or sets the TemporalOperator to apply to the temporal query. The TemporalOperator allows for time shifting data by applying an offset to all of the temporal values in the dataset. Applying temporal operators is incredibly useful in analyzing historical trends by enabling past predictions or data to be overlaid with more recent data.

Remarks

The temporal offest applies only to the result from the temporal query. The start and end dates of the TemporalQueryFilter are not affected. The TemporalOperator can be applied as either a date or an interval. If the temporal operator is a date then the earliest feature returned by the query will occur at this new start date and all subsequent features will follow after it. If the temporal operator is defined as an interval then each feature is offset by the specified duration.

Product Availability

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

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

setRelativeTimeOperator

void setRelativeTimeOperator(ITemporalOperator pVal)
                             throws IOException,
                                    AutomationException
The object that contains a relative time to offset the temporal values.

Product Availability

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

Parameters:
pVal - A reference to a com.esri.arcgis.trackinganalyst.ITemporalOperator (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.