com.esri.arcgis.system
Class TimeInstant

java.lang.Object
  extended by com.esri.arcgis.system.TimeInstant
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, IClone, IDocumentVersionSupportGEN, IPersist, IPersistStream, ITimeInstant, ITimeOffsetOperator, ITimeRelationalOperator, ITimeValue, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable

public class TimeInstant
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ITimeInstant, ITimeValue, ITimeRelationalOperator, ITimeOffsetOperator, IXMLSerialize, IXMLVersionSupport, IClone, IPersistStream, IDocumentVersionSupportGEN, java.io.Externalizable

COM Class 'TimeInstant'. Generated 3/19/2015 1:20:47 PM from 'C:\ArcGIS\COM\esriSystem.olb'

Description 'An object that represents a time-referenced instant in time.' 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.system.ITimeInstant
IID, IID81899ee9_2e12_4e6c_94f1_2ba31d3cdbc5, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.ITimeValue
IID4ce86e17_e819_4c72_bd98_e55ae59b0317
 
Fields inherited from interface com.esri.arcgis.system.ITimeRelationalOperator
IID, IID7cffa76a_6552_4516_8599_98225065249e, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.ITimeOffsetOperator
IID, IID7cbbb8ea_7708_464a_a6c8_96db06521b3a, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IXMLSerialize
IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IXMLVersionSupport
IID, IID72ca65b9_13de_48b7_8443_717b69b72a99, 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
TimeInstant()
          Constructs a TimeInstant using ArcGIS Engine.
TimeInstant(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TimeInstant theTimeInstant = (TimeInstant) obj;
 
Method Summary
 void addDays(double value)
          Adds the input amount of days.
 void addDuration(ITimeDuration timeDuration)
          Adds a time duration.
 void addHours(double value)
          Adds the input amount of hours.
 void addMilliseconds(double value)
          Adds the input amount of milliseconds.
 void addMinutes(double value)
          Adds the input amount of minutes.
 boolean addMonths(double value, boolean preserveEndOfMonth, boolean goForwardOnInvalidDate)
          Adds the input amount of months.
 void addNanoseconds(long value)
          Adds the input amount of nanoseconds.
 void addSeconds(double value)
          Adds the input amount of seconds.
 void addWeeks(double value)
          Adds the input amount of weeks.
 boolean addYears(double value, boolean preserveEndOfMonth, boolean goForwardOnInvalidDate)
          Adds the input amount of years.
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 boolean contains(ITimeValue otherTimeValue)
          Indicates whether this time value contains the other time value.
 java.lang.Object convertToSupportedObject(int docVersion)
          Convert the object to another object that is supported.
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 boolean disjoint(ITimeValue otherTimeValue)
          Indicates whether the input time value falls fully outside of the time extent.
 boolean equals(java.lang.Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 boolean esri_equals(ITimeValue otherTimeValue)
          Indicates whether the two time values are of the same type and define the same time values.
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 java.lang.String getMinNamespaceSupported()
          The minimum namespace the class can serialize to (eg the 90 namespace).
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 ITime getTime()
          The time instant time value.
 ITimeReference getTimeReference()
          The time reference associated with the time value.
 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 project(ITimeReference timeReference)
          Projects this time value from its time reference, to a given time reference.
 void projectFromUTC()
          Projects this time value from UTC, to its time reference.
 void projectToUTC()
          Projects this time value from its time reference, to UTC.
 void readExternal(java.io.ObjectInput in)
           
 void release()
          Release a TimeInstant.
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 void setTime(ITime time)
          The time instant time value.
 void setTimeReferenceByRef(ITimeReference timeReference)
          The time reference associated with the time value.
 void subtractDuration(ITimeDuration timeDuration)
          Subtracts a time duration.
 boolean touches(ITimeValue otherTimeValue)
          Indicates whether the boundaries of the time values intersect.
 boolean within(ITimeValue otherTimeValue)
          Indicates whether this time value is contained (is within) the other time value.
 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

TimeInstant

public TimeInstant()
            throws java.io.IOException,
                   java.net.UnknownHostException
Constructs a TimeInstant using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

TimeInstant

public TimeInstant(java.lang.Object obj)
            throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TimeInstant theTimeInstant = (TimeInstant) obj;

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

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

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getTime

public ITime getTime()
              throws java.io.IOException,
                     AutomationException
The time instant time value.

Specified by:
getTime in interface ITimeInstant
Returns:
A reference to a com.esri.arcgis.system.ITime
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTime

public void setTime(ITime time)
             throws java.io.IOException,
                    AutomationException
The time instant time value.

Specified by:
setTime in interface ITimeInstant
Parameters:
time - A reference to a com.esri.arcgis.system.ITime (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTimeReference

public ITimeReference getTimeReference()
                                throws java.io.IOException,
                                       AutomationException
The time reference associated with the time value.

Specified by:
getTimeReference in interface ITimeValue
Returns:
A reference to a com.esri.arcgis.system.ITimeReference
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTimeReferenceByRef

public void setTimeReferenceByRef(ITimeReference timeReference)
                           throws java.io.IOException,
                                  AutomationException
The time reference associated with the time value.

Specified by:
setTimeReferenceByRef in interface ITimeValue
Parameters:
timeReference - A reference to a com.esri.arcgis.system.ITimeReference (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

project

public void project(ITimeReference timeReference)
             throws java.io.IOException,
                    AutomationException
Projects this time value from its time reference, to a given time reference.

Specified by:
project in interface ITimeValue
Parameters:
timeReference - A reference to a com.esri.arcgis.system.ITimeReference (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

projectToUTC

public void projectToUTC()
                  throws java.io.IOException,
                         AutomationException
Projects this time value from its time reference, to UTC.

Specified by:
projectToUTC in interface ITimeValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

projectFromUTC

public void projectFromUTC()
                    throws java.io.IOException,
                           AutomationException
Projects this time value from UTC, to its time reference.

Specified by:
projectFromUTC in interface ITimeValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_equals

public boolean esri_equals(ITimeValue otherTimeValue)
                    throws java.io.IOException,
                           AutomationException
Indicates whether the two time values are of the same type and define the same time values.

Specified by:
esri_equals in interface ITimeRelationalOperator
Parameters:
otherTimeValue - A reference to a com.esri.arcgis.system.ITimeValue (in)
Returns:
The esri_equals
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

disjoint

public boolean disjoint(ITimeValue otherTimeValue)
                 throws java.io.IOException,
                        AutomationException
Indicates whether the input time value falls fully outside of the time extent.

Specified by:
disjoint in interface ITimeRelationalOperator
Parameters:
otherTimeValue - A reference to a com.esri.arcgis.system.ITimeValue (in)
Returns:
The disjoint
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

touches

public boolean touches(ITimeValue otherTimeValue)
                throws java.io.IOException,
                       AutomationException
Indicates whether the boundaries of the time values intersect.

Specified by:
touches in interface ITimeRelationalOperator
Parameters:
otherTimeValue - A reference to a com.esri.arcgis.system.ITimeValue (in)
Returns:
The touches
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

within

public boolean within(ITimeValue otherTimeValue)
               throws java.io.IOException,
                      AutomationException
Indicates whether this time value is contained (is within) the other time value.

Specified by:
within in interface ITimeRelationalOperator
Parameters:
otherTimeValue - A reference to a com.esri.arcgis.system.ITimeValue (in)
Returns:
The within
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

contains

public boolean contains(ITimeValue otherTimeValue)
                 throws java.io.IOException,
                        AutomationException
Indicates whether this time value contains the other time value.

Specified by:
contains in interface ITimeRelationalOperator
Parameters:
otherTimeValue - A reference to a com.esri.arcgis.system.ITimeValue (in)
Returns:
The contains
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addDuration

public void addDuration(ITimeDuration timeDuration)
                 throws java.io.IOException,
                        AutomationException
Adds a time duration.

Specified by:
addDuration in interface ITimeOffsetOperator
Parameters:
timeDuration - A reference to a com.esri.arcgis.system.ITimeDuration (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

subtractDuration

public void subtractDuration(ITimeDuration timeDuration)
                      throws java.io.IOException,
                             AutomationException
Subtracts a time duration.

Specified by:
subtractDuration in interface ITimeOffsetOperator
Parameters:
timeDuration - A reference to a com.esri.arcgis.system.ITimeDuration (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addYears

public boolean addYears(double value,
                        boolean preserveEndOfMonth,
                        boolean goForwardOnInvalidDate)
                 throws java.io.IOException,
                        AutomationException
Adds the input amount of years.

Specified by:
addYears in interface ITimeOffsetOperator
Parameters:
value - The value (in)
preserveEndOfMonth - The preserveEndOfMonth (in)
goForwardOnInvalidDate - The goForwardOnInvalidDate (in)
Returns:
The dateWasAdjusted
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addMonths

public boolean addMonths(double value,
                         boolean preserveEndOfMonth,
                         boolean goForwardOnInvalidDate)
                  throws java.io.IOException,
                         AutomationException
Adds the input amount of months.

Specified by:
addMonths in interface ITimeOffsetOperator
Parameters:
value - The value (in)
preserveEndOfMonth - The preserveEndOfMonth (in)
goForwardOnInvalidDate - The goForwardOnInvalidDate (in)
Returns:
The dateWasAdjusted
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addWeeks

public void addWeeks(double value)
              throws java.io.IOException,
                     AutomationException
Adds the input amount of weeks.

Specified by:
addWeeks in interface ITimeOffsetOperator
Parameters:
value - The value (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addDays

public void addDays(double value)
             throws java.io.IOException,
                    AutomationException
Adds the input amount of days.

Specified by:
addDays in interface ITimeOffsetOperator
Parameters:
value - The value (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addHours

public void addHours(double value)
              throws java.io.IOException,
                     AutomationException
Adds the input amount of hours.

Specified by:
addHours in interface ITimeOffsetOperator
Parameters:
value - The value (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addMinutes

public void addMinutes(double value)
                throws java.io.IOException,
                       AutomationException
Adds the input amount of minutes.

Specified by:
addMinutes in interface ITimeOffsetOperator
Parameters:
value - The value (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addSeconds

public void addSeconds(double value)
                throws java.io.IOException,
                       AutomationException
Adds the input amount of seconds.

Specified by:
addSeconds in interface ITimeOffsetOperator
Parameters:
value - The value (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addMilliseconds

public void addMilliseconds(double value)
                     throws java.io.IOException,
                            AutomationException
Adds the input amount of milliseconds.

Specified by:
addMilliseconds in interface ITimeOffsetOperator
Parameters:
value - The value (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addNanoseconds

public void addNanoseconds(long value)
                    throws java.io.IOException,
                           AutomationException
Adds the input amount of nanoseconds.

Specified by:
addNanoseconds in interface ITimeOffsetOperator
Parameters:
value - Signed 64-bit int (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException
Serializes an object to XML.

Specified by:
serialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException
Deserializes an object from XML.

Specified by:
deserialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public java.lang.String getMinNamespaceSupported()
                                          throws java.io.IOException,
                                                 AutomationException
The minimum namespace the class can serialize to (eg the 90 namespace).

Specified by:
getMinNamespaceSupported in interface IXMLVersionSupport
Returns:
The namespaceURI
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.

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.

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