com.esri.arcgis.trackinganalyst
Class ITemporalQueryFilterProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.trackinganalyst.ITemporalQueryFilterProxy

All Implemented Interfaces:

ITemporalQueryFilter, Externalizable, Serializable

public class ITemporalQueryFilterProxy
extends com.esri.arcgis.interop.Dispatch
implements ITemporalQueryFilter, 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.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	ITemporalQueryFilterProxy()
	ITemporalQueryFilterProxy(Object obj)
protected	ITemporalQueryFilterProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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	removeListener(String iidStr, Object theListener)
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.

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

noncastable

public boolean noncastable

Constructor Detail

ITemporalQueryFilterProxy

public ITemporalQueryFilterProxy()

ITemporalQueryFilterProxy

public ITemporalQueryFilterProxy(Object obj)
                          throws IOException

Throws:

IOException

ITemporalQueryFilterProxy

protected ITemporalQueryFilterProxy(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 com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getTemporalOrder

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

Specified by:

getTemporalOrder in interface ITemporalQueryFilter

Returns:

A com.esri.arcgis.trackinganalyst.enumTemporalOrder constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemporalOrder

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

Specified by:

setTemporalOrder in interface ITemporalQueryFilter

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

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

Specified by:

getTemporalRelationship in interface ITemporalQueryFilter

Returns:

A com.esri.arcgis.trackinganalyst.enumTemporalRelation constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemporalRelationship

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

Specified by:

setTemporalRelationship in interface ITemporalQueryFilter

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

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

Specified by:

getStartingDate in interface ITemporalQueryFilter

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartingDate

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

Specified by:

setStartingDate in interface ITemporalQueryFilter

Parameters:

pVal - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEndingDate

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

Specified by:

getEndingDate in interface ITemporalQueryFilter

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEndingDate

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

Specified by:

setEndingDate in interface ITemporalQueryFilter

Parameters:

pVal - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemporalConversion

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

Specified by:

getTemporalConversion in interface ITemporalQueryFilter

Returns:

A com.esri.arcgis.trackinganalyst.enumTemporalConversion constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemporalConversion

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

Specified by:

setTemporalConversion in interface ITemporalQueryFilter

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

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

Specified by:

getRelativeTimeOperator in interface ITemporalQueryFilter

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

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

Specified by:

setRelativeTimeOperator in interface ITemporalQueryFilter

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.