com.esri.arcgis.system
Class TimeExtent

java.lang.Object
  com.esri.arcgis.system.TimeExtent

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IClone, IDocumentVersionSupportGEN, IPersist, IPersistStream, ITimeExtent, ITimeOffsetOperator, ITimeRelationalOperator, ITimeValue, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class TimeExtent
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ITimeExtent, ITimeValue, ITimeRelationalOperator, ITimeOffsetOperator, IXMLSerialize, IXMLVersionSupport, IClone, IPersistStream, IDocumentVersionSupportGEN, Externalizable

An object that represents a time-referenced time extent.

Description

A Time Extent has a specific start time and an end time. It represents a specific portion of the time line.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

TimeExtent()
Constructs a TimeExtent using ArcGIS Engine.

TimeExtent(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TimeExtent theTimeExtent = (TimeExtent) 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.
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(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 String	getClsid() getClsid.
ITime	getEndTime() The time extent's end time.
String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ITime	getStartTime() The time extent's start time.
ITimeReference	getTimeReference() The time reference associated with the time value.
int	hashCode() the hashcode for this object
void	intersect(ITimeValue otherTimeValue) Adjust to intersect with the input time value.
void	isDirty() isDirty
boolean	isEmpty() Indicates whether the time extent is empty.
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.
ITimeDuration	queryTimeDuration() Obtains the time extent's time duration.
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setEmpty(boolean empty) Indicates whether the time extent is empty.
void	setEndTime(ITime endTime) The time extent's end time.
void	setExtent(ITime startTime, ITime endTime) Writes start and end time, with copies of the input time values.
void	setStartTime(ITime startTime) The time extent's start time.
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.
void	union(ITimeValue otherTimeValue) Adjust to ovelap the input time value.
boolean	within(ITimeValue otherTimeValue) Indicates whether this time value is contained (is within) the other time value.
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

TimeExtent

public TimeExtent()
           throws IOException,
                  UnknownHostException

Constructs a TimeExtent using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

TimeExtent

public TimeExtent(Object obj)
           throws IOException

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

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

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

getStartTime

public ITime getStartTime()
                   throws IOException,
                          AutomationException

The time extent's start time.

Product Availability

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

Specified by:

getStartTime in interface ITimeExtent

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartTime

public void setStartTime(ITime startTime)
                  throws IOException,
                         AutomationException

The time extent's start time.

Description

The StartTime passed into this function must be before or equal to the current value of the EndTime property. To avoid problems, it is preferable to use the SetExtent method when setting both the start time and end time.

Product Availability

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

Specified by:

setStartTime in interface ITimeExtent

Parameters:

startTime - A reference to a com.esri.arcgis.system.ITime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEndTime

public ITime getEndTime()
                 throws IOException,
                        AutomationException

The time extent's end time.

Product Availability

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

Specified by:

getEndTime in interface ITimeExtent

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEndTime

public void setEndTime(ITime endTime)
                throws IOException,
                       AutomationException

The time extent's end time.

Description

The passed value for EndTime must be after or equal to the current value of the StartTime property. To avoid problems, it is preferable to use the SetExtent method when setting both the start time and end time.

Product Availability

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

Specified by:

setEndTime in interface ITimeExtent

Parameters:

endTime - A reference to a com.esri.arcgis.system.ITime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEmpty

public boolean isEmpty()
                throws IOException,
                       AutomationException

Indicates whether the time extent is empty.

Product Availability

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

Specified by:

isEmpty in interface ITimeExtent

Returns:

The empty

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEmpty

public void setEmpty(boolean empty)
              throws IOException,
                     AutomationException

Indicates whether the time extent is empty.

Product Availability

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

Specified by:

setEmpty in interface ITimeExtent

Parameters:

empty - The empty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtent

public void setExtent(ITime startTime,
                      ITime endTime)
               throws IOException,
                      AutomationException

Writes start and end time, with copies of the input time values.

Description

This function sets both the Start Time and End Time as one atomic action.

Product Availability

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

Specified by:

setExtent in interface ITimeExtent

Parameters:

startTime - A reference to a com.esri.arcgis.system.ITime (in)

endTime - A reference to a com.esri.arcgis.system.ITime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryTimeDuration

public ITimeDuration queryTimeDuration()
                                throws IOException,
                                       AutomationException

Obtains the time extent's time duration.

Product Availability

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

Specified by:

queryTimeDuration in interface ITimeExtent

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

union

public void union(ITimeValue otherTimeValue)
           throws IOException,
                  AutomationException

Adjust to ovelap the input time value.

Description

This method expands the current TimeExtent to include its previous extent and the extent of the passed TimeExtent. The result is continuous, so any gap between the previous extent and the passed extent is included in the new extent.

Product Availability

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

Specified by:

union in interface ITimeExtent

Parameters:

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

intersect

public void intersect(ITimeValue otherTimeValue)
               throws IOException,
                      AutomationException

Adjust to intersect with the input time value.

Description

The current extent is adjusted to include the time period (if any) where the original value intersects with the passed TimeExtent value.

Product Availability

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

Specified by:

intersect in interface ITimeExtent

Parameters:

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

getTimeReference

public ITimeReference getTimeReference()
                                throws IOException,
                                       AutomationException

The time reference associated with the time value.

Product Availability

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

Specified by:

getTimeReference in interface ITimeValue

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.

setTimeReferenceByRef

public void setTimeReferenceByRef(ITimeReference timeReference)
                           throws IOException,
                                  AutomationException

The time reference associated with the time value.

Product Availability

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

Specified by:

setTimeReferenceByRef in interface ITimeValue

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.

project

public void project(ITimeReference timeReference)
             throws IOException,
                    AutomationException

Projects this time value from its time reference, to a given time reference.

Description

This function modifies the underlying time value in addition to changing the value of the temporal reference. For example, if you have a time value whose time reference is in Pacific Time Zone, and is currently 6:00 AM. The equivalent time in Eastern Time Zone is 9:00 AM. Calling the Project method, and passing in a reference to the Eastern time zone will change the time reference to the Eastern Time Zone, and also change the value to 9:00 AM.

Product Availability

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

Specified by:

project in interface ITimeValue

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.

projectToUTC

public void projectToUTC()
                  throws IOException,
                         AutomationException

Projects this time value from its time reference, to UTC.

Product Availability

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

Specified by:

projectToUTC in interface ITimeValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

projectFromUTC

public void projectFromUTC()
                    throws IOException,
                           AutomationException

Projects this time value from UTC, to its time reference.

Product Availability

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

Specified by:

projectFromUTC in interface ITimeValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_equals

public boolean esri_equals(ITimeValue otherTimeValue)
                    throws IOException,
                           AutomationException

Indicates whether the two time values are of the same type and define the same time values.

Product Availability

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

Specified by:

esri_equals in interface ITimeRelationalOperator

Parameters:

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

Returns:

The esri_equals

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

disjoint

public boolean disjoint(ITimeValue otherTimeValue)
                 throws IOException,
                        AutomationException

Indicates whether the input time value falls fully outside of the time extent.

Description

This is the opposite of the Touches operation. It can be used to find out if there is a non-zero amount of time between the input time and the current time extent.

Product Availability

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

Specified by:

disjoint in interface ITimeRelationalOperator

Parameters:

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

Returns:

The disjoint

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

touches

public boolean touches(ITimeValue otherTimeValue)
                throws IOException,
                       AutomationException

Indicates whether the boundaries of the time values intersect.

Description

This function results in a TRUE value if there exists a Time instant that is contained by both of the TimeExtents. for example if the time extents are 1:00-2:00 and 2:00-3:00, then there is exactly one moment in time (2:00) that is in both TimeExtents.

Product Availability

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

Specified by:

touches in interface ITimeRelationalOperator

Parameters:

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

Returns:

The touches

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

within

public boolean within(ITimeValue otherTimeValue)
               throws IOException,
                      AutomationException

Indicates whether this time value is contained (is within) the other time value.

Description

This function can be used to find out if the current time is contained fully within the time extent passed in. The start times can be equal or the end times can be equal and the function will still be TRUE.

Product Availability

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

Specified by:

within in interface ITimeRelationalOperator

Parameters:

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

Returns:

The within

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

contains

public boolean contains(ITimeValue otherTimeValue)
                 throws IOException,
                        AutomationException

Indicates whether this time value contains the other time value.

Description

This function returns true if the passed Time value is contained fully within the current time extent. The start times can be equal, or the end times can be equal and the function will still result in TRUE.

Product Availability

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

Specified by:

contains in interface ITimeRelationalOperator

Parameters:

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

Returns:

The contains

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addDuration

public void addDuration(ITimeDuration timeDuration)
                 throws IOException,
                        AutomationException

Adds a time duration.

Product Availability

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

Specified by:

addDuration in interface ITimeOffsetOperator

Parameters:

timeDuration - A reference to a com.esri.arcgis.system.ITimeDuration (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

subtractDuration

public void subtractDuration(ITimeDuration timeDuration)
                      throws IOException,
                             AutomationException

Subtracts a time duration.

Product Availability

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

Specified by:

subtractDuration in interface ITimeOffsetOperator

Parameters:

timeDuration - A reference to a com.esri.arcgis.system.ITimeDuration (in)

Throws:

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 IOException,
                        AutomationException

Adds the input amount of years.

Product Availability

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

Specified by:

addYears in interface ITimeOffsetOperator

Parameters:

value - The value (in)

preserveEndOfMonth - The preserveEndOfMonth (in)

goForwardOnInvalidDate - The goForwardOnInvalidDate (in)

Returns:

The dateWasAdjusted

Throws:

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 IOException,
                         AutomationException

Adds the input amount of months.

Product Availability

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

Specified by:

addMonths in interface ITimeOffsetOperator

Parameters:

value - The value (in)

preserveEndOfMonth - The preserveEndOfMonth (in)

goForwardOnInvalidDate - The goForwardOnInvalidDate (in)

Returns:

The dateWasAdjusted

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addWeeks

public void addWeeks(double value)
              throws IOException,
                     AutomationException

Adds the input amount of weeks.

Product Availability

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

Specified by:

addWeeks in interface ITimeOffsetOperator

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addDays

public void addDays(double value)
             throws IOException,
                    AutomationException

Adds the input amount of days.

Product Availability

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

Specified by:

addDays in interface ITimeOffsetOperator

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addHours

public void addHours(double value)
              throws IOException,
                     AutomationException

Adds the input amount of hours.

Product Availability

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

Specified by:

addHours in interface ITimeOffsetOperator

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addMinutes

public void addMinutes(double value)
                throws IOException,
                       AutomationException

Adds the input amount of minutes.

Product Availability

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

Specified by:

addMinutes in interface ITimeOffsetOperator

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addSeconds

public void addSeconds(double value)
                throws IOException,
                       AutomationException

Adds the input amount of seconds.

Product Availability

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

Specified by:

addSeconds in interface ITimeOffsetOperator

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addMilliseconds

public void addMilliseconds(double value)
                     throws IOException,
                            AutomationException

Adds the input amount of milliseconds.

Product Availability

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

Specified by:

addMilliseconds in interface ITimeOffsetOperator

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addNanoseconds

public void addNanoseconds(long value)
                    throws IOException,
                           AutomationException

Adds the input amount of nanoseconds.

Product Availability

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

Specified by:

addNanoseconds in interface ITimeOffsetOperator

Parameters:

value - Signed 64-bit int (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public String getMinNamespaceSupported()
                                throws IOException,
                                       AutomationException

The minimum namespace the class can serialize to (eg the 90 namespace).

Product Availability

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

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

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

Indicates if 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

Indicates if 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.

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.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws 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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public Object convertToSupportedObject(int docVersion)
                                throws 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:

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