com.esri.arcgis.geodatabaseextensions
Class CadastralDataTools

java.lang.Object
  extended by com.esri.arcgis.geodatabaseextensions.CadastralDataTools
All Implemented Interfaces:
ICadastralGroundToGridTools, ICadastralUnitTools, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

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

COM Class 'CadastralDataTools'. Generated 3/19/2015 1:20:49 PM from 'C:\ArcGIS\COM\esriGeoDatabaseExtensions.olb'

Description 'Tools that assist in unit translation and storage.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.esri.arcgis.geodatabaseextensions.ICadastralGroundToGridTools
IID, IID69e2d388_48f1_407c_9f35_fc972034336a, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabaseextensions.ICadastralUnitTools
IID, IID0dc83354_e621_4c2d_9c2d_bad65c0727d1, xxDummy
 
Constructor Summary
CadastralDataTools()
          Constructs a CadastralDataTools using ArcGIS Engine.
CadastralDataTools(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
CadastralDataTools theCadastralDataTools = (CadastralDataTools) obj;
 
Method Summary
 boolean equals(java.lang.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.
 java.lang.String getAreaUnit(int eAreaType, boolean shortNotation)
          Area type enum value as a string.
static java.lang.String getClsid()
          getClsid.
 double getConvertArea(double areaSQMeters, int eOutputAreaType)
          Converts a metric area value into a given area unit.
 java.lang.String getDirectionType(int eDirType)
          Direction type enum value as a string.
 java.lang.String getDirectionUnit(int eDirUnit)
          Direction units enum value as a string.
 java.lang.String getDistanceUnit(int eDistanceType, boolean shortNotation)
          Distance units enum value as a string.
 java.lang.String getFormattedArea(double areaSQMeters, int eOutputAreaTypeDisplay, boolean isUSFoot, int decimalPlaces)
          Converts a metric area value into a formated area string.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 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.
 void release()
          Release a CadastralDataTools.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CadastralDataTools

public CadastralDataTools()
                   throws java.io.IOException,
                          java.net.UnknownHostException
Constructs a CadastralDataTools using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

CadastralDataTools

public CadastralDataTools(java.lang.Object obj)
                   throws java.io.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:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a CadastralDataTools.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

inverse3D

public double inverse3D(ISpatialReference pSR,
                        boolean argumentsInMeters,
                        IPoint pPoint1,
                        IPoint pPoint2)
                 throws java.io.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.

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:
java.io.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 java.io.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???m?

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFormattedArea

public java.lang.String getFormattedArea(double areaSQMeters,
                                         int eOutputAreaTypeDisplay,
                                         boolean isUSFoot,
                                         int decimalPlaces)
                                  throws java.io.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.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getConvertArea

public double getConvertArea(double areaSQMeters,
                             int eOutputAreaType)
                      throws java.io.IOException,
                             AutomationException
Converts a metric area value into a given area unit.

Specified by:
getConvertArea in interface ICadastralUnitTools
Parameters:
areaSQMeters - The areaSQMeters (in)
eOutputAreaType - A com.esri.arcgis.geodatabaseextensions.esriCadastralAreaUnits constant (in)
Returns:
The pArea
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDirectionType

public java.lang.String getDirectionType(int eDirType)
                                  throws java.io.IOException,
                                         AutomationException
Direction type enum value as a string.

Specified by:
getDirectionType in interface ICadastralUnitTools
Parameters:
eDirType - A com.esri.arcgis.system.esriDirectionType constant (in)
Returns:
The dirType
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDirectionUnit

public java.lang.String getDirectionUnit(int eDirUnit)
                                  throws java.io.IOException,
                                         AutomationException
Direction units enum value as a string.

Specified by:
getDirectionUnit in interface ICadastralUnitTools
Parameters:
eDirUnit - A com.esri.arcgis.system.esriDirectionUnits constant (in)
Returns:
The dirUnit
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDistanceUnit

public java.lang.String getDistanceUnit(int eDistanceType,
                                        boolean shortNotation)
                                 throws java.io.IOException,
                                        AutomationException
Distance units enum value as a string.

Specified by:
getDistanceUnit in interface ICadastralUnitTools
Parameters:
eDistanceType - A com.esri.arcgis.geodatabaseextensions.esriCadastralDistanceUnits constant (in)
shortNotation - The shortNotation (in)
Returns:
The distUnit
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAreaUnit

public java.lang.String getAreaUnit(int eAreaType,
                                    boolean shortNotation)
                             throws java.io.IOException,
                                    AutomationException
Area type enum value as a string.

Specified by:
getAreaUnit in interface ICadastralUnitTools
Parameters:
eAreaType - A com.esri.arcgis.geodatabaseextensions.esriCadastralAreaUnits constant (in)
shortNotation - The shortNotation (in)
Returns:
The area
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.