com.esri.arcgis.geodatabase
Class IPlugInCursorHelperProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.geodatabase.IPlugInCursorHelperProxy

All Implemented Interfaces:

IPlugInCursorHelper, java.io.Externalizable, java.io.Serializable

public class IPlugInCursorHelperProxy
extends com.esri.arcgis.interop.Dispatch
implements IPlugInCursorHelper, java.io.Serializable

Internal use class Proxy for COM Interface 'IPlugInCursorHelper'. Generated 3/19/2015 1:20:54 PM from 'C:\ArcGIS\COM\esriGeoDatabase.olb'

Description: 'Provides access to members that help the Plug-In cursor.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

boolean	noncastable
static java.lang.Class	targetClass

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

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IPlugInCursorHelperProxy() For internal use only
	IPlugInCursorHelperProxy(java.lang.Object obj)
protected	IPlugInCursorHelperProxy(java.lang.Object obj, java.lang.String iid)
	IPlugInCursorHelperProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
protected	IPlugInCursorHelperProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)

Method Summary

void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
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.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener)

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

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

Methods inherited from class java.lang.Object

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

Field Detail

targetClass

public static final java.lang.Class targetClass

noncastable

public boolean noncastable

Constructor Detail

IPlugInCursorHelperProxy

public IPlugInCursorHelperProxy(java.lang.String CLSID,
                                java.lang.String host,
                                com.esri.arcgis.interop.AuthInfo authInfo)
                         throws java.net.UnknownHostException,
                                java.io.IOException

Throws:

java.net.UnknownHostException

java.io.IOException

IPlugInCursorHelperProxy

public IPlugInCursorHelperProxy()

For internal use only

IPlugInCursorHelperProxy

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

Throws:

java.io.IOException

IPlugInCursorHelperProxy

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

Throws:

java.io.IOException

IPlugInCursorHelperProxy

protected IPlugInCursorHelperProxy(java.lang.String CLSID,
                                   java.lang.String iid,
                                   java.lang.String host,
                                   com.esri.arcgis.interop.AuthInfo authInfo)
                            throws java.io.IOException

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

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

removeListener

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

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

nextRecord

public void nextRecord()
                throws java.io.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:

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

AutomationException - If the ArcObject component throws an exception.

isFinished

public boolean isFinished()
                   throws java.io.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:

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

AutomationException - If the ArcObject component throws an exception.

queryValues

public int queryValues(IRowBuffer row)
                throws java.io.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:

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

AutomationException - If the ArcObject component throws an exception.

queryShape

public void queryShape(IGeometry pGeometry)
                throws java.io.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:

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

AutomationException - If the ArcObject component throws an exception.