com.esri.arcgis.geodatabaseextensions
Class CadastralDataTools

java.lang.Object
  com.esri.arcgis.geodatabaseextensions.CadastralDataTools

All Implemented Interfaces:

ICadastralGroundToGridTools, ICadastralUnitTools, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class CadastralDataTools
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ICadastralGroundToGridTools, ICadastralUnitTools

Tools that assist in unit translation and storage.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

CadastralDataTools()
Constructs a CadastralDataTools using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
IPoint	forward3D(ISpatialReference pSR, boolean argumentsInMeters, IPoint pPoint1, IPoint pPoint2Provisional, double markToMarkDistance) Forward3D calculates a new point from an existing point, given the mark-to-mark distance and azimuth measured at the ellipsoid height of the source point.
String	getAreaUnit(int eAreaType, boolean shortNotation) Area type enum value as a string.
static String	getClsid() getClsid.
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.
int	hashCode() the hashcode for this object
double	inverse3D(ISpatialReference pSR, boolean argumentsInMeters, IPoint pPoint1, IPoint pPoint2) Inverse3D calculates the mark-to-mark distance between two points, using the z value on the points as ellipsoid height, and using the spatial reference parameters.

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

CadastralDataTools

public CadastralDataTools()
                   throws IOException,
                          UnknownHostException

Constructs a CadastralDataTools using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

CadastralDataTools

public CadastralDataTools(Object obj)
                   throws IOException

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

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

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

inverse3D

public double inverse3D(ISpatialReference pSR,
                        boolean argumentsInMeters,
                        IPoint pPoint1,
                        IPoint pPoint2)
                 throws IOException,
                        AutomationException

Inverse3D calculates the mark-to-mark distance between two points, using the z value on the points as ellipsoid height, and using the spatial reference parameters.

Product Availability

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

Specified by:

inverse3D in interface ICadastralGroundToGridTools

Parameters:

pSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

argumentsInMeters - The argumentsInMeters (in)

pPoint1 - A reference to a com.esri.arcgis.geometry.IPoint (in)

pPoint2 - A reference to a com.esri.arcgis.geometry.IPoint (in)

Returns:

The pDistance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

forward3D

public IPoint forward3D(ISpatialReference pSR,
                        boolean argumentsInMeters,
                        IPoint pPoint1,
                        IPoint pPoint2Provisional,
                        double markToMarkDistance)
                 throws IOException,
                        AutomationException

Forward3D calculates a new point from an existing point, given the mark-to-mark distance and azimuth measured at the ellipsoid height of the source point. The z-value of the point is treated as an ellipsoid height, and the function uses the spatial reference p?S??&

Product Availability

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

Specified by:

forward3D in interface ICadastralGroundToGridTools

Parameters:

pSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

argumentsInMeters - The argumentsInMeters (in)

pPoint1 - A reference to a com.esri.arcgis.geometry.IPoint (in)

pPoint2Provisional - A reference to a com.esri.arcgis.geometry.IPoint (in)

markToMarkDistance - The markToMarkDistance (in)

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFormattedArea

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

Specified by:

getFormattedArea in interface ICadastralUnitTools

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

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

Specified by:

getConvertArea in interface ICadastralUnitTools

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

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

Specified by:

getDirectionType in interface ICadastralUnitTools

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

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

Specified by:

getDirectionUnit in interface ICadastralUnitTools

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

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

Specified by:

getDistanceUnit in interface ICadastralUnitTools

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

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

Specified by:

getAreaUnit in interface ICadastralUnitTools

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.