com.esri.arcgis.geodatabase
Interface IFeatureProgress

All Superinterfaces:

java.util.EventListener, java.io.Serializable

All Known Implementing Classes:

IFeatureProgressAdapter, IFeatureProgressProxy, ReplicationAgent

public interface IFeatureProgress

extends java.util.EventListener, java.io.Serializable

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

Method Summary

boolean	isCancelled(IFeatureProgressIsCancelledEvent theEvent) Indicates whether the cancel button is pressed.
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.

Method Detail

setFeatureClassName

public void setFeatureClassName(IFeatureProgressSetFeatureClassNameEvent theEvent)
                         throws java.io.IOException,
                                AutomationException

Input feature class name.

Supported Platforms

Windows, Solaris, Linux

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMinFeatures

public void setMinFeatures(IFeatureProgressSetMinFeaturesEvent theEvent)
                    throws java.io.IOException,
                           AutomationException

Minimum number of features/rows in the input objectclass.

Supported Platforms

Windows, Solaris, Linux

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaxFeatures

public void setMaxFeatures(IFeatureProgressSetMaxFeaturesEvent theEvent)
                    throws java.io.IOException,
                           AutomationException

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPosition

public void setPosition(IFeatureProgressSetPositionEvent theEvent)
                 throws java.io.IOException,
                        AutomationException

Current feature/row that currently converted by the converter.

Supported Platforms

Windows, Solaris, Linux

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStepValue

public void setStepValue(IFeatureProgressSetStepValueEvent theEvent)
                  throws java.io.IOException,
                         AutomationException

Current position of conversion.

Supported Platforms

Windows, Solaris, Linux

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

step

public void step(IFeatureProgressStepEvent theEvent)
          throws java.io.IOException,
                 AutomationException

Step the progressor interval.

Supported Platforms

Windows, Solaris, Linux

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.

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCancelled

public boolean isCancelled(IFeatureProgressIsCancelledEvent theEvent)
                    throws java.io.IOException,
                           AutomationException

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

Parameters:

theEvent - The event

Returns:

The pbIsCancelled

Throws:

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

AutomationException - If the ArcObject component throws an exception.