com.esri.arcgis.geodatabase
Class EnumFeatureGeometry

java.lang.Object
  extended by com.esri.arcgis.geodatabase.EnumFeatureGeometry
All Implemented Interfaces:
IEnumGeometryBind, IEnumGeometry, com.esri.arcgis.interop.RemoteObjRef, IClone, ISupportErrorInfo, Serializable

public class EnumFeatureGeometry
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IEnumGeometry, IEnumGeometryBind, IClone, ISupportErrorInfo

ESRI enumerator for geometries of a feature class or selection set.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
EnumFeatureGeometry()
          Constructs a EnumFeatureGeometry using ArcGIS Engine.
EnumFeatureGeometry(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
EnumFeatureGeometry theEnumFeatureGeometry = (EnumFeatureGeometry) obj;
 
Method Summary
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 void bindGeometrySource(IQueryFilter outputFilter, Object collectionSource)
          Bind the source of the geometry to the enumeration.
 boolean equals(Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
static String getClsid()
          getClsid.
 int getCount()
          The number of geometries in the enumeration.
 void getGeometrySource(Object[] geometrySource)
          The geometry source - either a feature class or a selection set.
 void getOutputFilter(IQueryFilter outputFilter)
          The query filter that was used to bind the geometry source.
 int hashCode()
          the hashcode for this object
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 boolean isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 IGeometry next()
          Returns the next geometry in the enumeration.
 void reset()
          Starts the enumeration at the beginning.
 
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

EnumFeatureGeometry

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

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

EnumFeatureGeometry

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

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

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

next

public IGeometry next()
               throws IOException,
                      AutomationException
Returns the next geometry in the enumeration.

Description

Returns the Next Geometry part from the current enumeration location.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
next in interface IEnumGeometry
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.

reset

public void reset()
           throws IOException,
                  AutomationException
Starts the enumeration at the beginning.

Description

Resets the current enumeration location to the null pointer at the beginning of the enumeration such that the Next Geometry is the first Geometry part in the enumeration.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getCount

public int getCount()
             throws IOException,
                    AutomationException
The number of geometries in the enumeration.

Description

Returns the number of distinct geometry parts in the enumeration. This count is the same as the count returned by GeometryCount in a GeometryCollection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCount in interface IEnumGeometry
Returns:
The geometryCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

bindGeometrySource

public void bindGeometrySource(IQueryFilter outputFilter,
                               Object collectionSource)
                        throws IOException,
                               AutomationException
Bind the source of the geometry to the enumeration.

Description

This method binds the enumerator to a geometry source (a feature class or a selection set). After this method has been invoked on an object, the object can be cast to the IEnumGeometry interface in order to iterate through the geometries of the source.

Remarks

A query filter should always be provided to the OutputFilter parameter. Passing a null value will not result in an error, but when using this interface the only field that can be inspected from returned features is the geometry field, and the query filter should reflect this. The associated example demonstrates how to do this.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
bindGeometrySource in interface IEnumGeometryBind
Parameters:
outputFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
collectionSource - A reference to another Object (IUnknown) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGeometrySource

public void getGeometrySource(Object[] geometrySource)
                       throws IOException,
                              AutomationException
The geometry source - either a feature class or a selection set.

Product Availability

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

Specified by:
getGeometrySource in interface IEnumGeometryBind
Parameters:
geometrySource - A reference to another Object (IUnknown) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOutputFilter

public void getOutputFilter(IQueryFilter outputFilter)
                     throws IOException,
                            AutomationException
The query filter that was used to bind the geometry source.

Product Availability

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

Specified by:
getOutputFilter in interface IEnumGeometryBind
Parameters:
outputFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException
Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:
esri_clone in interface IClone
Returns:
A reference to a com.esri.arcgis.system.IClone
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException
Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException
Returns TRUE when the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isEqual in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The equal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException
Returns TRUE when the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isIdentical in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The identical
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.