com.esri.arcgis.geodatabaseextensions
Interface ICadastralUnitTools

All Superinterfaces:

Serializable

All Known Implementing Classes:

CadastralDataTools

public interface ICadastralUnitTools
extends Serializable

Provides access to methods that format data.

Product Availability

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

Method Summary

String	getAreaUnit(int eAreaType, boolean shortNotation) Area type enum value as a string.
double	getConvertArea(double areaSQMeters, int eOutputAreaType) Converts a metric area value into a given area unit.
String	getDirectionType(int eDirType) Direction type enum value as a string.
String	getDirectionUnit(int eDirUnit) Direction units enum value as a string.
String	getDistanceUnit(int eDistanceType, boolean shortNotation) Distance units enum value as a string.
String	getFormattedArea(double areaSQMeters, int eOutputAreaTypeDisplay, boolean isUSFoot, int decimalPlaces) Converts a metric area value into a formated area string.

Method Detail

getFormattedArea

String getFormattedArea(double areaSQMeters,
                        int eOutputAreaTypeDisplay,
                        boolean isUSFoot,
                        int decimalPlaces)
                        throws IOException,
                               AutomationException

Converts a metric area value into a formated area string. isUSFoot applies to imperial output. If decimalPlaces = -1, the decimal places is automatically calculated from areaSQMeters.

Product Availability

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

Parameters:

areaSQMeters - The areaSQMeters (in)

eOutputAreaTypeDisplay - A com.esri.arcgis.geodatabaseextensions.esriCadastralAreaUnits constant (in)

isUSFoot - The isUSFoot (in)

decimalPlaces - The decimalPlaces (in)

Returns:

The formatedArea

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConvertArea

double getConvertArea(double areaSQMeters,
                      int eOutputAreaType)
                      throws IOException,
                             AutomationException

Converts a metric area value into a given area unit.

Product Availability

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

Parameters:

areaSQMeters - The areaSQMeters (in)

eOutputAreaType - A com.esri.arcgis.geodatabaseextensions.esriCadastralAreaUnits constant (in)

Returns:

The pArea

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirectionType

String getDirectionType(int eDirType)
                        throws IOException,
                               AutomationException

Direction type enum value as a string.

Product Availability

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

Parameters:

eDirType - A com.esri.arcgis.system.esriDirectionType constant (in)

Returns:

The dirType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirectionUnit

String getDirectionUnit(int eDirUnit)
                        throws IOException,
                               AutomationException

Direction units enum value as a string.

Product Availability

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

Parameters:

eDirUnit - A com.esri.arcgis.system.esriDirectionUnits constant (in)

Returns:

The dirUnit

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDistanceUnit

String getDistanceUnit(int eDistanceType,
                       boolean shortNotation)
                       throws IOException,
                              AutomationException

Distance units enum value as a string.

Product Availability

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

Parameters:

eDistanceType - A com.esri.arcgis.geodatabaseextensions.esriCadastralDistanceUnits constant (in)

shortNotation - The shortNotation (in)

Returns:

The distUnit

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAreaUnit

String getAreaUnit(int eAreaType,
                   boolean shortNotation)
                   throws IOException,
                          AutomationException

Area type enum value as a string.

Product Availability

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

Parameters:

eAreaType - A com.esri.arcgis.geodatabaseextensions.esriCadastralAreaUnits constant (in)

shortNotation - The shortNotation (in)

Returns:

The area

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.