com.esri.arcgis.trackinganalyst
Class TemporalReference

java.lang.Object
  com.esri.arcgis.trackinganalyst.TemporalReference

All Implemented Interfaces:

IConnectionPointContainer, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, IPersist, IPersistStream, ISupportErrorInfo, ITemporalReference, java.io.Externalizable, java.io.Serializable

public class TemporalReference
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ITemporalReference, ISupportErrorInfo, IPersistStream, IConnectionPointContainer, IDocumentVersionSupportGEN, java.io.Externalizable

COM Class 'TemporalReference'. Generated 3/19/2015 1:20:45 PM from 'C:\ArcGIS\COM\esriTrackingAnalyst.olb'

Description 'Maintains temporal perspective on data and notifies all clients when the value changes.' 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 =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.trackinganalyst.ITemporalReference

IID, IID78c74237_17cf_11d5_b7cf_00010265adc5, xxDummy

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer

IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy

Constructor Summary

TemporalReference()
Constructs a TemporalReference using ArcGIS Engine.

TemporalReference(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TemporalReference theTemporalReference = (TemporalReference) obj;

Method Summary

void	add_ITemporalReferenceEventsListener(_ITemporalReferenceEvents theListener) add_ITemporalReferenceEventsListener.
java.lang.Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(java.lang.Object o) Compare this object with another
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getTemporalMode() Controls the behavior of temporal reference to reflect real-time or playback mode.
double	getTemporalPeriod() Used by the temporal renderer property page to determine the default time period for the temporal legend classes.
int	getTemporalPeriodUnits() Describes the temporal units that define the temporal period property.
java.lang.Object	getTemporalPerspective() Timestamp used by the temporal renderer to compare its time ranges stored in the temporal legend's temporal classes.
java.lang.Object	getTemporalPerspectiveAsDate() The current temporal perspective in COleDateTime format, so the temporal perspective can be retrieved from VB.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	isDirty() isDirty
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a TemporalReference.
void	remove_ITemporalReferenceEventsListener(_ITemporalReferenceEvents theListener) remove_ITemporalReferenceEventsListener.
void	save(IStream pstm, int fClearDirty) save
void	setTemporalMode(int pVal) Controls the behavior of temporal reference to reflect real-time or playback mode.
void	setTemporalPeriod(double pVal) Used by the temporal renderer property page to determine the default time period for the temporal legend classes.
void	setTemporalPeriodUnits(int pVal) Describes the temporal units that define the temporal period property.
void	setTemporalPerspective(java.lang.Object pVal) Timestamp used by the temporal renderer to compare its time ranges stored in the temporal legend's temporal classes.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

TemporalReference

public TemporalReference()
                  throws java.io.IOException,
                         java.net.UnknownHostException

Constructs a TemporalReference using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

TemporalReference

public TemporalReference(java.lang.Object obj)
                  throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TemporalReference theTemporalReference = (TemporalReference) obj;

Construct a TemporalReference using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to TemporalReference.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

add_ITemporalReferenceEventsListener

public void add_ITemporalReferenceEventsListener(_ITemporalReferenceEvents theListener)
                                          throws java.io.IOException

add_ITemporalReferenceEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.trackinganalyst._ITemporalReferenceEvents interface.

Throws:

java.io.IOException - If there are communications problems.

remove_ITemporalReferenceEventsListener

public void remove_ITemporalReferenceEventsListener(_ITemporalReferenceEvents theListener)
                                             throws java.io.IOException

remove_ITemporalReferenceEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.trackinganalyst._ITemporalReferenceEvents interface.

Throws:

java.io.IOException - If there are communications problems.

release

public void release()

Release a TemporalReference.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getTemporalPerspective

public java.lang.Object getTemporalPerspective()
                                        throws java.io.IOException,
                                               AutomationException

Timestamp used by the temporal renderer to compare its time ranges stored in the temporal legend's temporal classes.

Specified by:

getTemporalPerspective in interface ITemporalReference

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemporalPerspective

public void setTemporalPerspective(java.lang.Object pVal)
                            throws java.io.IOException,
                                   AutomationException

Timestamp used by the temporal renderer to compare its time ranges stored in the temporal legend's temporal classes.

Specified by:

setTemporalPerspective in interface ITemporalReference

Parameters:

pVal - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemporalMode

public int getTemporalMode()
                    throws java.io.IOException,
                           AutomationException

Controls the behavior of temporal reference to reflect real-time or playback mode.

Specified by:

getTemporalMode in interface ITemporalReference

Returns:

A com.esri.arcgis.trackinganalyst.enumTemporalMode constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemporalMode

public void setTemporalMode(int pVal)
                     throws java.io.IOException,
                            AutomationException

Controls the behavior of temporal reference to reflect real-time or playback mode.

Specified by:

setTemporalMode in interface ITemporalReference

Parameters:

pVal - A com.esri.arcgis.trackinganalyst.enumTemporalMode constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemporalPeriod

public double getTemporalPeriod()
                         throws java.io.IOException,
                                AutomationException

Used by the temporal renderer property page to determine the default time period for the temporal legend classes.

Specified by:

getTemporalPeriod in interface ITemporalReference

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemporalPeriod

public void setTemporalPeriod(double pVal)
                       throws java.io.IOException,
                              AutomationException

Used by the temporal renderer property page to determine the default time period for the temporal legend classes.

Specified by:

setTemporalPeriod in interface ITemporalReference

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemporalPeriodUnits

public int getTemporalPeriodUnits()
                           throws java.io.IOException,
                                  AutomationException

Describes the temporal units that define the temporal period property.

Specified by:

getTemporalPeriodUnits in interface ITemporalReference

Returns:

A com.esri.arcgis.trackinganalyst.enumTemporalUnits constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemporalPeriodUnits

public void setTemporalPeriodUnits(int pVal)
                            throws java.io.IOException,
                                   AutomationException

Describes the temporal units that define the temporal period property.

Specified by:

setTemporalPeriodUnits in interface ITemporalReference

Parameters:

pVal - A com.esri.arcgis.trackinganalyst.enumTemporalUnits constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemporalPerspectiveAsDate

public java.lang.Object getTemporalPerspectiveAsDate()
                                              throws java.io.IOException,
                                                     AutomationException

The current temporal perspective in COleDateTime format, so the temporal perspective can be retrieved from VB.

Specified by:

getTemporalPerspectiveAsDate in interface ITemporalReference

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws java.io.IOException,
                                 AutomationException

enumConnectionPoints

Specified by:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws java.io.IOException,
                                AutomationException

findConnectionPoint

Specified by:

findConnectionPoint in interface IConnectionPointContainer

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws java.io.IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public java.lang.Object convertToSupportedObject(int docVersion)
                                          throws java.io.IOException,
                                                 AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException