com.esri.arcgis.geodatabase
Class GeometryServer

java.lang.Object
  extended by com.esri.arcgis.geodatabase.GeometryServer
All Implemented Interfaces:
IGeometryServer, IGeometryServer2, com.esri.arcgis.interop.RemoteObjRef, IServerObject, IServerObjectExtensionManager, ILogSupport, IObjectActivate, IObjectConstruct, IRequestHandler, IRequestHandler2, ISupportErrorInfo, Serializable

public class GeometryServer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IObjectConstruct, IRequestHandler, IRequestHandler2, IObjectActivate, ILogSupport, ISupportErrorInfo, IServerObject, IServerObjectExtensionManager, IGeometryServer, IGeometryServer2

Provides access to standard operations on geometric 'value' objects. The input geometries are never modified by these operations. Designed for use in building web services and web applications.

Remarks

The GeometryServer lets clients programmatically apply common geometric operations to arrays of geometry 'value' objects. Buffering, projection of geometries from one spatial reference system to another, and evaluation of spatial relations are some of the operations provided.

In a server environment, a GeometryServer object can be accessed via Distributed COM (DCOM) over a TCP/IP connection (Intranet) or via SOAP/XML over an HTTP connection (Internet). A REST api is also supported. The GeometryServer object is a stateless, "compute-only" service. As such, only one can be instantiated at a time in a server environment.

SOAP clients make use of a GeometryServer via its web service interface, defined by the this URL:


http://<server name>/arcgis/services/Geometry/GeometryServer?wsdl</CODE></A></PRE>

<P>The name of the service, "Geometry", cannot be changed.</P>

<P>Clients can also access a GeometryServer in a DCOM environment by obtaining an IGeometryServer interface from a Server Object Manager. In this case, all geometries, spatial references and other objects used by the GeometryServer should also be created by the same Server Object Manager. Clients can use either ArcObjects or the ESRI Web Application Developer Framework (WebADF) to access the GeometryServer in this manner.</P>

<P>Finally, clients with ArcObjects (Engine or Desktop) installed can directly create a GeometryServer COM object in their own process and invoke methods on it. The GeometryServer does not provide a significant level of abstraction over direct use of other parts of the geometry API, but this approach might be useful in some cases.</P>

<P>In all access models, inputs are read-only values and outputs are returned as new geometry values in new arrays.</P>

<P>&nbsp;</P>

<P><STRONG>Spatial References, geometries, and the GeometryServer</STRONG> <BR></P>

<P>GeometryServer&nbsp;operations typically take as input a spatial reference (SR) and an array of geometries assumed to be in that SR. This&nbsp;SR&nbsp;cannot be nil. This approach is different than the ArcObjects model for programming with&nbsp;geometries. In the latter case, each individual geometry is explicitly associated with an SR. In the GeometryServer case, any such association is ignored and only the input SR is used. As a result, SOAP and DCOM clients of the GeometryServer object do not need to establish this reference for input geometries and thus can avoid serializing the spatial reference for each geometry as part of network transmission of the inputs.</P>

<P>Geometry value objects created by a GeometryServer method have no explicit association to a spatial reference object. They are also assumed to be defined in the SR specified as the input parameter to that method. It is the callers responsibility to use the correct SR with these geometries.</P>

<P>&nbsp;</P>

<P><STRONG>GeometryServer and GeometryServerImpl</STRONG></P>

<P>ArcObjects currently exposes two cocreatable COM objects: GeometryServer (defined in the geodatabase object library) and GeometryServerImpl (defined in the geometry object library). DCOM and ArcEngine clients of the GeometryServer should only create an instance of the former and never an instance of the latter.</P>

<P>&nbsp;</P>

<P><STRONG>GeometryServer and Internet Information Services</STRONG></P>

<P>If you are sending large SOAP messages to a GeometryServer (many input geometries or geometries with many points) and receive an error message something like "connection forcibly closed", you may need to increase the maximum allowable size of messages sent to IIS. You can do this by specifying a larger value for the MaxRequestLength attribute of the httpRuntime tag in the web.config file located under <SPAN style="FONT-SIZE: 10pt; COLOR: navy; FONT-FAMILY: 'Arial','sans-serif'; mso-fareast-font-family: Calibri; mso-fareast-theme-font: minor-latin; mso-ansi-language: EN-US; mso-fareast-language: EN-US; mso-bidi-language: AR-SA">the \inetpub\wwwroot\arcgis\services </SPAN>. For more details, please see this link:</P>

<P><A href="http://msdn2.microsoft.com/en-us/library/e1f13641(vs.71).aspx">http://msdn2.microsoft.com/en-us/library/e1f13641(vs.71).aspx</A></P></SPAN>



</body>

</html>



Product Availability

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

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.esri.arcgis.system.IRequestHandler
IID, IID46a0e2ea_3b64_4a46_bd78_88a1660f35bb, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IObjectActivate
IID, IIDe3b78022_143e_4e61_9099_ed319ec061e7, xxDummy
 
Constructor Summary
GeometryServer()
          Constructs a GeometryServer using ArcGIS Engine.
GeometryServer(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GeometryServer theGeometryServer = (GeometryServer) obj;
 
Method Summary
 void activate()
          Activates the object.
 IPolygonArray autoComplete(ISpatialReference pSR, IPolygonArray pInPolygons, IPolylineArray pCompletionLines)
          Discovers polygons bounded by existing polygons and input linework.
 IGeometryArray buffer(ISpatialReference pInSR, ISpatialReference pBufferSR, ISpatialReference pOutSR, IDoubleArray pDistances, IUnit pUnit, boolean bUnion, IGeometryArray pInGeometries)
          Buffers an array of geometries by each distance specified in an array of distances.
 void construct(IPropertySet props)
          Two phase object construction.
 IGeometry convexHull(ISpatialReference pSR, IGeometryArray pInGeometryArray)
          Computes the convex hull of the input geometries
 IGeometryArray cut(ISpatialReference pSR, IGeometryArray pTargets, IPolyline pCutter, ILongArray[] ppCutIndexes)
          Cuts the target polyline or polygon Cutter.
 void deactivate()
          Deactivates the object.
 IGeometryArray densify(ISpatialReference pSR, IGeometryArray pInGeometries, double maxSegmentLength, boolean useDeviationDensification, double densificationParameter)
          Applies the ArcObjects 'Densify' operation to each element of the geometry array.
 IGeometryArray densifyGeodesic(ISpatialReference pSR, IGeometryArray pInGeometries, double maxSegmentLength, ILinearUnit pLengthUnit)
          Densifies geometries by plotting points along the geodesics between existing vertices (uses IPolycurve4::GeodesicDensify).
 IGeometryArray difference(ISpatialReference pSR, IGeometryArray pInGA1, IGeometry pInG2)
          Returns an array of geometries where each result geometry R[i] is (array1[i] difference G2).
 boolean equals(Object o)
          Compare this object with another
 IServerObjectExtension findExtensionByCLSID(String cLSID)
          Returns a server object extension found using a string representation of its class ID.
 IServerObjectExtension findExtensionByTypeName(String name)
          Returns a server object extension found using its type name.
 ISpatialReference findSRByWKID(String authority, int wKID, int wKID_Z, boolean bDefaultXYResolution, boolean bDefaultXYTolerance)
          Defines a spatial reference object based upon its well known identifier (WKID) and optionally a WKID for a vertical datum.
 ISpatialReference findSRByWKT(String wKT, String wKT_Z, boolean bDefaultXYResolution, boolean bDefaultXYTolerance)
          Defines a spatial reference object based upon its well known text string (WKT) and optionally a WKT for a vertical datum.
 IUnit findUnitsByWKID(String authority, int wKID)
          Defines a unit object based upon its well known identified (WKID).
 IUnit findUnitsByWKT(String wKT)
          Defines a unit object based upon its well known text string.
 IGeometryArray generalize(ISpatialReference pSR, IGeometryArray pInGA, double maxDeviation, ILinearUnit pDeviationUnit)
          Returns generalized (Douglas-Poiker) versions of the input polylines and polygons (uses IPolycurve::Generalize).
 void getAreasAndLengths(ISpatialReference pSR, IPolygonArray pInPolygons, IDoubleArray[] ppAreas, IDoubleArray[] ppLengths)
          Calculates areas and perimeter lengths for each polygon in the specified array.
 void getAreasAndLengths2(ISpatialReference pSR, IPolygonArray pInPolygons, ILinearUnit pLengthUnit, ILinearUnit pAreaUnit, int areaUnitEnum, IDoubleArray[] ppAreas, IDoubleArray[] ppLengths)
          Calculates areas and perimeter lengths for each polygon in the specified array.
static String getClsid()
          getClsid.
 String getConfigurationName()
          Name of the server object configuration that defines the server object.
 double getDistance(ISpatialReference pSR, IGeometry pG1, IGeometry pG2, ILinearUnit pDistanceUnit)
          Reports shortest distance between G1 and G2.
 double getDistanceGeodesic(ISpatialReference pSR, IGeometry pG1, IGeometry pG2, ILinearUnit pDistanceUnit)
          Reports the shortest geodesic distance between G1 and G2.
 IPointArray getLabelPoints(ISpatialReference pSR, IPolygonArray pInPolygons)
          Calculates an interior point for each polygon.
 IDoubleArray getLengths(ISpatialReference pSR, IPolylineArray pInPolylines)
          Calculates the length of eacch polyline in the specified array.
 IDoubleArray getLengths2(ISpatialReference pSR, IPolylineArray pInPolylines, ILinearUnit pLengthUnit)
          Calculates the length of eacch polyline in the specified array.
 IDoubleArray getLengthsGeodesic(ISpatialReference pSR, IPolylineArray polylines, ILinearUnit pLengthUnit)
          Returns geodesic length of each Polyline.
 String getTypeName()
          Type of the server object (MapServer or GeocodeServer).
 byte[] handleBinaryRequest(byte[] request)
          Handles a binary request.
 byte[] handleBinaryRequest2(String capabilities, byte[] request)
          Handles a binary request with explicit capabilities.
 String handleStringRequest(String capabilities, String request)
          Handles a SOAP string request.
 int hashCode()
          the hashcode for this object
 void initLogging(ILog log)
          Initializes an object with a log.
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 IGeometryArray intersect(ISpatialReference pSR, IGeometryArray pInGA1, IGeometry pInG2)
          Returns an array of geometries where each result geometry R[i] is (array1[i] intersect G2.
 IGeometryArray offset(ISpatialReference pSR, IGeometryArray pInGA, double offsetDistance, ILinearUnit pOffsetUnit, int offsetHow, double bevelRatio)
          Returns an array of polylines and polygons that are offset versions of the input polylines and polygons (uses ITopologicalOperator::ConstructOffset).
 IGeometryArray project(ISpatialReference pInSR, ISpatialReference pOutSR, int xFormDir, ITransformation pXForm, IEnvelope pExtent, IGeometryArray pInGeometries)
          Projects an array of geometries from their current spatial reference (pInSR) to a destination spatial reference (pOutSR).
 IRelationResultArray relation(ISpatialReference pSR, IGeometryArray pInGA1, IGeometryArray pInGA2, int r, String param)
          Determines the pairs of geometries from the input geometry arrays that participate in the specified spatial relation.
 IGeometry reshape(ISpatialReference pSR, IGeometry pTarget, IPolyline pReshaper)
          Reshapes the target polyline or polygon.
 IGeometryArray simplify(ISpatialReference pSR, IGeometryArray pInGeometries)
          Applies the ArcObjects 'Simplify' operation to each element of the geometry array.
 IPolylineArray trimExtend(ISpatialReference pSR, IPolylineArray pInPA, IPolyline pTrimExtendTo, int extendHow)
          Trims or extends each polyline in the input array using TrimExtendTo (uses IConstructCurve::ConstructExtended for extension operation).
 IGeometry union(ISpatialReference pSR, IGeometryArray pInGA)
          Returns the topological union of the input geometries (uses ITopologicalOperator::ConstructUnion).
 
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

GeometryServer

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

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

GeometryServer

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

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

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

construct

public void construct(IPropertySet props)
               throws IOException,
                      AutomationException
Two phase object construction.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

handleBinaryRequest

public byte[] handleBinaryRequest(byte[] request)
                           throws IOException,
                                  AutomationException
Handles a binary request.

Specified by:
handleBinaryRequest in interface IRequestHandler
Parameters:
request - An unsigned byte (in)
Returns:
An unsigned byte
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

handleStringRequest

public String handleStringRequest(String capabilities,
                                  String request)
                           throws IOException,
                                  AutomationException
Handles a SOAP string request.

Specified by:
handleStringRequest in interface IRequestHandler
Parameters:
capabilities - The capabilities (in)
request - The request (in)
Returns:
The response
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

handleBinaryRequest2

public byte[] handleBinaryRequest2(String capabilities,
                                   byte[] request)
                            throws IOException,
                                   AutomationException
Handles a binary request with explicit capabilities.

Product Availability

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

Specified by:
handleBinaryRequest2 in interface IRequestHandler2
Parameters:
capabilities - The capabilities (in)
request - An unsigned byte (in)
Returns:
An unsigned byte
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

activate

public void activate()
              throws IOException,
                     AutomationException
Activates the object.

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

deactivate

public void deactivate()
                throws IOException,
                       AutomationException
Deactivates the object.

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

initLogging

public void initLogging(ILog log)
                 throws IOException,
                        AutomationException
Initializes an object with a log.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getConfigurationName

public String getConfigurationName()
                            throws IOException,
                                   AutomationException
Name of the server object configuration that defines the server object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getConfigurationName in interface IServerObject
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTypeName

public String getTypeName()
                   throws IOException,
                          AutomationException
Type of the server object (MapServer or GeocodeServer).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getTypeName in interface IServerObject
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findExtensionByCLSID

public IServerObjectExtension findExtensionByCLSID(String cLSID)
                                            throws IOException,
                                                   AutomationException
Returns a server object extension found using a string representation of its class ID.

Product Availability

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

Specified by:
findExtensionByCLSID in interface IServerObjectExtensionManager
Parameters:
cLSID - The cLSID (in)
Returns:
A reference to a com.esri.arcgis.server.IServerObjectExtension
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findExtensionByTypeName

public IServerObjectExtension findExtensionByTypeName(String name)
                                               throws IOException,
                                                      AutomationException
Returns a server object extension found using its type name.

Product Availability

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

Specified by:
findExtensionByTypeName in interface IServerObjectExtensionManager
Parameters:
name - The name (in)
Returns:
A reference to a com.esri.arcgis.server.IServerObjectExtension
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

project

public IGeometryArray project(ISpatialReference pInSR,
                              ISpatialReference pOutSR,
                              int xFormDir,
                              ITransformation pXForm,
                              IEnvelope pExtent,
                              IGeometryArray pInGeometries)
                       throws IOException,
                              AutomationException
Projects an array of geometries from their current spatial reference (pInSR) to a destination spatial reference (pOutSR). The projection process can optionally include a datum transformation if the source and destination SRs have different GCSs.

Remarks

The Project method applies the projection pOutSR to a copy of each element of pInGeometries and places the results in ppProjectedGeometries. All input geometries are assumed to be in the spatial reference pInSR, which cannot be nil. The input geometries are not modified. The array can contain mixed top-level geometry types (specifically points, multipoints, polylines and polygons). The array can also contain envelopes. pXForm and pExtent are optional. If pXForm is specified, then it is an instance of a GeoTransformation subclass (see EDN for details on datum transformations), and xFormDir must also be specified (esriTransformForward, esriTransformReverse ). If pExtent is specified, then all input geometries are then assumed to be contained in it, and an attempt will be made to optimize the projection operation by checking if that extent is completely contained in the projection's horizon.

The SpatialReference property for all returned geometries will be null. It is the consumers responsibility to assign the spatial reference to each geometry returned, if desired. In this case, the spatial reference is assumed to be the output spatial reference defined for the Project operation.

If pXForm is not specified and the datums of the specified spatial references are not the same, then a search is made through a set of default datum transformations (a.k.a geographic transformations) . Currently, the following transformations, identified by name and WKID, are in that set:
esriSRGeoTransformation_NAD_1927_TO_NAD_1983_NADCON, forward and reverse, WKID = 1241
esriSRGeoTransformation_NAD1983_To_WGS1984_1, forward and reverse, WKID = 1170
esriSRGeoTransformation_NAD1927_To_WGS1984_4, forward and reverse, WKID = 1173

Refer to FindSRByWKID for a discussion on how to create the different kinds of spatial reference systems that can be used with this method. In addition, Well Known Identifiers (WKIDs) for available geotransformations are listed in the following enumerations:

esriSRGeoTransformation2Type
esriSRGeoTransformation3Type
esriSRGeoTransformationType

Refer to GeometryServer for additional details on how the input spatial reference is interpreted.

Product Availability

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

Specified by:
project in interface IGeometryServer
Parameters:
pInSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
pOutSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
xFormDir - A com.esri.arcgis.geometry.esriTransformDirection constant (in)
pXForm - A reference to a com.esri.arcgis.geometry.ITransformation (in)
pExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
pInGeometries - A reference to a com.esri.arcgis.geometry.IGeometryArray (in)
Returns:
A reference to a com.esri.arcgis.geometry.IGeometryArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

buffer

public IGeometryArray buffer(ISpatialReference pInSR,
                             ISpatialReference pBufferSR,
                             ISpatialReference pOutSR,
                             IDoubleArray pDistances,
                             IUnit pUnit,
                             boolean bUnion,
                             IGeometryArray pInGeometries)
                      throws IOException,
                             AutomationException
Buffers an array of geometries by each distance specified in an array of distances. The distance units can optionally be specified. Geometries buffered at a given distance can optionally be unioned together.

Remarks

Applies the geometric buffer operation to each geometry in pInGeometries, using each distance in the array pDistances. All geometries are assumed to be in the coordinate system pInSR, which cannot be nil. pBufferSR is the spatial reference in which the geometries are buffered. pOutSR is the spatial reference in which the buffer polygons are returned. pInSR must be specified. Either or both of the other SRs can be null. If the output spatial reference is null, then the input spatial reference is used for output; if the buffering spatial reference is null, then the output spatial reference is used for buffering; if both output and buffer spatial references are null, then the input spatial reference is used.

The distances can be specified in a separate unit of measure. For example, the buffer distances could be specified in feet and the coordinates of the geometries could be specified in meters. If bUnion is false, each buffered polygon will be added to ppOutBuffers separately. If bUnion is true, then all geometries buffered at a given distance will be unioned into a single (possibly multipart) polygon and that unioned geometry will be placed in the output array.

The SpatialReference property for all returned geometry will be null. It is the consumers responsibility to assign the spatial reference to each geometry returned, if desired. In this case, the spatial reference is assumed to be the output spatial reference defined for the Buffer operation.

Refer to IGeometryServer for additional details on how the input spatial reference is interpreted.

Buffering of geometries with latitude-longitude coordinates is only supported for points and multipoints. In order to meaningfully buffer polylines and polygons with such coordinates, you need to specify a planar (projected) coordinate system in which the buffering will happen. Use the BufferSpatialReference parameter to define this coordinate system. When the Buffer method is called, the input features will be projected into this coordinate system (BufferSpatialReference), buffered, and then either inverse projected into the original coordinate system (InSpatialReference) or projected into the output coordinate system (OutSpatialReference).

When buffering points or multipoints and the input spatial reference is a geographic coordinate system (WGS1984, for example), you have the option of generating true geodesic buffers. To obtain such buffers, specify a linear unit of distance for the pUnit parameter.

Here is an example showing how to create a buffer using the Geometry Server.

Product Availability

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

Specified by:
buffer in interface IGeometryServer
Parameters:
pInSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
pBufferSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
pOutSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
pDistances - A reference to a com.esri.arcgis.system.IDoubleArray (in)
pUnit - A reference to a com.esri.arcgis.geometry.IUnit (in)
bUnion - The bUnion (in)
pInGeometries - A reference to a com.esri.arcgis.geometry.IGeometryArray (in)
Returns:
A reference to a com.esri.arcgis.geometry.IGeometryArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

relation

public IRelationResultArray relation(ISpatialReference pSR,
                                     IGeometryArray pInGA1,
                                     IGeometryArray pInGA2,
                                     int r,
                                     String param)
                              throws IOException,
                                     AutomationException
Determines the pairs of geometries from the input geometry arrays that participate in the specified spatial relation.

Remarks

Computes the set of pairs of geometries from pInGA1 and pInGA2 that belong to the specified relation. Both arrays are assumed to be in the coordinate system pSR, which cannot be nil. The relations are evaluated in 2D. Z coordinates are not used. Geometry types cannot be mixed within an array. Further restrictions on the types of geometries in an array are listed in the following table. r is a member of esriSpatialRelationEnum and can be one of the following:

Name Description
esriSpatialRelationDisjoint Same as IRelationalOperator::Disjoint. The zero-based index of a geometry from pInGA1 and the zero-based index of a geometry from pInGA2 define an element of the output array of relation results if the geometries share no points in common. See IRelationalOperator_Disjoint for some examples of the disjoint relation. There are no additional restrictions on the types of geometries in the input arrays.
esriSpatialRelationIntersection The opposite of esriSpatialRelationDisjoint. An element of the output array will specify the indexes of geometries from the input arrays if they share at least one point in the xy plane. There are no additional restrictions on the types of geometries in the input arrays.
esriSpatialRelationInteriorIntersection Same as esriSpatialRelationIntersection, but excludes intersections that occur only at boundaries (two touching polygons for example). The interior of a point is considered to be the point itself and the interior of a polyline excludes the endpoints of all its parts. There are no additional restrictions on the types of geometries in the input arrays.
esriSpatialRelationIn, esriSpatialRelationWithin These relations are similar. esriSpatialRelationIn is the same as IRelationalOperator::Within. esriSpatialRelationWithin is the same but also allows polylines that are strictly on the boundaries of polygons to be considered “in” the polygon. This case is disallowed by the former relation (and disallowed by IRelationalOperator::Within). The dimension of all geometries in pInGA1 must be >= the dimension of geometries in pInGA2.

esriSpatialRelationPointTouch, esriSpatialRelationLineTouch, esriSpatialRelationTouch

esriSpatialRelationPointTouch and esriSpatialRelationLineTouch are boundary intersections classified by dimension of intersection. esriSpatialRelationTouch is the union of those two and is equivalent to the ArcObjects IRelationalOperator Touch method.

These relations are defined for polylines and polygons.

esriSpatialRelationLineCoincidence The boundaries of the shapes must share a 1D intersection, but the relationship between the interiors of the shapes is not considered (they could overlap, one could be contained in the other, or their interiors could be disjoint). This relation applies to polylines and polygons.
esriSpatialRelationCross Same as the ArcObjects IRelationalOperator::Cross method. Lines can cross other lines at a point and lines can cross polygons. See IRelationalOperator_Crosses for examples.
esriSpatialRelationRelation 'param' defines the 'Shape Comparison Language' string to be evaluated. Strings such as "RELATE(G1, G2, ""FFFTTT***"")" are accepted, in addition to other kinds of strings. See the following EDN topic for more details on the Shape Comparison Language. http://edndoc.esri.com/arcobjects/9.2/NET/40de6491-9b2d-440d-848b-2609efcd46b1.htm

The output array contains elements of type


struct esriRelationPair

{

 // The index of the left element in the relation.

 long m_leftIndex;



 //The index of the right element in the relation.

 long m_rightIndex;



} esriRelationPair;

m_leftIndex is a zero-based index into pInGA1 and m_rightIndex is an index into pInGA2.

esriGeometryRelationEnum is a synonym for esriSpatialRelationEnum. The former is the type name exposed through the web service. The latter is exposed through the COM api.

Refer to IGeometryServer for additional details on how the input spatial reference is interpreted.

Product Availability

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

Specified by:
relation in interface IGeometryServer
Parameters:
pSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
pInGA1 - A reference to a com.esri.arcgis.geometry.IGeometryArray (in)
pInGA2 - A reference to a com.esri.arcgis.geometry.IGeometryArray (in)
r - A com.esri.arcgis.geometry.esriSpatialRelationEnum constant (in)
param - The param (in)
Returns:
A reference to a com.esri.arcgis.geometry.IRelationResultArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

simplify

public IGeometryArray simplify(ISpatialReference pSR,
                               IGeometryArray pInGeometries)
                        throws IOException,
                               AutomationException
Applies the ArcObjects 'Simplify' operation to each element of the geometry array.

Remarks

Applies the ArcObjects geometric simplification operation to a copy of each geometry in the input array, placing the result in ppSimplifiedGeometries. The input geometries are assumed to be specified in the input spatial reference pSR, which cannot be nil. The elements can be a mixture of points, multipoints, polylines or polygons. Elements that can’t be simplifed are replaced with empty geometries of the same type at the corresponding index entry in the output array.

Refer to IGeometryServer for additional details on how the input spatial reference is interpreted.

This operation uses the coordinate grid and the xy and z cluster tolerances of the spatial reference. For more information on these properties and how they can affect your coordinates, please refer to the ESRI whitepaper “Understanding Coordinate Management in the Geodatabase”: SimplifyNetwork method. Coordinates are snapped, zero-length segments and empty parts are removed. Length is determined in 3D if the polyline has z coordinates, otherwise it is determined in 2D.

  • For Polygons, Simplify identifies an interior and exterior for the polygon, then modifies the polygon structure to be consistent with that determination. The methodology for identifying interior and exterior is:

    1. Remove all dangles
    2. Identify the largest legal rings, add them to the output version of the polygon, then delete them from the working version
    3. Repeat

    This operation uses the xy cluster tolerance of the associated spatial reference to determine when two vertices are the same, or when a vertex needs to be snapped to a line. This specific approach is subject to change in future releases of esri software.
    At the end of Simplify, no rings will overlap, no self intersection will occur (except in certain circumstances) and, in general, an arbitrary point can always be classified unambiguously as either outside, on the boundary of, or inside the polygon. All exterior rings are oriented clockwise. All interior rings (i.e. holes) are counter-clockwise.
  • Simplify2

    Product Availability

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

    Specified by:
    simplify in interface IGeometryServer
    Parameters:
    pSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
    pInGeometries - A reference to a com.esri.arcgis.geometry.IGeometryArray (in)
    Returns:
    A reference to a com.esri.arcgis.geometry.IGeometryArray
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    densify

    public IGeometryArray densify(ISpatialReference pSR,
                                  IGeometryArray pInGeometries,
                                  double maxSegmentLength,
                                  boolean useDeviationDensification,
                                  double densificationParameter)
                           throws IOException,
                                  AutomationException
    Applies the ArcObjects 'Densify' operation to each element of the geometry array.

    Remarks

    Replaces each curve segment, and optionally each line segment, in a polyline or polygon with line segments. Other types of input geometries will be ignored. All geometries are assumed to be in the spatial reference pSR, which cannot be nil.

    When maxSegmentLength is greater than zero, lines and curves greater than that length will be replaced with lines at most maxSegmentLength long, and curves shorter than that will be replaced with lines connecting their endpoints. If maxSegmentLength is 0, then only curve segments will be densified, as explained below.

    In general, this method provides three ways to densify curves:

    1. based on length
    2. based on central angle
    3. based on maximum distance of replacement line from input curve (deviation)

    The following table explains how the input parameters work together.

    When MaxSegmentLength is and angleOrDeviation is then
    > 0 0 All segments longer than maxSegmentLength are replaced with sequences of lines no longer than maxSegmentLength. Curves shorter than maxSegmentLength are replaced with lines connecting the curve endpoints. This is method 1, above, for densifying curves.
    0 > 0 Input lines are copied to the output geometries. Input curves are densified using either method 2 or method 3, based on the value of the useDeviationDensification parameter.
    > 0 > 0 Lines longer than maxSegmentLength units are replaced with sequences of lines no longer than maxSegmentLength; curves are replaced with sequences of lines using either method 2 or method 3, based on the value of the useDeviationDensification parameter.

    When UseDeviationDensification is false the DensificationParameter is interpreted as a central angle, instead of a deviation.

    Refer to IGeometryServer for additional details on how the input spatial reference is interpreted.

    If the geometries are in a geographic coordinate system, then “linear” densification distances are in units of degrees (or some other gcs angular unit). This isn’t meaningful if you expect output segments to have a constant ground length, but it still accomplishes the purpose of densifying the geometries, which is useful if you subsequently want to project them more accurately.

    Product Availability

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

    Specified by:
    densify in interface IGeometryServer
    Parameters:
    pSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
    pInGeometries - A reference to a com.esri.arcgis.geometry.IGeometryArray (in)
    maxSegmentLength - The maxSegmentLength (in)
    useDeviationDensification - The useDeviationDensification (in)
    densificationParameter - The densificationParameter (in)
    Returns:
    A reference to a com.esri.arcgis.geometry.IGeometryArray
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    findSRByWKID

    public ISpatialReference findSRByWKID(String authority,
                                          int wKID,
                                          int wKID_Z,
                                          boolean bDefaultXYResolution,
                                          boolean bDefaultXYTolerance)
                                   throws IOException,
                                          AutomationException
    Defines a spatial reference object based upon its well known identifier (WKID) and optionally a WKID for a vertical datum. The resolution and xy tolerances are either computed from the sr horizon or set to defaults. 'authority' is typically either 'EPSG' or 'E?O??&

    Remarks

    Returns a predefined, high precision spatial reference based on its OGP/EPSG Well Known Identifier (WKID, aka “factory code”). Valid WKIDs are listed below. If WKID_Z > -1, then a vertical coordinate system will be created and associated with the horizontal coordinate system.


    AuthorityName is usually "EPSG" or "ESRI", but can also be an arbitrary string. It can also be the empty string if you want the default authority name associated with the new spatial reference. Clients can associate their own authority names with factory codes that are currently associated with the EPSG or ESRI authority names, because only the WKID is used to create the spatial reference. Here are the current rules for mapping WKID ranges to default authority names:

    • A WKID in the EPSG code range (1000 – 32768) will result in an AUTHORITY name of “EPSG”, and the version will be the current EPSG version used (currently “6.12”).
    • A WKID in the ESRI code range (33000 – 199999) will result in an AUTHORITY name of “ESRI”, and the version will be the current PE library version (currently “9.3”).
    • A WKID in the user (objedit) range (200000 – 209199) will result in an AUTHORITY name of “CUSTOM”, with no version associated with it. This name is specified by the OGC.

    For web service clients of the geometry server, the returned WKT (well known text) element of the spatial reference will have an “AUTHORITY’ tag in it, containing the default or the client-specified authority name and the specified WKID.

    If bDefaultXYResolution is true, then the xy coordinate grid resolution will be set to its default value (see SetDefaultXYResolution for details). If it is false, the finest possible resolution that covers the horizon of the spatial reference will be used (see ConstructFromHorizon for details).

    If bDefaultXYTolerance is true, then the default xy tolerance of 1mm will be used (see SetDefaultXYTolerance for details). If it is false, then the minimum xy tolerance will be used (2.0 * xy coordinate grid resolution).

    Lists of the valid WKIDs for predefined Projected Coordinate Systems can be found here:
    esriSRProjCS2Type, esriSRProjCS3Type, esriSRProjCS4Type, esriSRProjCSType

    Lists of the valid WKIDs for predefined Geographic Coordinate Systems can be found here:

    esriSRGeoCS2Type, esriSRGeoCS3Type, esriSRGeoCSType

    Default XY Resolution values

    SpatialReference type

    Precision

    Default value

    ProjectedCoordinateSystem

    high

    1/10 mm

    ProjectedCoordinateSystem

    low

    1 mm

    GeographicCoordinateSystem

    high

    1/10,000 arc-second

    GeographicCoordinateSystem

    low

    1/500 arc-second

    UnknownCoordinateSystem

    high

    1/10 mm

    UnknownCoordinateSystem

    low

    1 mm

    Defining an XY resolution

    Defining an XY resolution for a spatial reference depends on the type and precision of a coordinate system. For high precision spatial references, the domain extent and resolution must be sufficient to cover the horizon of a given coordinate system. For low-precision spatial references the domain extent is centered on the horizon center.

    For a high precision ProjectedCoordinateSystem (PCS), the domain extent is a square completely covering, and slightly larger than, the horizon extent of the PCS (which is an arbitrary rectangle). The scale factor (1/precision) is chosen to fit this domain. For a low precision PCS, the center of the domain extent is aligned with the center of the horizon extent and expanded to achieve a target resolution of 1mm.

    For a high precision GeographicCoordinateSystem (GCS), the square domain (-400, -400, 400, 400), expressed in the units of the spatial reference, is used. For a low precision GCS the upper right hand corner is adjusted to achieve a default resolution of 1/500 of an arc-second.

    For an UnknownCoordinateSystem (UCS), the "horizon" is defined to be a square that produces a resolution of 1 millimeter for a low precision UCS or 1/10 mm for a high precision UCS.

    Default XY Tolerance calculations

    For a ProjectedCoordinateSystem or an UnknownCoordinateSystem, the default tolerance is 1 mm (expressed in the units of the spatial reference) or 2.0 * XYResolution, whichever is larger. For a GeographicCoordinateSystem, it is the angle subtending 1 mm at the equator, or 2.0 * XYResolution, whichever is larger.
    The minimum allowable XYTolerance is 2.0 * XYResolution. If the default XY tolerance is not greater than or equal to 2.0 * XYResolution, the XYTolerance will be set at 2.0 * XYResolution.

    Product Availability

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

    Specified by:
    findSRByWKID in interface IGeometryServer
    Parameters:
    authority - The authority (in)
    wKID - The wKID (in)
    wKID_Z - The wKID_Z (in)
    bDefaultXYResolution - The bDefaultXYResolution (in)
    bDefaultXYTolerance - The bDefaultXYTolerance (in)
    Returns:
    A reference to a com.esri.arcgis.geometry.ISpatialReference
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    findSRByWKT

    public ISpatialReference findSRByWKT(String wKT,
                                         String wKT_Z,
                                         boolean bDefaultXYResolution,
                                         boolean bDefaultXYTolerance)
                                  throws IOException,
                                         AutomationException
    Defines a spatial reference object based upon its well known text string (WKT) and optionally a WKT for a vertical datum. The resolution and xy tolerances are either computed from the sr horizon or set to defaults. The output sr is always high precision.

    Remarks

    Finds a predefined spatial reference based on its OGC/EPSG definition string, otherwise known as its well-known text string (WKT). The text string contains individual parameters of a spatial reference. A valid spatial reference for a geographic coordinate system (GEOGCS) may appears as follows:

    GEOGCS["GCS_WGS_1984",DATUM["D_WGS_1984",SPHEROID["WGS_1984",6378137.0,298.257223563]],PRIMEM["Greenwich",0.0],UNIT["Degree",0.0174532925199433]]

    Note the nested structure of parameters includes a datum, spheriod, prime meridian, and angular unit.

    A valid spatial reference for a projected coordinate system (PROJCS) may appears as follows:


    PROJCS["World_Mercator",GEOGCS["GCS_WGS_1984",DATUM["D_WGS_1984",SPHEROID["WGS_1984",6378137.0,298.257223563]],PRIMEM["Greenwich",0.0],UNIT["Degree",0.0174532925199433]], PROJECTION["Mercator"],PARAMETER["False_Easting",0.0],PARAMETER["False_Northing",0.0],PARAMETER["Central_Meridian",0.0],PARAMETER["Standard_Parallel_1",0.0],UNIT["Meter",1.0]]]


    Note the nested structure of parameters includes a geographic coordinate system (GEOGCS), a projection, and a set of projection parameters such as false easting, false northing, and standard parallel.

    If WKT_Z is specified and not empty, then a vertical coordinate system will be created and associated with the horizontal coordinate system. The definition string can be generated from ArcObjects using the ExportToESRISpatialReference method on a PCS or GCS. The boolean parameters are as described for FindSRByWKID.

    Product Availability

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

    Specified by:
    findSRByWKT in interface IGeometryServer
    Parameters:
    wKT - The wKT (in)
    wKT_Z - The wKT_Z (in)
    bDefaultXYResolution - The bDefaultXYResolution (in)
    bDefaultXYTolerance - The bDefaultXYTolerance (in)
    Returns:
    A reference to a com.esri.arcgis.geometry.ISpatialReference
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    findUnitsByWKID

    public IUnit findUnitsByWKID(String authority,
                                 int wKID)
                          throws IOException,
                                 AutomationException
    Defines a unit object based upon its well known identified (WKID). 'authority' is typically either 'EPSG' or 'ESRI'.

    Remarks

    Finds a predefined linear or angular unit of measure based on its OGP/EPSG well known identifier (WKID, also referred to as “factory code”). AuthorityName is optional. If specified, it is usually either "EPSG" or "ESRI", but can also be an arbitrary string. As with spatial references, only the WKID value is used to locate the predefined unit. The WKIDs for predefined linear and angular units are listed here: esriSRUnit2Type, esriSRUnitType.

    The Unit returned is often used in other Geometry service methods such as Buffer.

    Product Availability

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

    Specified by:
    findUnitsByWKID in interface IGeometryServer
    Parameters:
    authority - The authority (in)
    wKID - The wKID (in)
    Returns:
    A reference to a com.esri.arcgis.geometry.IUnit
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    findUnitsByWKT

    public IUnit findUnitsByWKT(String wKT)
                         throws IOException,
                                AutomationException
    Defines a unit object based upon its well known text string.

    Remarks

    Finds a predefined linear or angular unit of measure based on its well known text string (WKT). The Unit returned is often used in other Geometry service methods such as Buffer.

    Here are some examples of WKT strings for linear and angular units.

    U.S. Survey Foot:

    
    UNIT["Foot_US",0.3048006096012192,AUTHORITY["EPSG",9003]]
    
    

    Arc-minute:

    
    UNIT["Minute",0.0002908882086657216,AUTHORITY["EPSG",9103]]
    
    

    Creating custom units

    You can create a custom unit in ArcObjects by using the ImportFromESRISpatialReference method on an existing linear or angular unit object. Web service clients can do this by creating a LinearUnit or AngularUnit value first and then assigning the WKT string to the WKT property of the value. The example script in this topic illustrates the former approach and the example provided in the IGeometryServer topic illustrates the latter.

    Product Availability

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

    Specified by:
    findUnitsByWKT in interface IGeometryServer
    Parameters:
    wKT - The wKT (in)
    Returns:
    A reference to a com.esri.arcgis.geometry.IUnit
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    getAreasAndLengths

    public void getAreasAndLengths(ISpatialReference pSR,
                                   IPolygonArray pInPolygons,
                                   IDoubleArray[] ppAreas,
                                   IDoubleArray[] ppLengths)
                            throws IOException,
                                   AutomationException
    Calculates areas and perimeter lengths for each polygon in the specified array.

    Remarks

    All geometries are assumed to be defined in the spatial reference pSR, which cannot be nil. The area and length values are computed in that spatial reference. It is not recommended that this method be used on geometries associated with a geographic coordinate system, since the length would then be calculated in units of "degrees" and the area would be calculated in units of "square degrees".

    Refer to IGeometryServer for additional details on how the input spatial reference is interpreted.

    Product Availability

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

    Specified by:
    getAreasAndLengths in interface IGeometryServer
    Parameters:
    pSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
    pInPolygons - A reference to a com.esri.arcgis.geometry.IPolygonArray (in)
    ppAreas - A reference to a com.esri.arcgis.system.IDoubleArray (out: use single element array)
    ppLengths - A reference to a com.esri.arcgis.system.IDoubleArray (out: use single element array)
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    getLengths

    public IDoubleArray getLengths(ISpatialReference pSR,
                                   IPolylineArray pInPolylines)
                            throws IOException,
                                   AutomationException
    Calculates the length of eacch polyline in the specified array.

    Remarks

    All geometries are assumed to be defined in the spatial reference pSR, which cannot be nil. The length values are computed in that spatial reference. It is not recommended that this method be used on geometries associated with a geographic coordinate system, since the length would then be calculated in units of "degrees". You can use the GetLengthsGeodesic method to compute accurate lengths for polylines with latitude-longitude coordinates.

    Refer to IGeometryServer for additional details on how the input spatial reference is interpreted.

    Product Availability

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

    Specified by:
    getLengths in interface IGeometryServer
    Parameters:
    pSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
    pInPolylines - A reference to a com.esri.arcgis.geometry.IPolylineArray (in)
    Returns:
    A reference to a com.esri.arcgis.system.IDoubleArray
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    getLabelPoints

    public IPointArray getLabelPoints(ISpatialReference pSR,
                                      IPolygonArray pInPolygons)
                               throws IOException,
                                      AutomationException
    Calculates an interior point for each polygon.

    Remarks

    Generates one point geometry per input polygon. Each point is guaranteed to be inside its corresponding polygon. The ArcObjects IArea::LabelPoint property is used to generate the output points. All input geometries are assumed to be defined in the input spatial reference pSR. pSR cannot be nil.

    Product Availability

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

    Specified by:
    getLabelPoints in interface IGeometryServer
    Parameters:
    pSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
    pInPolygons - A reference to a com.esri.arcgis.geometry.IPolygonArray (in)
    Returns:
    A reference to a com.esri.arcgis.geometry.IPointArray
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    getAreasAndLengths2

    public void getAreasAndLengths2(ISpatialReference pSR,
                                    IPolygonArray pInPolygons,
                                    ILinearUnit pLengthUnit,
                                    ILinearUnit pAreaUnit,
                                    int areaUnitEnum,
                                    IDoubleArray[] ppAreas,
                                    IDoubleArray[] ppLengths)
                             throws IOException,
                                    AutomationException
    Calculates areas and perimeter lengths for each polygon in the specified array. Optionally does unit conversion.

    Remarks

    The area and length values are computed in the units specified as input parameters, if they are present, otherwise they are computed in the units of the spatial reference. It is not recommended that this method be used on geometries having latitude-longitude coordinates. You can use the GetLengthsGeodesic method to compute accurate lengths for polylines with latitude-longitude coordinates.

    Product Availability

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

    Specified by:
    getAreasAndLengths2 in interface IGeometryServer2
    Parameters:
    pSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
    pInPolygons - A reference to a com.esri.arcgis.geometry.IPolygonArray (in)
    pLengthUnit - A reference to a com.esri.arcgis.geometry.ILinearUnit (in)
    pAreaUnit - A reference to a com.esri.arcgis.geometry.ILinearUnit (in)
    areaUnitEnum - A com.esri.arcgis.system.esriAreaUnits constant (in)
    ppAreas - A reference to a com.esri.arcgis.system.IDoubleArray (out: use single element array)
    ppLengths - A reference to a com.esri.arcgis.system.IDoubleArray (out: use single element array)
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    getLengths2

    public IDoubleArray getLengths2(ISpatialReference pSR,
                                    IPolylineArray pInPolylines,
                                    ILinearUnit pLengthUnit)
                             throws IOException,
                                    AutomationException
    Calculates the length of eacch polyline in the specified array. Optionally does unit conversion.

    Remarks

    The length values are computed in the specified linear units, if present, or in the units of the spatial reference. It is not recommended that this method be used on geometries having latitude-longitude coordinates, since the length would then be calculated in units of "degrees". You can use the GetLengthsGeodesic method to compute accurate lengths for polylines with latitude-longitude coordinates.

    Product Availability

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

    Specified by:
    getLengths2 in interface IGeometryServer2
    Parameters:
    pSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
    pInPolylines - A reference to a com.esri.arcgis.geometry.IPolylineArray (in)
    pLengthUnit - A reference to a com.esri.arcgis.geometry.ILinearUnit (in)
    Returns:
    A reference to a com.esri.arcgis.system.IDoubleArray
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    densifyGeodesic

    public IGeometryArray densifyGeodesic(ISpatialReference pSR,
                                          IGeometryArray pInGeometries,
                                          double maxSegmentLength,
                                          ILinearUnit pLengthUnit)
                                   throws IOException,
                                          AutomationException
    Densifies geometries by plotting points along the geodesics between existing vertices (uses IPolycurve4::GeodesicDensify).

    Remarks

    Densifies each polyline or polygon in the input array by plotting points along the geodesic paths between existing vertices. MaxSegmentLength is expressed in some linear unit of measure. If the LengthUnit parameter is specified, then MaxSegmentLength is expressed in those units. If the LengthUnit parameter is not specified, then MaxSegmentLength is expressed in the the linear units of the input spatial reference, if the spatial reference is a projected coordinate system. Otherwise, it is assumed to be expressed in meters.

    If the spatial reference is a projected coordinate system, then the input geometries will be inversed projected, geodesic path points will be plotted, and the result will be forward projected into the same spatial reference.

    The figure below illustrates the DensifyGeodesic operation applied to a polyline with 3 vertices, with a max output segment length of 10,000 meters.

    DensifyGeodesic

    Product Availability

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

    Specified by:
    densifyGeodesic in interface IGeometryServer2
    Parameters:
    pSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
    pInGeometries - A reference to a com.esri.arcgis.geometry.IGeometryArray (in)
    maxSegmentLength - The maxSegmentLength (in)
    pLengthUnit - A reference to a com.esri.arcgis.geometry.ILinearUnit (in)
    Returns:
    A reference to a com.esri.arcgis.geometry.IGeometryArray
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    getLengthsGeodesic

    public IDoubleArray getLengthsGeodesic(ISpatialReference pSR,
                                           IPolylineArray polylines,
                                           ILinearUnit pLengthUnit)
                                    throws IOException,
                                           AutomationException
    Returns geodesic length of each Polyline.

    Remarks

    The returned lengths are expressed in the specified linear units, if present, or in the units of the spatial reference. If LengthUnit is not specified and the input spatial reference is a geographic coordinate system, then the lengths are expressed in meters. This method calculates the ellipsoidal shortest path distance between each pair of the vertices in the polylines.

    The spatial reference can be a projected or a geographic coordinate system. If the former, then the geometries are first inverse projected into its associated geographic coordinate system and then the distance calculations are performed.

    Product Availability

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

    Specified by:
    getLengthsGeodesic in interface IGeometryServer2
    Parameters:
    pSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
    polylines - A reference to a com.esri.arcgis.geometry.IPolylineArray (in)
    pLengthUnit - A reference to a com.esri.arcgis.geometry.ILinearUnit (in)
    Returns:
    A reference to a com.esri.arcgis.system.IDoubleArray
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    getDistance

    public double getDistance(ISpatialReference pSR,
                              IGeometry pG1,
                              IGeometry pG2,
                              ILinearUnit pDistanceUnit)
                       throws IOException,
                              AutomationException
    Reports shortest distance between G1 and G2.

    Remarks

    The distance value is computed in the specified linear units, if present, or in the units of the spatial reference. It is not recommended that this method be used on geometries with lat-long coordinates. Use GetDistanceGeodesic instead.

    Product Availability

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

    Specified by:
    getDistance in interface IGeometryServer2
    Parameters:
    pSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
    pG1 - A reference to a com.esri.arcgis.geometry.IGeometry (in)
    pG2 - A reference to a com.esri.arcgis.geometry.IGeometry (in)
    pDistanceUnit - A reference to a com.esri.arcgis.geometry.ILinearUnit (in)
    Returns:
    The pDistance
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    union

    public IGeometry union(ISpatialReference pSR,
                           IGeometryArray pInGA)
                    throws IOException,
                           AutomationException
    Returns the topological union of the input geometries (uses ITopologicalOperator::ConstructUnion). The input geometries must have the same dimension (0d, 1d, 2d).

    Remarks

    This operation constructs the set-theoretic union of the geometries in the input array. All inputs must be of the same type.

    Union

    Product Availability

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

    Specified by:
    union in interface IGeometryServer2
    Parameters:
    pSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
    pInGA - A reference to a com.esri.arcgis.geometry.IGeometryArray (in)
    Returns:
    A reference to a com.esri.arcgis.geometry.IGeometry
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    intersect

    public IGeometryArray intersect(ISpatialReference pSR,
                                    IGeometryArray pInGA1,
                                    IGeometry pInG2)
                             throws IOException,
                                    AutomationException
    Returns an array of geometries where each result geometry R[i] is (array1[i] intersect G2. If G2 is an Envelope, then this is clipping.

    Remarks

    This operation constructs the set-theoretic intersection between each element of the input array and InGeometry2. Each result is placed at the corresponding index in the output array – that is, Result[i] = InGeometryArray1[i] Intersect InGeometry2. If inGeometryArray1[i] and InGeometry2 disjoint, the output is an empty geometry of the type with the minimum dimension between inGeometryArray1[i] and InGeometry2.

    The figure below shows an example of the intersect operation. The input geometry array contains all geometries shown on the left of the figure with the exception of the central circular polygon. The output array contains the modified geometries shown in the right part of the figure. Note that two of the output points will be “empty” because their corresponding inputs are outside the circular polygon.

    Intersect

    Product Availability

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

    Specified by:
    intersect in interface IGeometryServer2
    Parameters:
    pSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
    pInGA1 - A reference to a com.esri.arcgis.geometry.IGeometryArray (in)
    pInG2 - A reference to a com.esri.arcgis.geometry.IGeometry (in)
    Returns:
    A reference to a com.esri.arcgis.geometry.IGeometryArray
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    difference

    public IGeometryArray difference(ISpatialReference pSR,
                                     IGeometryArray pInGA1,
                                     IGeometry pInG2)
                              throws IOException,
                                     AutomationException
    Returns an array of geometries where each result geometry R[i] is (array1[i] difference G2).

    Remarks

    This operation constructs the set-theoretic difference between each element of the input array and InGeometry2. Each result is placed at the corresponding index in the output array – that is, Result[i] = InGeometryArray1[i] Difference InGeometry2. The only restriction on combinations of geometry types is that the dimension of InGeometry2 must be equal to or greater than the dimensions of the elements of InGeometryArray1. Any inputs that are completely within InGeometry2 are represented by empty geometries of the same type in the output array.

    The figure below shows an example of the difference operation. The geometry array contains all geometries shown with the exception of the central circular polygon. The output array contains the modified geometries shown in the right part of the figure. Note that one of the output points will be “empty” because the corresponding input is inside the circular polygon.

    Difference

    Product Availability

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

    Specified by:
    difference in interface IGeometryServer2
    Parameters:
    pSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
    pInGA1 - A reference to a com.esri.arcgis.geometry.IGeometryArray (in)
    pInG2 - A reference to a com.esri.arcgis.geometry.IGeometry (in)
    Returns:
    A reference to a com.esri.arcgis.geometry.IGeometryArray
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    cut

    public IGeometryArray cut(ISpatialReference pSR,
                              IGeometryArray pTargets,
                              IPolyline pCutter,
                              ILongArray[] ppCutIndexes)
                       throws IOException,
                              AutomationException
    Cuts the target polyline or polygon Cutter.

    Remarks

    The target of the cut operation may be either a polyline or a polygon.

    When it is a polyline, it is split where it intersects the cutter polyline. Each piece is classified as ‘left of’ or ‘right of’ the cutter. This classification is based on the orientation of the cutter line. The left pieces are returned in the first element of the output array and the right pieces are returned in the second element. Parts of the target polyline that do not intersect the cutting polyline are discarded. Figure below shows an example. The orientation of the cutter line is indicated with a red arrowhead. Notice that a polyline part is also cut when the cutter line just touches it (as opposed to crossing it). The lower right input part was not included in the output because it did not intersect the cutting line. The cutting line can also have multiple parts. The left/right decision is made per part.

    Cut1

    The next figure shows an example of a cutting operation with a multipart cutting polyline. The orientation of each cutting part is shown with a red arrowhead. The ‘left’ result has been requested and is shown in the right box of the figure.

    Cut2

    When the target is a polygon, the left/right classification it not done. The polygon pieces are returned in order of ascending area. In the figure below, the first cut part returned is to the right of the oriented cutting line, but it has the smallest area. Input parts that do not intersect the cutting line are discarded. The cutting line can be multi-part. See figure below.

    Cut3

    Product Availability

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

    Specified by:
    cut in interface IGeometryServer2
    Parameters:
    pSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
    pTargets - A reference to a com.esri.arcgis.geometry.IGeometryArray (in)
    pCutter - A reference to a com.esri.arcgis.geometry.IPolyline (in)
    ppCutIndexes - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)
    Returns:
    A reference to a com.esri.arcgis.geometry.IGeometryArray
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    trimExtend

    public IPolylineArray trimExtend(ISpatialReference pSR,
                                     IPolylineArray pInPA,
                                     IPolyline pTrimExtendTo,
                                     int extendHow)
                              throws IOException,
                                     AutomationException
    Trims or extends each polyline in the input array using TrimExtendTo (uses IConstructCurve::ConstructExtended for extension operation).

    Remarks

    Trims (cuts) polylines that intersect the trim-extend line, or extends polylines to it that don’t intersect it. See the figure below for some examples. The details of how polylines are extended can be controlled by adding together combinations of the values listed in the table below.

    values to be used with the trim-extend operation

    Constant

    Value

    Description

    esriDefaultCurveExtension

    0

    By default, extension considers both ends of paths. The old ends remain and new points are added at the extended ends. The new points have attributes that are extrapolated from adjacent existing segments.

    esriRelocateEnds

    1

    If an extension is performed at an end, relocate the end point to the new position instead of leaving the old point and adding a new point at the new position.

    esriKeepEndAttributes

    2

    If an extension is performed at an end, do not extrapolate the end-segment's attributes for the new point. Instead, make its attributes the same as the current end. Incompatible with esriNoAttributes.

    esriNoEndAttributes

    4

    If an extension is performed at an end, do not extrapolate the end-segment's attributes for the new point. Instead, make its attributes be empty. Incompatible with esriKeepAttributes.

    esriNoExtendAtFrom

    8

    Do not extend the 'from' end of any path.

    esriNoExtendAtTo

    16

    Do not extend the 'to' end of any path.

    TrimExtend

    Product Availability

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

    Specified by:
    trimExtend in interface IGeometryServer2
    Parameters:
    pSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
    pInPA - A reference to a com.esri.arcgis.geometry.IPolylineArray (in)
    pTrimExtendTo - A reference to a com.esri.arcgis.geometry.IPolyline (in)
    extendHow - The extendHow (in)
    Returns:
    A reference to a com.esri.arcgis.geometry.IPolylineArray
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    offset

    public IGeometryArray offset(ISpatialReference pSR,
                                 IGeometryArray pInGA,
                                 double offsetDistance,
                                 ILinearUnit pOffsetUnit,
                                 int offsetHow,
                                 double bevelRatio)
                          throws IOException,
                                 AutomationException
    Returns an array of polylines and polygons that are offset versions of the input polylines and polygons (uses ITopologicalOperator::ConstructOffset).

    Remarks

    The offset operation creates a geometry that is a constant distance from an input polyline or polygon. It is similar to buffering, but produces a one sided result. If offsetDistance > 0, then the offset geometry is constructed to the right of the oriented input geometry, otherwise it is constructed to the left. For a polygon, the orientation of outer rings is clockwise and for inner rings it is counter clockwise. So the “right side” of a polygon is always its inside.

    bevelRatio is multiplied by the offset distance and the result determines how far a mitered offset intersection can be from the input curve before it is beveled or rounded. When esriGeometryOffsetMitered is specified, the input bevel ratio is ignored and 10 is used internally.When esriGeometryOffsetBevelled is specified, 1.1 will be used if bevelRatio is not specified.

    The figures below show some examples of offsetting polylines. The red arrowhead shows the orientation of the input polyline.

    Offset

    Product Availability

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

    Specified by:
    offset in interface IGeometryServer2
    Parameters:
    pSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
    pInGA - A reference to a com.esri.arcgis.geometry.IGeometryArray (in)
    offsetDistance - The offsetDistance (in)
    pOffsetUnit - A reference to a com.esri.arcgis.geometry.ILinearUnit (in)
    offsetHow - The offsetHow (in)
    bevelRatio - The bevelRatio (in)
    Returns:
    A reference to a com.esri.arcgis.geometry.IGeometryArray
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    generalize

    public IGeometryArray generalize(ISpatialReference pSR,
                                     IGeometryArray pInGA,
                                     double maxDeviation,
                                     ILinearUnit pDeviationUnit)
                              throws IOException,
                                     AutomationException
    Returns generalized (Douglas-Poiker) versions of the input polylines and polygons (uses IPolycurve::Generalize).

    Remarks

    The Generalize operation applies Douglas-poiker line generalization to each element of the input array. The results are placed in corresponding indexes of the output array. If DeviationUnit is specified, then MaxDeviation is expressed in those units, otherwise it is expressed in the units of the spatial reference.

    Product Availability

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

    Specified by:
    generalize in interface IGeometryServer2
    Parameters:
    pSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
    pInGA - A reference to a com.esri.arcgis.geometry.IGeometryArray (in)
    maxDeviation - The maxDeviation (in)
    pDeviationUnit - A reference to a com.esri.arcgis.geometry.ILinearUnit (in)
    Returns:
    A reference to a com.esri.arcgis.geometry.IGeometryArray
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    reshape

    public IGeometry reshape(ISpatialReference pSR,
                             IGeometry pTarget,
                             IPolyline pReshaper)
                      throws IOException,
                             AutomationException
    Reshapes the target polyline or polygon. The reshaping polyline can have only one part. If the target was not reshaped, an empty geometry of the saem type is returned.

    Remarks

    Reshapes the target polyline or polygon. The reshaping polyline can have only one part. If the reshaper does not intersect the target polyline, or does not define a closed loop for the target polygon, then an empty geometry of the same type as the target geometry is returned. The orientation of the reshaper is not considered. The following rules for polygon and polyline reshaping are used:

    Polygons:. only one ring (part) is explicitly reshaped – the first one in index order that intersects the reshaping path. The longest portion of the original ring boundary is preserved. The reshaped polygon is re-simplified after the reshape operation has been applied, so the rules for simplification will determine what happens if multiple rings interact with the reshaping path. The graphics show how preserving the longest portion of the boundary can invert the ring in some cases. If more complicated reshaping behavior is desired, a combination of auto-complete, cutting and union can be used.

    Reshape1

    Polylines: multiple paths (parts) can be affected by the reshaping path. The following graphics show three cases. The polyline being reshaped has part sequence and part orientations shown in red in the upper left graphic. The reshape is shown on the left of each row. The result is shown on the right of each row.

    Reshape2

    Product Availability

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

    Specified by:
    reshape in interface IGeometryServer2
    Parameters:
    pSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
    pTarget - A reference to a com.esri.arcgis.geometry.IGeometry (in)
    pReshaper - A reference to a com.esri.arcgis.geometry.IPolyline (in)
    Returns:
    A reference to a com.esri.arcgis.geometry.IGeometry
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    convexHull

    public IGeometry convexHull(ISpatialReference pSR,
                                IGeometryArray pInGeometryArray)
                         throws IOException,
                                AutomationException
    Computes the convex hull of the input geometries

    Remarks

    The convex hull of a set of points, polylines and polygons is shown below. If all the inputs are collinear, than a polyline will be returned instead of a polygon. If all inputs are located at a single point, then that point will be returned.

    ConvexHull.jpg

    Product Availability

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

    Specified by:
    convexHull in interface IGeometryServer2
    Parameters:
    pSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
    pInGeometryArray - A reference to a com.esri.arcgis.geometry.IGeometryArray (in)
    Returns:
    A reference to a com.esri.arcgis.geometry.IGeometry
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    autoComplete

    public IPolygonArray autoComplete(ISpatialReference pSR,
                                      IPolygonArray pInPolygons,
                                      IPolylineArray pCompletionLines)
                               throws IOException,
                                      AutomationException
    Discovers polygons bounded by existing polygons and input linework.

    Product Availability

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

    Specified by:
    autoComplete in interface IGeometryServer2
    Parameters:
    pSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
    pInPolygons - A reference to a com.esri.arcgis.geometry.IPolygonArray (in)
    pCompletionLines - A reference to a com.esri.arcgis.geometry.IPolylineArray (in)
    Returns:
    A reference to a com.esri.arcgis.geometry.IPolygonArray
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    getDistanceGeodesic

    public double getDistanceGeodesic(ISpatialReference pSR,
                                      IGeometry pG1,
                                      IGeometry pG2,
                                      ILinearUnit pDistanceUnit)
                               throws IOException,
                                      AutomationException
    Reports the shortest geodesic distance between G1 and G2.

    Remarks

    The distance value is computed in the specified linear units, if present, or in the units of the spatial reference. If SpatialReference is a projected coordinate system, the input geometries will first be inverse projected and then shortest geodesic distance will be computed on the latitude-longitude coordinates.

    Product Availability

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

    Specified by:
    getDistanceGeodesic in interface IGeometryServer2
    Parameters:
    pSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
    pG1 - A reference to a com.esri.arcgis.geometry.IGeometry (in)
    pG2 - A reference to a com.esri.arcgis.geometry.IGeometry (in)
    pDistanceUnit - A reference to a com.esri.arcgis.geometry.ILinearUnit (in)
    Returns:
    The pDistanceGeodesic
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.