com.esri.arcgis.datainterop
Class FMECursorHelper

java.lang.Object
  com.esri.arcgis.datainterop.FMECursorHelper

All Implemented Interfaces:

IPlugInCursorHelper, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, Serializable

public class FMECursorHelper
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IPlugInCursorHelper, ISupportErrorInfo

FMECursorHelper Class

Product Availability

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

See Also:

Serialized Form

Constructor Summary

FMECursorHelper()
Constructs a FMECursorHelper using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isFinished() Returns True if there are no more records in the record set.
void	nextRecord() Gets the next row in the record set.
void	queryShape(IGeometry pGeometry) Gets the geometry of the current record.
int	queryValues(IRowBuffer row) Gets the values for the non-geometry fields in the current record.

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

FMECursorHelper

public FMECursorHelper()
                throws IOException,
                       UnknownHostException

Constructs a FMECursorHelper using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

FMECursorHelper

public FMECursorHelper(Object obj)
                throws IOException

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

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

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

nextRecord

public void nextRecord()
                throws IOException,
                       AutomationException

Gets the next row in the record set.

Description

NextRecord advances the cursor helper to represent the next record in the collection. Calling this method repeatedly should get all the records in the results without getting any record twice. This method fails when there are no more records left to get.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

nextRecord in interface IPlugInCursorHelper

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFinished

public boolean isFinished()
                   throws IOException,
                          AutomationException

Returns True if there are no more records in the record set.

Description

Returns true if there are no more records to get from the cursor. IsFinished is called any time that NextRecord fails.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isFinished in interface IPlugInCursorHelper

Returns:

The finished

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryValues

public int queryValues(IRowBuffer row)
                throws IOException,
                       AutomationException

Gets the values for the non-geometry fields in the current record.

Description

Copies data from the current record into the row that is passed in. The method should get the field-set from the row buffer. The field map passed to the Fetch method determines which fields will be copied. For each field in the field set, the data should be copied only if the corresponding value in the field map is not -1.

However, the shape and object ID fields should NOT be copied. The shape field is handled separately in QueryShape. The object ID cannot be set through the IRowBuffer interface. Instead, the object ID should be the return value of QueryValues.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

queryValues in interface IPlugInCursorHelper

Parameters:

row - A reference to a com.esri.arcgis.geodatabase.IRowBuffer (in)

Returns:

The oID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryShape

public void queryShape(IGeometry pGeometry)
                throws IOException,
                       AutomationException

Gets the geometry of the current record.

Description

QueryShape uses the data in the shape field of the current record to populate the geometry. If anything goes wrong, the geometry should be set empty.

This method should not allocate memory. For simple shapes you can reset the contents of the supplied geometry object. For data sources with complex shapes it is more efficient to use the AttachtoESRIShape method on IESRIShape to attach a shape buffer to the geometry. This shape buffer should be reused for each geometry. For information on the shape buffer, see the white paper on shapefiles, which use the same shape format, found at http://www.esri.com/library/whitepapers/pdfs/shapefile.pdf.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

queryShape in interface IPlugInCursorHelper

Parameters:

pGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (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.