com.esri.arcgis.animation
Class TimeWindow

java.lang.Object
  extended by com.esri.arcgis.animation.TimeWindow
All Implemented Interfaces:
ITimeWindow, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, Externalizable, Serializable

public class TimeWindow
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ITimeWindow, IPersistStream, IClone, Externalizable

The Time Window object.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
TimeWindow()
          Constructs a TimeWindow using ArcGIS Engine.
TimeWindow(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TimeWindow theTimeWindow = (TimeWindow) obj;
 
Method Summary
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 boolean equals(Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 String getDefinitionQuery()
          The definition query.
 String getEndField()
          The end field.
 String getEndFieldFormat()
          The end field format.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 String getStartField()
          The start field.
 String getStartFieldFormat()
          The start field format.
 int hashCode()
          the hashcode for this object
 boolean isAnimateCumulatively()
          Indicates whether to animate the display cumulatively.
 void isDirty()
          isDirty
 boolean isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 void load(IStream pstm)
          load
 void readExternal(ObjectInput in)
           
 void save(IStream pstm, int fClearDirty)
          save
 void setAnimateCumulatively(boolean pAnimateFieldsCumulatively)
          Indicates whether to animate the display cumulatively.
 void setDefinitionQuery(String pQuery)
          The definition query.
 void setEndField(String pField)
          The end field.
 void setEndFieldFormat(String pFieldFormat)
          The end field format.
 void setStartField(String pField)
          The start field.
 void setStartFieldFormat(String pField)
          The start field format.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

TimeWindow

public TimeWindow()
           throws IOException,
                  UnknownHostException
Constructs a TimeWindow using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

TimeWindow

public TimeWindow(Object obj)
           throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TimeWindow theTimeWindow = (TimeWindow) obj;

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

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getStartField

public String getStartField()
                     throws IOException,
                            AutomationException
The start field.

Product Availability

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

Specified by:
getStartField in interface ITimeWindow
Returns:
The pField
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStartField

public void setStartField(String pField)
                   throws IOException,
                          AutomationException
The start field.

Product Availability

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

Specified by:
setStartField in interface ITimeWindow
Parameters:
pField - The pField (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEndField

public String getEndField()
                   throws IOException,
                          AutomationException
The end field.

Product Availability

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

Specified by:
getEndField in interface ITimeWindow
Returns:
The pField
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEndField

public void setEndField(String pField)
                 throws IOException,
                        AutomationException
The end field.

Product Availability

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

Specified by:
setEndField in interface ITimeWindow
Parameters:
pField - The pField (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStartFieldFormat

public String getStartFieldFormat()
                           throws IOException,
                                  AutomationException
The start field format.

Product Availability

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

Specified by:
getStartFieldFormat in interface ITimeWindow
Returns:
The pField
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStartFieldFormat

public void setStartFieldFormat(String pField)
                         throws IOException,
                                AutomationException
The start field format.

Product Availability

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

Specified by:
setStartFieldFormat in interface ITimeWindow
Parameters:
pField - The pField (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEndFieldFormat

public String getEndFieldFormat()
                         throws IOException,
                                AutomationException
The end field format.

Product Availability

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

Specified by:
getEndFieldFormat in interface ITimeWindow
Returns:
The pFieldFormat
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEndFieldFormat

public void setEndFieldFormat(String pFieldFormat)
                       throws IOException,
                              AutomationException
The end field format.

Product Availability

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

Specified by:
setEndFieldFormat in interface ITimeWindow
Parameters:
pFieldFormat - The pFieldFormat (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAnimateCumulatively

public boolean isAnimateCumulatively()
                              throws IOException,
                                     AutomationException
Indicates whether to animate the display cumulatively.

Product Availability

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

Specified by:
isAnimateCumulatively in interface ITimeWindow
Returns:
The pAnimateFieldsCumulatively
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAnimateCumulatively

public void setAnimateCumulatively(boolean pAnimateFieldsCumulatively)
                            throws IOException,
                                   AutomationException
Indicates whether to animate the display cumulatively.

Product Availability

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

Specified by:
setAnimateCumulatively in interface ITimeWindow
Parameters:
pAnimateFieldsCumulatively - The pAnimateFieldsCumulatively (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefinitionQuery

public String getDefinitionQuery()
                          throws IOException,
                                 AutomationException
The definition query.

Remarks

This property stores the pre-existing definition query of a time layer before time animation is played.

Product Availability

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

Specified by:
getDefinitionQuery in interface ITimeWindow
Returns:
The pQuery
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefinitionQuery

public void setDefinitionQuery(String pQuery)
                        throws IOException,
                               AutomationException
The definition query.

Product Availability

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

Specified by:
setDefinitionQuery in interface ITimeWindow
Parameters:
pQuery - The pQuery (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException
isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDirty in interface IPersistStream
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException
load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

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

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

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

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException
Clones the receiver and assigns the result to *clone.

Product Availability

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

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

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException
Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
assign in interface IClone
Parameters:
src - A reference to a com.esri.arcgis.system.IClone (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException
Returns TRUE when the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isEqual in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The equal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException
Returns TRUE when the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isIdentical in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The identical
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Throws:
IOException
ClassNotFoundException