com.esri.arcgis.geodatabaseui
Class CalculatorUI

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

All Implemented Interfaces:

ICalculatorUI, ICalculatorUI2, ICalculatorUIJoinSettings, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class CalculatorUI
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ICalculatorUI, ICalculatorUI2, ICalculatorUIJoinSettings

Window to display calculator dialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

CalculatorUI()
Constructs a CalculatorUI using ArcGIS Engine.

CalculatorUI(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
CalculatorUI theCalculatorUI = (CalculatorUI) obj;

Method Summary

IEnvelope	doModal(int parentWindow) Displays the dialog used to perform calculations.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
String	getExpression() Expression or value applied to a field in each row of the cursor.
String	getPreExpression() A pre-calculation code determination of a value or variable that may be passed to the expression, or value, of the calculation.
int	hashCode() the hashcode for this object
void	setCallbackByRef(ITableDataCallback rhs1) The call back routine.
void	setExpression(String pExpression) Expression or value applied to a field in each row of the cursor.
void	setField(String rhs1) Field to perform calculation on.
void	setFireRowEventsForJoins(boolean rhs1) Should row events be fired during calculation (default false).
void	setPreExpression(String pPreExpression) A pre-calculation code determination of a value or variable that may be passed to the expression, or value, of the calculation.
void	setQueryFilterByRef(IQueryFilter rhs1) QueryFilter used for reading and writing data (optional).
void	setSelectionSetByRef(ISelectionSet rhs1) SelectionSet to perform calculation on (optional).
void	setTableByRef(ITable rhs1) Table to perform calculation on.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

CalculatorUI

public CalculatorUI()
             throws IOException,
                    UnknownHostException

Constructs a CalculatorUI using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

CalculatorUI

public CalculatorUI(Object obj)
             throws IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setTableByRef

public void setTableByRef(ITable rhs1)
                   throws IOException,
                          AutomationException

Table to perform calculation on.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setTableByRef in interface ICalculatorUI

Specified by:

setTableByRef in interface ICalculatorUI2

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSelectionSetByRef

public void setSelectionSetByRef(ISelectionSet rhs1)
                          throws IOException,
                                 AutomationException

SelectionSet to perform calculation on (optional).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setSelectionSetByRef in interface ICalculatorUI

Specified by:

setSelectionSetByRef in interface ICalculatorUI2

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setQueryFilterByRef

public void setQueryFilterByRef(IQueryFilter rhs1)
                         throws IOException,
                                AutomationException

QueryFilter used for reading and writing data (optional).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setQueryFilterByRef in interface ICalculatorUI

Specified by:

setQueryFilterByRef in interface ICalculatorUI2

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCallbackByRef

public void setCallbackByRef(ITableDataCallback rhs1)
                      throws IOException,
                             AutomationException

The call back routine.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setCallbackByRef in interface ICalculatorUI

Specified by:

setCallbackByRef in interface ICalculatorUI2

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setField

public void setField(String rhs1)
              throws IOException,
                     AutomationException

Field to perform calculation on.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setField in interface ICalculatorUI

Specified by:

setField in interface ICalculatorUI2

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

doModal

public IEnvelope doModal(int parentWindow)
                  throws IOException,
                         AutomationException

Displays the dialog used to perform calculations.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

doModal in interface ICalculatorUI

Specified by:

doModal in interface ICalculatorUI2

Parameters:

parentWindow - The parentWindow (A COM typedef) (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPreExpression

public void setPreExpression(String pPreExpression)
                      throws IOException,
                             AutomationException

A pre-calculation code determination of a value or variable that may be passed to the expression, or value, of the calculation.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setPreExpression in interface ICalculatorUI2

Parameters:

pPreExpression - The pPreExpression (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPreExpression

public String getPreExpression()
                        throws IOException,
                               AutomationException

A pre-calculation code determination of a value or variable that may be passed to the expression, or value, of the calculation.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getPreExpression in interface ICalculatorUI2

Returns:

The pPreExpression

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExpression

public void setExpression(String pExpression)
                   throws IOException,
                          AutomationException

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

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setExpression in interface ICalculatorUI2

Parameters:

pExpression - The pExpression (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExpression

public String getExpression()
                     throws IOException,
                            AutomationException

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

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getExpression in interface ICalculatorUI2

Returns:

The pExpression

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFireRowEventsForJoins

public void setFireRowEventsForJoins(boolean rhs1)
                              throws IOException,
                                     AutomationException

Should row events be fired during calculation (default false).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setFireRowEventsForJoins in interface ICalculatorUIJoinSettings

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.