com.esri.arcgis.geometry
Class IRingProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.geometry.IGeometryProxy
          com.esri.arcgis.geometry.ICurveProxy
              com.esri.arcgis.geometry.IPathProxy
                  com.esri.arcgis.geometry.IRingProxy

All Implemented Interfaces:

java.io.Externalizable, ICurve, IGeometry, IPath, IRing, java.io.Serializable

Direct Known Subclasses:

IRing2Proxy

public class IRingProxy

extends IPathProxy

implements IRing, java.io.Serializable

Provides access to members that identify a ring and define its behavior.

Product Availability

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

See Also:

Serialized Form

Field Summary

static java.lang.Class

targetClass

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF

Constructor Summary

	IRingProxy() For internal use only
	IRingProxy(java.lang.Object obj)
protected	IRingProxy(java.lang.Object obj, java.lang.String iid)
	IRingProxy(java.lang.String CLSID, java.lang.String host, AuthInfo authInfo)
protected	IRingProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, AuthInfo authInfo)

Method Summary

void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource) Adds a Java object to be a listener for a specific kind of event generated by the COM object.
void	close() Makes sure that this ring is closed by adding a line segment between the ring's 'to' and 'from' points if necessary.
ICurve	getSubcurveEx(double fromDistance, double toDistance, boolean asRatio, boolean isCCW, boolean useRingOrientation) Extracts a portion of this curve into a new curve.
boolean	isExterior() Indicates if this ring can function as the exterior ring in a polygon (ring orientation is clockwise, area > 0).
void	removeListener(java.lang.String iidStr, java.lang.Object theListener) Removes a Java object as a listener to events generated by a COM object.
boolean	reshape(IPath reshapeSource) Modifies this ring by replacing some of its segments with some segments from reshapeSource.

Methods inherited from class com.esri.arcgis.geometry.IPathProxy

generalize, queryChordLengthTangents, setChordLengthTangents, smooth, smoothLocal

Methods inherited from class com.esri.arcgis.geometry.ICurveProxy

getFromPoint, getLength, getSubcurve, getToPoint, isClosed, queryFromPoint, queryNormal, queryPoint, queryPointAndDistance, queryTangent, queryToPoint, reverseOrientation, setFromPoint, setToPoint

Methods inherited from class com.esri.arcgis.geometry.IGeometryProxy

geoNormalize, geoNormalizeFromLongitude, getDimension, getEnvelope, getGeometryType, getSpatialReference, isEmpty, project, queryEnvelope, setEmpty, setSpatialReferenceByRef, snapToSpatialReference

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, hashCode, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, readExternal, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.esri.arcgis.geometry.IPath

generalize, queryChordLengthTangents, setChordLengthTangents, smooth, smoothLocal

Methods inherited from interface com.esri.arcgis.geometry.ICurve

getFromPoint, getLength, getSubcurve, getToPoint, isClosed, queryFromPoint, queryNormal, queryPoint, queryPointAndDistance, queryTangent, queryToPoint, reverseOrientation, setFromPoint, setToPoint

Methods inherited from interface com.esri.arcgis.geometry.IGeometry

geoNormalize, geoNormalizeFromLongitude, getDimension, getEnvelope, getGeometryType, getSpatialReference, isEmpty, project, queryEnvelope, setEmpty, setSpatialReferenceByRef, snapToSpatialReference

Field Detail

targetClass

public static final java.lang.Class targetClass

Constructor Detail

IRingProxy

public IRingProxy(java.lang.String CLSID,
                  java.lang.String host,
                  AuthInfo authInfo)
           throws java.net.UnknownHostException,
                  java.io.IOException

IRingProxy

public IRingProxy()

For internal use only

IRingProxy

public IRingProxy(java.lang.Object obj)
           throws java.io.IOException

IRingProxy

protected IRingProxy(java.lang.Object obj,
                     java.lang.String iid)
              throws java.io.IOException

IRingProxy

protected IRingProxy(java.lang.String CLSID,
                     java.lang.String iid,
                     java.lang.String host,
                     AuthInfo authInfo)
              throws java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Description copied from class: Dispatch

Adds a Java object to be a listener for a specific kind of event generated by the COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:

addListener in class IPathProxy

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Description copied from class: Dispatch

Removes a Java object as a listener to events generated by a COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:

removeListener in class IPathProxy

Throws:

java.io.IOException

isExterior

public boolean isExterior()
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IRing

Indicates if this ring can function as the exterior ring in a polygon (ring orientation is clockwise, area > 0).

Specified by:

isExterior in interface IRing

Returns:

The isExterior

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

reshape

public boolean reshape(IPath reshapeSource)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IRing

Modifies this ring by replacing some of its segments with some segments from reshapeSource.

Supported Platforms

Windows, Solaris, Linux

Description

Reshape replaces the Segments in the Ring between consecutive Intersections with the input Path segments that connect those intersections. Reshape returns a boolean indicating whether or not a modification to the Ring occurred.

Remarks

To Reshape a Polygon, the Polygon must be Reshaped one Ring at a time.

Specified by:

reshape in interface IRing

Parameters:

reshapeSource - A reference to a com.esri.arcgis.geometry.IPath (in)

Returns:

The reshapeHappened

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

close

public void close()
           throws java.io.IOException,
                  AutomationException

Description copied from interface: IRing

Makes sure that this ring is closed by adding a line segment between the ring's 'to' and 'from' points if necessary.

Supported Platforms

Windows, Solaris, Linux

Description

Checks whether or not the From and To Points of the Path occur at the same Point. If the From and To Point have the same X and Y coordinates, the Ring is considered closed, and no action is taken. However, if the From and To Points are not at the same X and Y coordinates, a Line segment is added at the end of the Ring between the To Point and the From Point. This Line segment completes the Ring making it closed.

Specified by:

close in interface IRing

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubcurveEx

public ICurve getSubcurveEx(double fromDistance,
                            double toDistance,
                            boolean asRatio,
                            boolean isCCW,
                            boolean useRingOrientation)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IRing

Extracts a portion of this curve into a new curve. The interior of the new curve may contain the from/to point of the ring when useRingOrientation is true.

Supported Platforms

Windows, Solaris, Linux

Description

The GetSubCurveEx method creates a subcurve of a ring. The subcurve may include the ring origin. The result is always a path object which may be closed.

Remarks

Parameters description:

fromDistance: (Input) A double that represents the distance along the curve which will define one of the subcurve's endpoints. The value can be positive or negative.

toDistance: (Input) A double that represents the distance along the curve which will define the other endpoint of the subcurve. The value can be positive or negative.

If the fromDistance and toDistance values are equal, the output is a closed path with fromPoint and toPoint of the path at the specified distance. The orientation may be reversed, depending upon the other parameter settings.

asRatio: (Input) A boolean value that determines whether or not the input distances are interpreted as a ratio of the total length. If 'True', a fromDistance of 0 is at the beginning of the curve and a toDistance of 1 represents the end of the curve.

isCCW: (Input) A boolean expression that decides which of the two possible paths fromfromDistance to toDistance is chosen for output: counter-clockwise or not. This does not decide the orientation of the output path.

useRingOrientation: (Input) A boolean that determines whether the output path should follow the ring orientation or not. If bUseRingOrientation is true, the output subcurve must have the same orientation as the ring, even if it means that the subcurve starts at toDistance and ends at fromDistance. If bUseRingOrientation is false, the output subcurve always starts at fromDistance and ends at toDistance; it may have the opposite orientation as the original ring.

Specified by:

getSubcurveEx in interface IRing

Parameters:

fromDistance - The fromDistance (in)

toDistance - The toDistance (in)

asRatio - The asRatio (in)

isCCW - The isCCW (in)

useRingOrientation - The useRingOrientation (in)

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.