com.esri.arcgis.controls
Class ARUnitConverter

java.lang.Object
  extended by com.esri.arcgis.controls.ARUnitConverter
All Implemented Interfaces:
IARUnitConverter, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ARUnitConverter
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IARUnitConverter

ARUnitConverter object.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

See Also:
Serialized Form

Constructor Summary
ARUnitConverter(Object obj)
          Construct a ARUnitConverter using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 double convertUnits(double dValue, int inUnits, int outUnits)
          Converts the specified value between two units of measure.
 String doubleAsString(double dValue, int nDigits, boolean bSeparators)
          Converts the specified value to a string rounded to a specified number of decimal places.
 boolean equals(Object o)
          Compare this object with another
 String esriUnitsAsAbbreviatedString(int units, int caseAppearance)
          Converts the specified units to a string abbreviation in upper or lower case.
 String esriUnitsAsString(int units, int caseAppearance, boolean bPlural)
          Converts the specified units to strings in upper or lower case.
 void getLocationAsString(IARMap pMap, double xCoord, double yCoord, int displayUnits, String[] sXLocation, String[] sYLocation, String[] sUnits)
          Converts the specified coordinates and units to strings.
 void getLongLatAsString(double longitude, double latitude, int displayUnits, String[] sLongitude, String[] sLatitude, String[] sUnits)
          Converts the specified degree coordinates and units to strings.
 int hashCode()
          the hashcode for this object
 
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

ARUnitConverter

public ARUnitConverter(Object obj)
                throws IOException
Construct a ARUnitConverter using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ARUnitConverter.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
ARUnitConverter o = (ARUnitConverter)obj; // will not work

ARUnitConverter o = new ARUnitConverter(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:
IOException - if there are interop problems ARUnitConverter theARUnitConverter = (ARUnitConverter) obj;
Method Detail

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

getLocationAsString

public void getLocationAsString(IARMap pMap,
                                double xCoord,
                                double yCoord,
                                int displayUnits,
                                String[] sXLocation,
                                String[] sYLocation,
                                String[] sUnits)
                         throws IOException,
                                AutomationException
Converts the specified coordinates and units to strings.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
getLocationAsString in interface IARUnitConverter
Parameters:
pMap - A reference to a com.esri.arcgis.controls.IARMap (in)
xCoord - The xCoord (in)
yCoord - The yCoord (in)
displayUnits - A com.esri.arcgis.controls.esriARUnits constant (in)
sXLocation - The sXLocation (in/out: use single element array)
sYLocation - The sYLocation (in/out: use single element array)
sUnits - The sUnits (in/out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esriUnitsAsString

public String esriUnitsAsString(int units,
                                int caseAppearance,
                                boolean bPlural)
                         throws IOException,
                                AutomationException
Converts the specified units to strings in upper or lower case.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
esriUnitsAsString in interface IARUnitConverter
Parameters:
units - A com.esri.arcgis.controls.esriARUnits constant (in)
caseAppearance - A com.esri.arcgis.controls.esriARCaseAppearance constant (in)
bPlural - The bPlural (in)
Returns:
The sUnitString
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

convertUnits

public double convertUnits(double dValue,
                           int inUnits,
                           int outUnits)
                    throws IOException,
                           AutomationException
Converts the specified value between two units of measure.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
convertUnits in interface IARUnitConverter
Parameters:
dValue - The dValue (in)
inUnits - A com.esri.arcgis.controls.esriARUnits constant (in)
outUnits - A com.esri.arcgis.controls.esriARUnits constant (in)
Returns:
The outValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

doubleAsString

public String doubleAsString(double dValue,
                             int nDigits,
                             boolean bSeparators)
                      throws IOException,
                             AutomationException
Converts the specified value to a string rounded to a specified number of decimal places.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
doubleAsString in interface IARUnitConverter
Parameters:
dValue - The dValue (in)
nDigits - The nDigits (in)
bSeparators - The bSeparators (in)
Returns:
The sValueString
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLongLatAsString

public void getLongLatAsString(double longitude,
                               double latitude,
                               int displayUnits,
                               String[] sLongitude,
                               String[] sLatitude,
                               String[] sUnits)
                        throws IOException,
                               AutomationException
Converts the specified degree coordinates and units to strings.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
getLongLatAsString in interface IARUnitConverter
Parameters:
longitude - The longitude (in)
latitude - The latitude (in)
displayUnits - A com.esri.arcgis.controls.esriARUnits constant (in)
sLongitude - The sLongitude (in/out: use single element array)
sLatitude - The sLatitude (in/out: use single element array)
sUnits - The sUnits (in/out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esriUnitsAsAbbreviatedString

public String esriUnitsAsAbbreviatedString(int units,
                                           int caseAppearance)
                                    throws IOException,
                                           AutomationException
Converts the specified units to a string abbreviation in upper or lower case.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
esriUnitsAsAbbreviatedString in interface IARUnitConverter
Parameters:
units - A com.esri.arcgis.controls.esriARUnits constant (in)
caseAppearance - A com.esri.arcgis.controls.esriARCaseAppearance constant (in)
Returns:
The sUnitString
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.