com.esri.arcgis.geodatabase
Class IFeatureProgressProxy

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

All Implemented Interfaces:

IFeatureProgress, Externalizable, Serializable, EventListener

public class IFeatureProgressProxy
extends com.esri.arcgis.interop.Dispatch
implements IFeatureProgress, Serializable

Provides access to members used to handle events from converting featureclass/table.

Remarks

The IFeatureProgress interface handles events that are fired by a data conversion or object-loading process.

The various properties, other than IsCancelled, are automatically initialized when data conversion starts. However, it is important to note that you can get these values, but you cannot set them.

Property/Method	Description
FeatureClassName	Input feature class name.
MinFeatures	Minimum number of features/rows in the input object class.
MaxFeatures	Maximum number of features/rows in the input object class.
Position	Current feature/row that is being converted.
StepValue	The number of converted features that are needed to cause the firing of the Step method.
Step	The Step method is fired automatically for every x number of features, where x is the value of StepValue. You can use this event to keep a count of how many features have been converted. The IsCancelled, property is fetched by the converter after every call to Step.
IsCancelled	Indicates whether the cancel button is pressed. The data conversion will be cancelled if the user presses the cancel button.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Field Summary

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

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E

Constructor Summary

	IFeatureProgressProxy()
	IFeatureProgressProxy(Object obj)
protected	IFeatureProgressProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
boolean	isCancelled(IFeatureProgressIsCancelledEvent theEvent) Indicates whether the cancel button is pressed.
void	readExternal(ObjectInput in)
void	removeListener(String iidStr, Object theListener)
void	setFeatureClassName(IFeatureProgressSetFeatureClassNameEvent theEvent) Input feature class name.
void	setMaxFeatures(IFeatureProgressSetMaxFeaturesEvent theEvent) Maximum number of features/rows in the input object class.
void	setMinFeatures(IFeatureProgressSetMinFeaturesEvent theEvent) Minimum number of features/rows in the input objectclass.
void	setPosition(IFeatureProgressSetPositionEvent theEvent) Current feature/row that currently converted by the converter.
void	setStepValue(IFeatureProgressSetStepValueEvent theEvent) Current position of conversion.
void	step(IFeatureProgressStepEvent theEvent) Step the progressor interval.
void	writeExternal(ObjectOutput out)

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, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke

Methods inherited from class java.lang.Object

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

Constructor Detail

IFeatureProgressProxy

public IFeatureProgressProxy()

IFeatureProgressProxy

public IFeatureProgressProxy(Object obj)
                      throws IOException

Throws:

IOException

IFeatureProgressProxy

protected IFeatureProgressProxy(Object obj,
                                String iid)
                         throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

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

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

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

Throws:

IOException

setFeatureClassName

public void setFeatureClassName(IFeatureProgressSetFeatureClassNameEvent theEvent)
                         throws IOException,
                                AutomationException

Input feature class name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFeatureClassName in interface IFeatureProgress

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinFeatures

public void setMinFeatures(IFeatureProgressSetMinFeaturesEvent theEvent)
                    throws IOException,
                           AutomationException

Minimum number of features/rows in the input objectclass.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMinFeatures in interface IFeatureProgress

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxFeatures

public void setMaxFeatures(IFeatureProgressSetMaxFeaturesEvent theEvent)
                    throws IOException,
                           AutomationException

Maximum number of features/rows in the input object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMaxFeatures in interface IFeatureProgress

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPosition

public void setPosition(IFeatureProgressSetPositionEvent theEvent)
                 throws IOException,
                        AutomationException

Current feature/row that currently converted by the converter.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPosition in interface IFeatureProgress

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStepValue

public void setStepValue(IFeatureProgressSetStepValueEvent theEvent)
                  throws IOException,
                         AutomationException

Current position of conversion.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setStepValue in interface IFeatureProgress

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

step

public void step(IFeatureProgressStepEvent theEvent)
          throws IOException,
                 AutomationException

Step the progressor interval.

Remarks

The Step method is fired automatically for every x number of features,where x is the value of StepValue. You can use this event to keep a count of how many features have been converted. The IsCancelled, property is fetched by the converter after every call to Step.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

step in interface IFeatureProgress

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCancelled

public boolean isCancelled(IFeatureProgressIsCancelledEvent theEvent)
                    throws IOException,
                           AutomationException

Indicates whether the cancel button is pressed. The data conversion will be cancelled if the user press the cancel button.

Remarks

The IsCancelled, property is fetched by the converter after every call to Step.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isCancelled in interface IFeatureProgress

Parameters:

theEvent - The event

Returns:

The pbIsCancelled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

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

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

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

Throws:

IOException

ClassNotFoundException