com.esri.arcgis.trackinganalyst
Class TemporalOperator

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

All Implemented Interfaces:

ITemporalOperator, com.esri.arcgis.interop.RemoteObjRef, IClone, IDocumentVersionSupportGEN, IPersist, IPersistStream, ITemporalOperator2, ITemporalOperator3, java.io.Externalizable, java.io.Serializable

public class TemporalOperator
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ITemporalOperator, ITemporalOperator2, ITemporalOperator3, IClone, IPersist, IPersistStream, IDocumentVersionSupportGEN, java.io.Externalizable

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

Description 'Implements ITemporalOperator to identify and manage temporal playback settings.' 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.geodatabaseextensions.ITemporalOperator

IID, IID56ae7150_7bfc_11d6_b84d_00010265adc5, xxDummy

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

IID, IIDeb42cdd1_51f4_4bac_a190_a62d4ed686a0, xxDummy

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

IID, IIDff92f4f1_c224_4a97_9355_48e14a8f4f60, xxDummy

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

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, 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

Constructor Summary

TemporalOperator()
Constructs a TemporalOperator using ArcGIS Engine.

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

Method Summary

void	add(ITemporalOperator piOtherOperator) Adds a new temporal operator.
void	assign(IClone src) Assigns the properties of src to the receiver.
java.lang.Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
java.lang.Object	getAsDate() Temporal information as a date field.
java.lang.Object	getAsInterval(int enumUnits) Temporal information as an interval value.
java.lang.String	getAsString(java.lang.String bstrFormat) Temporal information as a string.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
double	getIntervalQuantity() Number of intervals between events.
int	getIntervalUnits() Units used for interval.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getType() The type of temporal data used.
java.lang.Object	getValue() Value of temporal information.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
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 TemporalOperator.
void	reset() Resets the temporal operator.
void	save(IStream pstm, int fClearDirty) save
void	setDateTime(int lYear, short lMonth, short lDayOfMonth, short lHour, short lMinute, short lSecond, short lMillisecond) Sets the value for date and time information.
void	setDateTimeFromString(java.lang.String bstrDateTime) Sets the value for date and time information from a string.
void	setDateTimeFromVariant(java.lang.Object dateTime) Sets the value for date and time information from a variant.
void	setInterval(double dQuantity, int enumUnits) Sets the playback time interval between events.
void	subtract(ITemporalOperator piOtherOperator) Subtracts a temporal operator.
void	temporalUnitsAsString(int eUnits, int eAppearance, boolean bvPlural, java.lang.String[] pbstrUnitString) Obtains a string representation of a temporal unit enumeration, in upper, lower, or mixed case, with singular or plural form.
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

TemporalOperator

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

Constructs a TemporalOperator using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

TemporalOperator

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

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

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

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

release

public void release()

Release a TemporalOperator.

Specified by:

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

setDateTime

public void setDateTime(int lYear,
                        short lMonth,
                        short lDayOfMonth,
                        short lHour,
                        short lMinute,
                        short lSecond,
                        short lMillisecond)
                 throws java.io.IOException,
                        AutomationException

Sets the value for date and time information.

Specified by:

setDateTime in interface ITemporalOperator

Specified by:

setDateTime in interface ITemporalOperator2

Specified by:

setDateTime in interface ITemporalOperator3

Parameters:

lYear - The lYear (in)

lMonth - The lMonth (in)

lDayOfMonth - The lDayOfMonth (in)

lHour - The lHour (in)

lMinute - The lMinute (in)

lSecond - The lSecond (in)

lMillisecond - The lMillisecond (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setInterval

public void setInterval(double dQuantity,
                        int enumUnits)
                 throws java.io.IOException,
                        AutomationException

Sets the playback time interval between events.

Specified by:

setInterval in interface ITemporalOperator

Specified by:

setInterval in interface ITemporalOperator2

Specified by:

setInterval in interface ITemporalOperator3

Parameters:

dQuantity - The dQuantity (in)

enumUnits - A com.esri.arcgis.geodatabaseextensions.enumTemporalOperatorUnits constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getType

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

The type of temporal data used.

Specified by:

getType in interface ITemporalOperator

Specified by:

getType in interface ITemporalOperator2

Specified by:

getType in interface ITemporalOperator3

Returns:

A com.esri.arcgis.geodatabaseextensions.enumTemporalOperatorType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

reset

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

Resets the temporal operator.

Specified by:

reset in interface ITemporalOperator

Specified by:

reset in interface ITemporalOperator2

Specified by:

reset in interface ITemporalOperator3

Throws:

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

AutomationException - If the ArcObject component throws an exception.

add

public void add(ITemporalOperator piOtherOperator)
         throws java.io.IOException,
                AutomationException

Adds a new temporal operator.

Specified by:

add in interface ITemporalOperator

Specified by:

add in interface ITemporalOperator2

Specified by:

add in interface ITemporalOperator3

Parameters:

piOtherOperator - A reference to a com.esri.arcgis.geodatabaseextensions.ITemporalOperator (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

subtract

public void subtract(ITemporalOperator piOtherOperator)
              throws java.io.IOException,
                     AutomationException

Subtracts a temporal operator.

Specified by:

subtract in interface ITemporalOperator

Specified by:

subtract in interface ITemporalOperator2

Specified by:

subtract in interface ITemporalOperator3

Parameters:

piOtherOperator - A reference to a com.esri.arcgis.geodatabaseextensions.ITemporalOperator (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAsString

public java.lang.String getAsString(java.lang.String bstrFormat)
                             throws java.io.IOException,
                                    AutomationException

Temporal information as a string.

Specified by:

getAsString in interface ITemporalOperator

Specified by:

getAsString in interface ITemporalOperator2

Specified by:

getAsString in interface ITemporalOperator3

Parameters:

bstrFormat - The bstrFormat (in)

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAsDate

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

Temporal information as a date field.

Specified by:

getAsDate in interface ITemporalOperator

Specified by:

getAsDate in interface ITemporalOperator2

Specified by:

getAsDate in interface ITemporalOperator3

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAsInterval

public java.lang.Object getAsInterval(int enumUnits)
                               throws java.io.IOException,
                                      AutomationException

Temporal information as an interval value.

Specified by:

getAsInterval in interface ITemporalOperator

Specified by:

getAsInterval in interface ITemporalOperator2

Specified by:

getAsInterval in interface ITemporalOperator3

Parameters:

enumUnits - A com.esri.arcgis.geodatabaseextensions.enumTemporalOperatorUnits constant (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getValue

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

Value of temporal information.

Specified by:

getValue in interface ITemporalOperator

Specified by:

getValue in interface ITemporalOperator2

Specified by:

getValue in interface ITemporalOperator3

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getIntervalQuantity

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

Number of intervals between events.

Specified by:

getIntervalQuantity in interface ITemporalOperator

Specified by:

getIntervalQuantity in interface ITemporalOperator2

Specified by:

getIntervalQuantity in interface ITemporalOperator3

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getIntervalUnits

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

Units used for interval.

Specified by:

getIntervalUnits in interface ITemporalOperator

Specified by:

getIntervalUnits in interface ITemporalOperator2

Specified by:

getIntervalUnits in interface ITemporalOperator3

Returns:

A com.esri.arcgis.geodatabaseextensions.enumTemporalOperatorUnits constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDateTimeFromString

public void setDateTimeFromString(java.lang.String bstrDateTime)
                           throws java.io.IOException,
                                  AutomationException

Sets the value for date and time information from a string.

Specified by:

setDateTimeFromString in interface ITemporalOperator2

Specified by:

setDateTimeFromString in interface ITemporalOperator3

Parameters:

bstrDateTime - The bstrDateTime (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDateTimeFromVariant

public void setDateTimeFromVariant(java.lang.Object dateTime)
                            throws java.io.IOException,
                                   AutomationException

Sets the value for date and time information from a variant.

Specified by:

setDateTimeFromVariant in interface ITemporalOperator2

Specified by:

setDateTimeFromVariant in interface ITemporalOperator3

Parameters:

dateTime - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

temporalUnitsAsString

public void temporalUnitsAsString(int eUnits,
                                  int eAppearance,
                                  boolean bvPlural,
                                  java.lang.String[] pbstrUnitString)
                           throws java.io.IOException,
                                  AutomationException

Obtains a string representation of a temporal unit enumeration, in upper, lower, or mixed case, with singular or plural form.

Specified by:

temporalUnitsAsString in interface ITemporalOperator3

Parameters:

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

eAppearance - A com.esri.arcgis.system.esriCaseAppearance constant (in)

bvPlural - The bvPlural (in)

pbstrUnitString - The pbstrUnitString (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

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.

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.

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