com.esri.arcgis.carto
Class ITimeQueryFilterProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.carto.ITimeQueryFilterProxy

All Implemented Interfaces:

ITimeQueryFilter, Externalizable, Serializable

public class ITimeQueryFilterProxy
extends com.esri.arcgis.interop.Dispatch
implements ITimeQueryFilter, Serializable

Query filter that gives access to members that allow queries using time.

Description

The ITimeQueryFilter is used for creating queries to a data set that have a time component. It can be used instead of the normal query filter to hide all of the operations having to do with time zone differences. For example, you could create a query that returns features in the Pacific time zone. All data would be returned with a Pacific time zone time reference, regardless of what time reference was used to store the data.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
ITimeReference	getOutputTimeReference() Output time reference.
int	getTimeRelation() Time relation for the time query.
ITimeValue	getTimeValue() Time value.
void	removeListener(String iidStr, Object theListener)
void	setOutputTimeReferenceByRef(ITimeReference timeReference) Output time reference.
void	setTimeRelation(int relation) Time relation for the time query.
void	setTimeValueByRef(ITimeValue timeValue) Time value.

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

ITimeQueryFilterProxy

public ITimeQueryFilterProxy()

ITimeQueryFilterProxy

public ITimeQueryFilterProxy(Object obj)
                      throws IOException

Throws:

IOException

ITimeQueryFilterProxy

protected ITimeQueryFilterProxy(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

getTimeValue

public ITimeValue getTimeValue()
                        throws IOException,
                               AutomationException

Time value.

Description

This is the time value that is used for the time query. Only data that matches this time value will be returned.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getTimeValue in interface ITimeQueryFilter

Returns:

A reference to a com.esri.arcgis.system.ITimeValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeValueByRef

public void setTimeValueByRef(ITimeValue timeValue)
                       throws IOException,
                              AutomationException

Time value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setTimeValueByRef in interface ITimeQueryFilter

Parameters:

timeValue - A reference to a com.esri.arcgis.system.ITimeValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutputTimeReference

public ITimeReference getOutputTimeReference()
                                      throws IOException,
                                             AutomationException

Output time reference.

Remarks

This is the Time Reference that will be used when returning data from the query. For example, if the output time reference is Pacific, and data is stored in Atlantic time zone, a feature with a time stamp of 4:00 PM will be returned with a time stamp of 1:00 PM (4:00 PM in Atlantic time is equivalent to 1:00 PM in Pacific time).

Note: This is only honored by MapServer's query function such as QueryData

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getOutputTimeReference in interface ITimeQueryFilter

Returns:

A reference to a com.esri.arcgis.system.ITimeReference

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputTimeReferenceByRef

public void setOutputTimeReferenceByRef(ITimeReference timeReference)
                                 throws IOException,
                                        AutomationException

Output time reference.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setOutputTimeReferenceByRef in interface ITimeQueryFilter

Parameters:

timeReference - A reference to a com.esri.arcgis.system.ITimeReference (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeRelation

public int getTimeRelation()
                    throws IOException,
                           AutomationException

Time relation for the time query.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getTimeRelation in interface ITimeQueryFilter

Returns:

A com.esri.arcgis.carto.esriTimeRelation constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeRelation

public void setTimeRelation(int relation)
                     throws IOException,
                            AutomationException

Time relation for the time query.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setTimeRelation in interface ITimeQueryFilter

Parameters:

relation - A com.esri.arcgis.carto.esriTimeRelation constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.