com.esri.arcgis.geodatabaseui
Interface ICalculatorCallback

All Superinterfaces:

Serializable

All Known Implementing Classes:

CalculatorCallback

public interface ICalculatorCallback
extends Serializable

Provides access to events that occur when the state of the calculator changes.

When To Use

Use ICalculatorCallBack to monitor the progress of calculation operations.

Product Availability

Available with ArcGIS Desktop.

Method Summary

boolean	calculatorError(int rowID, boolean bHasOID, int errorType, boolean bShowPrompt, String errorMsg) Error message provided by the calculator.
void	calculatorWarning(int rowID, boolean bHasOID, int errorType, String errorMsg) Warning message provided by the calculator.
boolean	status(int rowsWritten, boolean lastStatus) Current Status of the calculator.

Method Detail

status

boolean status(int rowsWritten,
               boolean lastStatus)
               throws IOException,
                      AutomationException

Current Status of the calculator.

Remarks

The Status method is called for each record to be processed during the calculation operation. Feedback may be provided to the user on the number of records processed and if the calculation should be aborted. This method would normally be set to true if for example, the user pressed the ESC key.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

rowsWritten - The rowsWritten (in)

lastStatus - The lastStatus (in)

Returns:

The pAbort

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

calculatorError

boolean calculatorError(int rowID,
                        boolean bHasOID,
                        int errorType,
                        boolean bShowPrompt,
                        String errorMsg)
                        throws IOException,
                               AutomationException

Error message provided by the calculator.

Remarks

CalculatorError is called when calculation process will no longer continue. Error messages, error types and the row id of the record where the calculation failed, may be written to an error log for reference.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

rowID - The rowID (in)

bHasOID - The bHasOID (in)

errorType - A com.esri.arcgis.geodatabaseui.esriCalculatorErrorType constant (in)

bShowPrompt - The bShowPrompt (in)

errorMsg - The errorMsg (in)

Returns:

The pAbort

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

calculatorWarning

void calculatorWarning(int rowID,
                       boolean bHasOID,
                       int errorType,
                       String errorMsg)
                       throws IOException,
                              AutomationException

Warning message provided by the calculator.

Remarks

CalculatorWarning is called when an issue was encountered during the calculation, but the calculation can continue.You can return a flag to abort, if you want to stop processing.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

rowID - The rowID (in)

bHasOID - The bHasOID (in)

errorType - A com.esri.arcgis.geodatabaseui.esriCalculatorErrorType constant (in)

errorMsg - The errorMsg (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

com.esri.arcgis.geoDatabaseUI.ICalculator#setCursorByRef(com.esri.arcgis.geodatabase.ICursor), com.esri.arcgis.geoDatabaseUI.ICalculator#setCallbackByRef(com.esri.arcgis.geodatabaseui.ICalculatorCallback), com.esri.arcgis.geoDatabaseUI.ICalculatorCallback#calculatorError(int, boolean, int, boolean, String), com.esri.arcgis.geoDatabaseUI.ICalculator#calculate(), com.esri.arcgis.geoDatabaseUI.ICalculatorCallback#calculatorWarning(int, boolean, int, String), com.esri.arcgis.geoDatabaseUI.ICalculatorCallback, com.esri.arcgis.geoDatabaseUI.Calculator, com.esri.arcgis.geoDatabaseUI.ICalculatorCallback#status(int, boolean), com.esri.arcgis.geoDatabaseUI.ICalculator