com.esri.arcgis.carto
Class CalcRendererValues

java.lang.Object
  com.esri.arcgis.carto.CalcRendererValues

All Implemented Interfaces:

ICalcRendererValues, ICalcRendererValues2, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class CalcRendererValues
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ICalcRendererValues, ICalcRendererValues2

An object that calculates renderer statistics which are required for some uses of the ChartRenderer object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

CalcRendererValues()
Constructs a CalcRendererValues using ArcGIS Engine.

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

Method Summary

void	calcMinMax(double[] minValue, double[] maxValue) Calculates minimum and maximum values.
void	calcMinMaxExt(boolean positiveValuesOnly, double[] minValue, double[] maxValue) Calculates minimum and maximum values.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
Object	getFieldTotals() Gets totals for all fields.
int	hashCode() the hashcode for this object
void	setData(IFeatureLayer layer, IFeatureRenderer renderer) Sets data for calculation.
void	setDirty() Sets object to state where values will be recalculated.
void	setMinMax(double minValue, double maxValue) Manually sets minimum and maximum values.

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

CalcRendererValues

public CalcRendererValues()
                   throws IOException,
                          UnknownHostException

Constructs a CalcRendererValues using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

CalcRendererValues

public CalcRendererValues(Object obj)
                   throws IOException

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

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

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

setData

public void setData(IFeatureLayer layer,
                    IFeatureRenderer renderer)
             throws IOException,
                    AutomationException

Sets data for calculation.

Remarks

Use this method to connect the CalcRendererValues object to a feature layer and feature renderer. The renderer is usually a ChartRenderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setData in interface ICalcRendererValues

Parameters:

layer - A reference to a com.esri.arcgis.carto.IFeatureLayer (in)

renderer - A reference to a com.esri.arcgis.carto.IFeatureRenderer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

calcMinMax

public void calcMinMax(double[] minValue,
                       double[] maxValue)
                throws IOException,
                       AutomationException

Calculates minimum and maximum values.

Remarks

Use this method to calculate the MinValue and MaxValue in the data referenced by the feature layer in the fields defined by the feature renderer. You must first set the feature layer and feature renderer using SetData. The feature renderer is usually a ChartRenderer which contains multiple fields, and MinValue and MaxValue are calculated for you based only on the fields defined for the ChartRenderer using IRendererFields .

Use this method to calculate a value to set to IChartSymbol::MaxValue. This property represents the maximum value for all of the renderer fields for all of the features. The value is used by the ChartRenderer to properly set up a the legend information for the ChartRenderer which appears in the table of contents and can also appear in a legend.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

calcMinMax in interface ICalcRendererValues

Parameters:

minValue - The minValue (out: use single element array)

maxValue - The maxValue (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirty

public void setDirty()
              throws IOException,
                     AutomationException

Sets object to state where values will be recalculated.

Remarks

Call this method after calling SetData or SetMinMax, and before calling CalcMinMax or GetFieldTotals.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDirty in interface ICalcRendererValues

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinMax

public void setMinMax(double minValue,
                      double maxValue)
               throws IOException,
                      AutomationException

Manually sets minimum and maximum values.

Remarks

This method allows you to manually set the minimum and maximum values that are calculated and returned when you call CalcMinMax.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMinMax in interface ICalcRendererValues

Parameters:

minValue - The minValue (in)

maxValue - The maxValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldTotals

public Object getFieldTotals()
                      throws IOException,
                             AutomationException

Gets totals for all fields.

Remarks

This method calculates the field totals for the data referenced by the feature layer and the fields defined by the feature renderer. Before calling this method you must call SetData to set the feature layer and feature renderer.

This method is used to calculate field totals which can then be set to IChartRenderer::FieldTotal to support chart rendering with normalization by percent of total.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFieldTotals in interface ICalcRendererValues

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

calcMinMaxExt

public void calcMinMaxExt(boolean positiveValuesOnly,
                          double[] minValue,
                          double[] maxValue)
                   throws IOException,
                          AutomationException

Calculates minimum and maximum values.

Product Availability

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

Specified by:

calcMinMaxExt in interface ICalcRendererValues2

Parameters:

positiveValuesOnly - The positiveValuesOnly (in)

minValue - The minValue (out: use single element array)

maxValue - The maxValue (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.