com.esri.arcgis.geodatabaseui
Interface ICalculator

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

Calculator, ICalculatorProxy

public interface ICalculator
extends java.io.Serializable

COM Interface 'ICalculator'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\COM\esriGeoDatabaseUI.olb'

Description: 'Provides access to members that calculate field values in a table.' 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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID28232c3a_d7d8_450c_a1da_9c1ef5a5a175
static int	xxDummy Deprecated. Internal use only

Method Summary

IEnvelope	calculate() Performs the calculation by executing the pre-expression and expression.
java.lang.String	getExpression() Expression or value applied to a field in each row of the cursor.
java.lang.String	getPreExpression() A pre-calculation determination of a value or variable that may be used as the expression (or value) of the calculation.
boolean	isShowErrorPrompt() Indicates whether to show a message prompt when an error occurs during calculation.
void	setCallbackByRef(ICalculatorCallback rhs1) The call back routine.
void	setCursorByRef(ICursor rhs1) Cursor used to access the rows on which the calculation will be performed.
void	setExpression(java.lang.String pExpression) Expression or value applied to a field in each row of the cursor.
void	setField(java.lang.String rhs1) Field to perform the calculation on.
void	setPreExpression(java.lang.String pPreExpression) A pre-calculation determination of a value or variable that may be used as the expression (or value) of the calculation.
void	setShowErrorPrompt(boolean pShowPrompt) Indicates whether to show a message prompt when an error occurs during calculation.

Field Detail

IID28232c3a_d7d8_450c_a1da_9c1ef5a5a175

static final int IID28232c3a_d7d8_450c_a1da_9c1ef5a5a175

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

setCursorByRef

void setCursorByRef(ICursor rhs1)
                    throws java.io.IOException,
                           AutomationException

Cursor used to access the rows on which the calculation will be performed.

Parameters:

rhs1 - A reference to a com.esri.arcgis.geodatabase.ICursor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCallbackByRef

void setCallbackByRef(ICalculatorCallback rhs1)
                      throws java.io.IOException,
                             AutomationException

The call back routine.

Parameters:

rhs1 - A reference to a com.esri.arcgis.geodatabaseui.ICalculatorCallback (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setField

void setField(java.lang.String rhs1)
              throws java.io.IOException,
                     AutomationException

Field to perform the calculation on.

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPreExpression

void setPreExpression(java.lang.String pPreExpression)
                      throws java.io.IOException,
                             AutomationException

A pre-calculation determination of a value or variable that may be used as the expression (or value) of the calculation.

Parameters:

pPreExpression - The pPreExpression (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPreExpression

java.lang.String getPreExpression()
                                  throws java.io.IOException,
                                         AutomationException

A pre-calculation determination of a value or variable that may be used as the expression (or value) of the calculation.

Returns:

The pPreExpression

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExpression

void setExpression(java.lang.String pExpression)
                   throws java.io.IOException,
                          AutomationException

Expression or value applied to a field in each row of the cursor.

Parameters:

pExpression - The pExpression (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExpression

java.lang.String getExpression()
                               throws java.io.IOException,
                                      AutomationException

Expression or value applied to a field in each row of the cursor.

Returns:

The pExpression

Throws:

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

AutomationException - If the ArcObject component throws an exception.

calculate

IEnvelope calculate()
                    throws java.io.IOException,
                           AutomationException

Performs the calculation by executing the pre-expression and expression.

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowErrorPrompt

void setShowErrorPrompt(boolean pShowPrompt)
                        throws java.io.IOException,
                               AutomationException

Indicates whether to show a message prompt when an error occurs during calculation.

Parameters:

pShowPrompt - The pShowPrompt (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowErrorPrompt

boolean isShowErrorPrompt()
                          throws java.io.IOException,
                                 AutomationException

Indicates whether to show a message prompt when an error occurs during calculation.

Returns:

The pShowPrompt

Throws:

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

AutomationException - If the ArcObject component throws an exception.