com.esri.arcgis.geodatabaseui
Class Calculator

java.lang.Object
  com.esri.arcgis.geodatabaseui.Calculator

All Implemented Interfaces:

ICalculator, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class Calculator
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ICalculator

COM Class 'Calculator'. Generated 3/19/2015 1:20:50 PM from 'C:\ArcGIS\COM\esriGeoDatabaseUI.olb'

Description 'Calculator engine which is used by the UI and can be used independently.' 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

Fields inherited from interface com.esri.arcgis.geodatabaseui.ICalculator

IID, IID28232c3a_d7d8_450c_a1da_9c1ef5a5a175, xxDummy

Constructor Summary

Calculator()
Constructs a Calculator using ArcGIS Engine.

Calculator(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
Calculator theCalculator = (Calculator) obj;

Method Summary

IEnvelope	calculate() Performs the calculation by executing the pre-expression and expression.
boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
java.lang.String	getExpression() Expression or value applied to a field in each row of the cursor.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
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.
int	hashCode() the hashcode for this object
boolean	isShowErrorPrompt() Indicates whether to show a message prompt when an error occurs during calculation.
void	release() Release a Calculator.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

Calculator

public Calculator()
           throws java.io.IOException,
                  java.net.UnknownHostException

Constructs a Calculator using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

Calculator

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

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
Calculator theCalculator = (Calculator) obj;

Construct a Calculator using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to Calculator.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a Calculator.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

setCursorByRef

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

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

Specified by:

setCursorByRef in interface ICalculator

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

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

The call back routine.

Specified by:

setCallbackByRef in interface ICalculator

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

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

Field to perform the calculation on.

Specified by:

setField in interface ICalculator

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPreExpression

public 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.

Specified by:

setPreExpression in interface ICalculator

Parameters:

pPreExpression - The pPreExpression (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPreExpression

public 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.

Specified by:

getPreExpression in interface ICalculator

Returns:

The pPreExpression

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExpression

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

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

Specified by:

setExpression in interface ICalculator

Parameters:

pExpression - The pExpression (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExpression

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

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

Specified by:

getExpression in interface ICalculator

Returns:

The pExpression

Throws:

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

AutomationException - If the ArcObject component throws an exception.

calculate

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

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

Specified by:

calculate in interface ICalculator

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

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

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

Specified by:

setShowErrorPrompt in interface ICalculator

Parameters:

pShowPrompt - The pShowPrompt (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowErrorPrompt

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

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

Specified by:

isShowErrorPrompt in interface ICalculator

Returns:

The pShowPrompt

Throws:

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

AutomationException - If the ArcObject component throws an exception.