com.esri.arcgis.system
Class ScaleFormat

java.lang.Object
  extended by com.esri.arcgis.system.ScaleFormat
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, IClone, IDocumentVersionSupportGEN, IPersist, IPersistStream, IScaleFormat, Externalizable, Serializable

public class ScaleFormat
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IScaleFormat, IPersistStream, IPersist, IClone, IDocumentVersionSupportGEN, Externalizable

A utility object for formatting scale.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
ScaleFormat()
          Constructs a ScaleFormat using ArcGIS Engine.
ScaleFormat(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ScaleFormat theScaleFormat = (ScaleFormat) obj;
 
Method Summary
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 double calcMapUnitValue(double absoluteScale)
          Calculate the number of map units corresponding to the specified page units at the given absolute scale.
 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.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 String getCustomFormat()
          A string defining the scale format.
 String getEquals()
          The text used for 'equals', i.e., ' = ' in 1 inch = 5 miles.
 int getFormat()
          Format used to display scale, i.e., 1:20000 or 1 inch equals 5 miles.
 int getMapUnits()
          The map units used to display a scale, i.e., the 'miles' in 1 inch = 5 miles.
 INumberFormat getNumberFormat()
          Format used to display scale value, i.e., 20,000.
 int getPageUnits()
          The page units used to display a scale, i.e., the 'inch' in 1 inch = 5 miles.
 double getPageUnitValue()
          The number preceding the page units in a scale, i.e., the '1' in 1 inch = 5 miles.
 String getSeparator()
          Character(s) used to separate '1' from the scale in an absolute scale, i.e., the ':' in 1:20000.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int hashCode()
          the hashcode for this object
 boolean isAbbreviateUnits()
          Abbreviate the units in the scale string.
 boolean isCapitolizeUnits()
          Capitolize the units in the scale string.
 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.
 boolean isReverseOrder()
          Reverse the standard order [1:1000] becomes [1000:1] and [1 in = 10 mi] becomes [10 mi = 1 in].
 boolean isSupportedAtVersion(int docVersion)
          Is this object valid at the given document version.
 void load(IStream pstm)
          load
 void loadFromRegistry()
          Set the scale format to the system default.
 void readExternal(ObjectInput in)
           
 void save(IStream pstm, int fClearDirty)
          save
 void saveToRegistry()
          Store the scale format as the system default.
 String scaleToString(double scale)
          Convert the absolute scale to a string using the current IScaleFormat attributes.
 void setAbbreviateUnits(boolean flag)
          Abbreviate the units in the scale string.
 void setCapitolizeUnits(boolean flag)
          Capitolize the units in the scale string.
 void setCustomFormat(String format)
          A string defining the scale format.
 void setEquals(String text)
          The text used for 'equals', i.e., ' = ' in 1 inch = 5 miles.
 void setFormat(int format)
          Format used to display scale, i.e., 1:20000 or 1 inch equals 5 miles.
 void setMapUnits(int units)
          The map units used to display a scale, i.e., the 'miles' in 1 inch = 5 miles.
 void setNumberFormat(INumberFormat format)
          Format used to display scale value, i.e., 20,000.
 void setPageUnits(int units)
          The page units used to display a scale, i.e., the 'inch' in 1 inch = 5 miles.
 void setPageUnitValue(double value)
          The number preceding the page units in a scale, i.e., the '1' in 1 inch = 5 miles.
 void setReverseOrder(boolean flag)
          Reverse the standard order [1:1000] becomes [1000:1] and [1 in = 10 mi] becomes [10 mi = 1 in].
 void setSeparator(String separator)
          Character(s) used to separate '1' from the scale in an absolute scale, i.e., the ':' in 1:20000.
 double stringToScale(String scaleStr)
          Convert the string to an absolute scale using the current IScaleFormat attributes.
 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

ScaleFormat

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

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

ScaleFormat

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

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

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

setFormat

public void setFormat(int format)
               throws IOException,
                      AutomationException
Format used to display scale, i.e., 1:20000 or 1 inch equals 5 miles.

Product Availability

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

Specified by:
setFormat in interface IScaleFormat
Parameters:
format - A com.esri.arcgis.system.esriScaleFormat constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFormat

public int getFormat()
              throws IOException,
                     AutomationException
Format used to display scale, i.e., 1:20000 or 1 inch equals 5 miles.

Product Availability

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

Specified by:
getFormat in interface IScaleFormat
Returns:
A com.esri.arcgis.system.esriScaleFormat constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNumberFormat

public void setNumberFormat(INumberFormat format)
                     throws IOException,
                            AutomationException
Format used to display scale value, i.e., 20,000.

Product Availability

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

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

getNumberFormat

public INumberFormat getNumberFormat()
                              throws IOException,
                                     AutomationException
Format used to display scale value, i.e., 20,000.

Product Availability

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

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

setSeparator

public void setSeparator(String separator)
                  throws IOException,
                         AutomationException
Character(s) used to separate '1' from the scale in an absolute scale, i.e., the ':' in 1:20000.

Product Availability

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

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

getSeparator

public String getSeparator()
                    throws IOException,
                           AutomationException
Character(s) used to separate '1' from the scale in an absolute scale, i.e., the ':' in 1:20000.

Product Availability

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

Specified by:
getSeparator in interface IScaleFormat
Returns:
The separator
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPageUnitValue

public void setPageUnitValue(double value)
                      throws IOException,
                             AutomationException
The number preceding the page units in a scale, i.e., the '1' in 1 inch = 5 miles.

Product Availability

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

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

getPageUnitValue

public double getPageUnitValue()
                        throws IOException,
                               AutomationException
The number preceding the page units in a scale, i.e., the '1' in 1 inch = 5 miles.

Product Availability

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

Specified by:
getPageUnitValue in interface IScaleFormat
Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPageUnits

public void setPageUnits(int units)
                  throws IOException,
                         AutomationException
The page units used to display a scale, i.e., the 'inch' in 1 inch = 5 miles.

Product Availability

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

Specified by:
setPageUnits in interface IScaleFormat
Parameters:
units - A com.esri.arcgis.system.esriUnits constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPageUnits

public int getPageUnits()
                 throws IOException,
                        AutomationException
The page units used to display a scale, i.e., the 'inch' in 1 inch = 5 miles.

Product Availability

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

Specified by:
getPageUnits in interface IScaleFormat
Returns:
A com.esri.arcgis.system.esriUnits constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEquals

public void setEquals(String text)
               throws IOException,
                      AutomationException
The text used for 'equals', i.e., ' = ' in 1 inch = 5 miles.

Product Availability

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

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

getEquals

public String getEquals()
                 throws IOException,
                        AutomationException
The text used for 'equals', i.e., ' = ' in 1 inch = 5 miles.

Product Availability

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

Specified by:
getEquals in interface IScaleFormat
Returns:
The text
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMapUnits

public void setMapUnits(int units)
                 throws IOException,
                        AutomationException
The map units used to display a scale, i.e., the 'miles' in 1 inch = 5 miles.

Product Availability

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

Specified by:
setMapUnits in interface IScaleFormat
Parameters:
units - A com.esri.arcgis.system.esriUnits constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMapUnits

public int getMapUnits()
                throws IOException,
                       AutomationException
The map units used to display a scale, i.e., the 'miles' in 1 inch = 5 miles.

Product Availability

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

Specified by:
getMapUnits in interface IScaleFormat
Returns:
A com.esri.arcgis.system.esriUnits constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCapitolizeUnits

public void setCapitolizeUnits(boolean flag)
                        throws IOException,
                               AutomationException
Capitolize the units in the scale string.

Product Availability

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

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

isCapitolizeUnits

public boolean isCapitolizeUnits()
                          throws IOException,
                                 AutomationException
Capitolize the units in the scale string.

Product Availability

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

Specified by:
isCapitolizeUnits in interface IScaleFormat
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAbbreviateUnits

public void setAbbreviateUnits(boolean flag)
                        throws IOException,
                               AutomationException
Abbreviate the units in the scale string.

Product Availability

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

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

isAbbreviateUnits

public boolean isAbbreviateUnits()
                          throws IOException,
                                 AutomationException
Abbreviate the units in the scale string.

Product Availability

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

Specified by:
isAbbreviateUnits in interface IScaleFormat
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReverseOrder

public void setReverseOrder(boolean flag)
                     throws IOException,
                            AutomationException
Reverse the standard order [1:1000] becomes [1000:1] and [1 in = 10 mi] becomes [10 mi = 1 in].

Product Availability

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

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

isReverseOrder

public boolean isReverseOrder()
                       throws IOException,
                              AutomationException
Reverse the standard order [1:1000] becomes [1000:1] and [1 in = 10 mi] becomes [10 mi = 1 in].

Product Availability

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

Specified by:
isReverseOrder in interface IScaleFormat
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCustomFormat

public void setCustomFormat(String format)
                     throws IOException,
                            AutomationException
A string defining the scale format. Embed XML tokens where scale values should go, i.e., . Possible attributes: Scale, Separator, PageUnitValue, PageUnits, EqualsText, MapUnits.

Product Availability

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

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

getCustomFormat

public String getCustomFormat()
                       throws IOException,
                              AutomationException
A string defining the scale format. Embed XML tokens where scale values should go, i.e., . Possible attributes: Scale, Separator, PageUnitValue, PageUnits, EqualsText, MapUnits.

Product Availability

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

Specified by:
getCustomFormat in interface IScaleFormat
Returns:
The format
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

calcMapUnitValue

public double calcMapUnitValue(double absoluteScale)
                        throws IOException,
                               AutomationException
Calculate the number of map units corresponding to the specified page units at the given absolute scale.

Product Availability

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

Specified by:
calcMapUnitValue in interface IScaleFormat
Parameters:
absoluteScale - The absoluteScale (in)
Returns:
The mapUnitValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

scaleToString

public String scaleToString(double scale)
                     throws IOException,
                            AutomationException
Convert the absolute scale to a string using the current IScaleFormat attributes.

Product Availability

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

Specified by:
scaleToString in interface IScaleFormat
Parameters:
scale - The scale (in)
Returns:
The scaleStr
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

stringToScale

public double stringToScale(String scaleStr)
                     throws IOException,
                            AutomationException
Convert the string to an absolute scale using the current IScaleFormat attributes.

Product Availability

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

Specified by:
stringToScale in interface IScaleFormat
Parameters:
scaleStr - The scaleStr (in)
Returns:
The scale
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

saveToRegistry

public void saveToRegistry()
                    throws IOException,
                           AutomationException
Store the scale format as the system default.

Product Availability

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

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

loadFromRegistry

public void loadFromRegistry()
                      throws IOException,
                             AutomationException
Set the scale format to the system default.

Product Availability

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

Specified by:
loadFromRegistry in interface IScaleFormat
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.

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