com.esri.arcgis.trackinganalyst
Class TemporalLegendGroup

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

All Implemented Interfaces:

ILegendGroup, com.esri.arcgis.interop.RemoteObjRef, IClone, IDocumentVersionSupportGEN, IPersist, IPersistStream, ISupportErrorInfo, ITemporalLegendGroup, ITemporalLegendGroup2, Externalizable, Serializable

public class TemporalLegendGroup
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ITemporalLegendGroup, ITemporalLegendGroup2, ILegendGroup, IPersistStream, IPersist, IClone, ISupportErrorInfo, IDocumentVersionSupportGEN, Externalizable

Contains group of two or more temporal legend classes.

Description

This object stores and manages a group of temporal legend classes.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

See Also:

Serialized Form

Constructor Summary

TemporalLegendGroup()
Constructs a TemporalLegendGroup using ArcGIS Engine.

TemporalLegendGroup(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TemporalLegendGroup theTemporalLegendGroup = (TemporalLegendGroup) obj;

Method Summary

void	addClass(ILegendClass legendClass) Adds a new legend class to the group at the end of list.
void	assign(IClone src) Assigns the properties of src to the receiver.
void	clearClasses() Removes all classes from the group.
Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
boolean	equals(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
ILegendClass	esri_getClass(int index) Legend class at the specified index.
int	getClassCount() Number of legend classes in the group.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
String	getColorRampName() Esri pre-defined color ramp last used by the temporal renderer property page to update this object; this value is used to create default temporal legend class symbology colors.
String	getDescription() Text description of the temporal legend group.
String	getHeading() String heading.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ITemporalLegendClass	getTemporalLegendClass(int nRangeNdx) Temporal Legend Class at specified index from this group.
String	getUID() A unique ID to represent the type of legend group.
int	hashCode() the hashcode for this object
void	insertClass(int index, ILegendClass legendClass) Inserts a new legend class into the group at the specified index.
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
int	intersects(Object pvTimeValue, ISymbol[] ppiSymbol, IColor[] ppiSymbolColor, double[] pdSymbolSize) Determines whether a given timestamp value is contained within one of the group's temporal classes.
void	isDirty() isDirty
boolean	isEditable() Indicates if the group can be edited.
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.
boolean	isSuppress() Controls whether or not to use the temporal legend classes during intersect or time period computation for a temporal query.
boolean	isUseGradient() Create a smooth gradient using the symbols in the first two classes.
boolean	isVisible() Indicates if the group is displayed.
void	load(IStream pstm) load
void	moveClass(int nCurrentIndex, int nDestinationIndex) Moves a temporal legend class from its current position to a new destination within the temporal legend group's legend class container.
void	readExternal(ObjectInput in)
void	removeClass(int index) Removes the legend class from the group at the specified index.
void	save(IStream pstm, int fClearDirty) save
void	setColorRampName(String pbstrColorRampName) Esri pre-defined color ramp last used by the temporal renderer property page to update this object; this value is used to create default temporal legend class symbology colors.
void	setDescription(String pbstrDescription) Text description of the temporal legend group.
void	setEditable(boolean editable) Indicates if the group can be edited.
void	setHeading(String heading) String heading.
void	setReference(Object varReference) Sets temporal reference information for the temporal legend group.
void	setSuppress(boolean pbSuppress) Controls whether or not to use the temporal legend classes during intersect or time period computation for a temporal query.
void	setUID(String uID) A unique ID to represent the type of legend group.
void	setUseGradient(boolean useGradient) Create a smooth gradient using the symbols in the first two classes.
void	setVisible(boolean visible) Indicates if the group is displayed.
void	update() Updates the temporal legend with new values.
void	verify(boolean[] bNoProblems) Checks ranges within a group to determine if group is ordered properly and has correct offsets.
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

TemporalLegendGroup

public TemporalLegendGroup()
                    throws IOException,
                           UnknownHostException

Constructs a TemporalLegendGroup using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

TemporalLegendGroup

public TemporalLegendGroup(Object obj)
                    throws IOException

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

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

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

isVisible

public boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates if the group is displayed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

isVisible in interface ILegendGroup

Specified by:

isVisible in interface ITemporalLegendGroup

Returns:

The visible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean visible)
                throws IOException,
                       AutomationException

Indicates if the group is displayed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

setVisible in interface ILegendGroup

Specified by:

setVisible in interface ITemporalLegendGroup

Parameters:

visible - The visible (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEditable

public boolean isEditable()
                   throws IOException,
                          AutomationException

Indicates if the group can be edited. Default is editable.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

isEditable in interface ILegendGroup

Specified by:

isEditable in interface ITemporalLegendGroup

Returns:

The editable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEditable

public void setEditable(boolean editable)
                 throws IOException,
                        AutomationException

Indicates if the group can be edited. Default is editable.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

setEditable in interface ILegendGroup

Specified by:

setEditable in interface ITemporalLegendGroup

Parameters:

editable - The editable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHeading

public String getHeading()
                  throws IOException,
                         AutomationException

String heading.

Description

The property indicates the string heading for the legend group.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getHeading in interface ILegendGroup

Specified by:

getHeading in interface ITemporalLegendGroup

Returns:

The heading

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHeading

public void setHeading(String heading)
                throws IOException,
                       AutomationException

String heading.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

setHeading in interface ILegendGroup

Specified by:

setHeading in interface ITemporalLegendGroup

Parameters:

heading - The heading (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassCount

public int getClassCount()
                  throws IOException,
                         AutomationException

Number of legend classes in the group.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getClassCount in interface ILegendGroup

Specified by:

getClassCount in interface ITemporalLegendGroup

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_getClass

public ILegendClass esri_getClass(int index)
                           throws IOException,
                                  AutomationException

Legend class at the specified index.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

esri_getClass in interface ILegendGroup

Specified by:

esri_getClass in interface ITemporalLegendGroup

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.carto.ILegendClass

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addClass

public void addClass(ILegendClass legendClass)
              throws IOException,
                     AutomationException

Adds a new legend class to the group at the end of list.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

addClass in interface ILegendGroup

Specified by:

addClass in interface ITemporalLegendGroup

Parameters:

legendClass - A reference to a com.esri.arcgis.carto.ILegendClass (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insertClass

public void insertClass(int index,
                        ILegendClass legendClass)
                 throws IOException,
                        AutomationException

Inserts a new legend class into the group at the specified index.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

insertClass in interface ILegendGroup

Specified by:

insertClass in interface ITemporalLegendGroup

Parameters:

index - The index (in)

legendClass - A reference to a com.esri.arcgis.carto.ILegendClass (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeClass

public void removeClass(int index)
                 throws IOException,
                        AutomationException

Removes the legend class from the group at the specified index.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

removeClass in interface ILegendGroup

Specified by:

removeClass in interface ITemporalLegendGroup

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearClasses

public void clearClasses()
                  throws IOException,
                         AutomationException

Removes all classes from the group.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

clearClasses in interface ILegendGroup

Specified by:

clearClasses in interface ITemporalLegendGroup

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColorRampName

public String getColorRampName()
                        throws IOException,
                               AutomationException

Esri pre-defined color ramp last used by the temporal renderer property page to update this object; this value is used to create default temporal legend class symbology colors.

Description

The Color Ramp Name property is the name of an ESRI pre-defined color ramp that was last used by the TemporalRenderer property page that updated this object. This value is used to create default temporal legend class symbology colors. This property is the name of an ESRI color ramp obtained from ESRI's pre-defined color ramps. The Temporal Renderer's property page uses this property to obtain the color ramp in order to build default temporal legend classes and symbology for the legend classes' symbols.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getColorRampName in interface ITemporalLegendGroup

Returns:

The pbstrColorRampName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColorRampName

public void setColorRampName(String pbstrColorRampName)
                      throws IOException,
                             AutomationException

Esri pre-defined color ramp last used by the temporal renderer property page to update this object; this value is used to create default temporal legend class symbology colors.

Description

The Color Ramp Name property is the name of an ESRI pre-defined color ramp that was last used by the TemporalRenderer property page that updated this object. This value is used to create default temporal legend class symbology colors. This property is the name of an ESRI color ramp obtained from ESRI's pre-defined color ramps. The Temporal Renderer's property page uses this property to obtain the color ramp in order to build default temporal legend classes and symbology for the legend classes' symbols.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

setColorRampName in interface ITemporalLegendGroup

Parameters:

pbstrColorRampName - The pbstrColorRampName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException

Text description of the temporal legend group.

Description

The Description property contains a description of this Temporal Group. This is the same property as Heading from ILegendGroup.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getDescription in interface ITemporalLegendGroup

Returns:

The pbstrDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(String pbstrDescription)
                    throws IOException,
                           AutomationException

Text description of the temporal legend group.

Description

The Description property contains a description of this Temporal Group. This is the same property as Heading from ILegendGroup.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

setDescription in interface ITemporalLegendGroup

Parameters:

pbstrDescription - The pbstrDescription (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemporalLegendClass

public ITemporalLegendClass getTemporalLegendClass(int nRangeNdx)
                                            throws IOException,
                                                   AutomationException

Temporal Legend Class at specified index from this group.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getTemporalLegendClass in interface ITemporalLegendGroup

Parameters:

nRangeNdx - The nRangeNdx (in)

Returns:

A reference to a com.esri.arcgis.trackinganalyst.ITemporalLegendClass

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSuppress

public boolean isSuppress()
                   throws IOException,
                          AutomationException

Controls whether or not to use the temporal legend classes during intersect or time period computation for a temporal query.

Description

The Suppress property controls whether or not to use the temporal legend classes during intersect or computation of the time period needed for a temporal query.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

isSuppress in interface ITemporalLegendGroup

Returns:

The pbSuppress

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSuppress

public void setSuppress(boolean pbSuppress)
                 throws IOException,
                        AutomationException

Controls whether or not to use the temporal legend classes during intersect or time period computation for a temporal query.

Description

The Suppress property controls whether or not to use the temporal legend classes during intersect or computation of the time period needed for a temporal query.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

setSuppress in interface ITemporalLegendGroup

Parameters:

pbSuppress - The pbSuppress (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReference

public void setReference(Object varReference)
                  throws IOException,
                         AutomationException

Sets temporal reference information for the temporal legend group.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

setReference in interface ITemporalLegendGroup

Parameters:

varReference - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

intersects

public int intersects(Object pvTimeValue,
                      ISymbol[] ppiSymbol,
                      IColor[] ppiSymbolColor,
                      double[] pdSymbolSize)
               throws IOException,
                      AutomationException

Determines whether a given timestamp value is contained within one of the group's temporal classes.

Description

This method determines if a given absolute time, timestamp, is contained within one of this class's temporal legend classes. If so it returns the index of
the legend class that should be used, and it returns the associated symbol for that temporal legend class.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

intersects in interface ITemporalLegendGroup

Parameters:

pvTimeValue - A Variant (in)

ppiSymbol - A reference to a com.esri.arcgis.display.ISymbol (in/out: use single element array)

ppiSymbolColor - A reference to a com.esri.arcgis.display.IColor (in/out: use single element array)

pdSymbolSize - The pdSymbolSize (in/out: use single element array)

Returns:

The pnUseSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

update

public void update()
            throws IOException,
                   AutomationException

Updates the temporal legend with new values.

Description

The Update method updates the legend. Each temporal range in this legend calls this method to have the temporal legend update the ranges in order to maintain a sorted range list from future to past/normal and compute the correct offsets.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

update in interface ITemporalLegendGroup

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

moveClass

public void moveClass(int nCurrentIndex,
                      int nDestinationIndex)
               throws IOException,
                      AutomationException

Moves a temporal legend class from its current position to a new destination within the temporal legend group's legend class container.

Description

The move Class method moves a Temporal Legend Class from the current position to the destination position within the Temporal Legend Groups Legend Class container.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

moveClass in interface ITemporalLegendGroup

Parameters:

nCurrentIndex - The nCurrentIndex (in)

nDestinationIndex - The nDestinationIndex (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

verify

public void verify(boolean[] bNoProblems)
            throws IOException,
                   AutomationException

Checks ranges within a group to determine if group is ordered properly and has correct offsets.

Description

The verify method checks the ranges within a group to determine if the group is ordered properly and has correct offsets. It does not fix any detected problems; it only returns a boolean result.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

verify in interface ITemporalLegendGroup

Parameters:

bNoProblems - The bNoProblems (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseGradient

public boolean isUseGradient()
                      throws IOException,
                             AutomationException

Create a smooth gradient using the symbols in the first two classes.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

isUseGradient in interface ITemporalLegendGroup2

Returns:

The useGradient

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseGradient

public void setUseGradient(boolean useGradient)
                    throws IOException,
                           AutomationException

Create a smooth gradient using the symbols in the first two classes.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

setUseGradient in interface ITemporalLegendGroup2

Parameters:

useGradient - The useGradient (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUID

public String getUID()
              throws IOException,
                     AutomationException

A unique ID to represent the type of legend group.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getUID in interface ITemporalLegendGroup2

Returns:

The uID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUID

public void setUID(String uID)
            throws IOException,
                   AutomationException

A unique ID to represent the type of legend group.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

setUID in interface ITemporalLegendGroup2

Parameters:

uID - The uID (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

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.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

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

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