com.esri.arcgis.cartoUI
Class DataHistogram

java.lang.Object
  com.esri.arcgis.cartoUI.DataHistogram

All Implemented Interfaces:

IDataHistogram, IHistogram, com.esri.arcgis.interop.RemoteObjRef, IStatisticsResults, Serializable

public class DataHistogram
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IHistogram, IDataHistogram, IStatisticsResults

A histogram data structure that is created from data values. Use this to pass data to a classification object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

DataHistogram()
Constructs a DataHistogram using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
void	exclusionDoModal(int parentHWnd, boolean[] ok) Shows the exclusion dialog for the histogram.
static String	getClsid() getClsid.
int	getCount() The count of the values.
double	getMaximum() The maximum value.
double	getMean() The arithmetic mean.
double	getMinimum() The minimum value.
double	getStandardDeviation() The standard deviation, based on sample flag.
double	getSum() The sum of the values.
void	hasExclusion(boolean[] flag) Indicates if the histogram uses exclusion.
int	hashCode() the hashcode for this object
void	hasSampling(boolean[] flag) Indicates if the histogram uses data sampling.
void	IHistogram_getHistogram(Object[] doubleArrayValues, Object[] longArrayFrequencies) Histogram as an array of values (doubles) and a paired array of frequencies (longs).
void	resetCustomMinMax() Resets custom minimum and maximum.
void	samplingDoModal(int parentHWnd, boolean[] ok) Shows the sampling dialog for the histogram.
void	setCustomMax(double rhs1) Custom maximum.
void	setCustomMin(double rhs1) Custom minimum.
void	setData(Object doubleArrayValues) Sets data from a array of values (doubles).
void	setHistogramData(Object doubleArrayValues, Object longArrayFrequencies) Sets data from a histogram; an array of values (doubles) and a paired array of frequencies (longs).

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

DataHistogram

public DataHistogram()
              throws IOException,
                     UnknownHostException

Constructs a DataHistogram using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

DataHistogram

public DataHistogram(Object obj)
              throws IOException

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

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

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

IHistogram_getHistogram

public void IHistogram_getHistogram(Object[] doubleArrayValues,
                                    Object[] longArrayFrequencies)
                             throws IOException,
                                    AutomationException

Histogram as an array of values (doubles) and a paired array of frequencies (longs).

Product Availability

Available with ArcGIS Desktop.

Specified by:

IHistogram_getHistogram in interface IHistogram

Parameters:

doubleArrayValues - A Variant (out: use single element array)

longArrayFrequencies - A Variant (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomMin

public void setCustomMin(double rhs1)
                  throws IOException,
                         AutomationException

Custom minimum.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setCustomMin in interface IHistogram

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomMax

public void setCustomMax(double rhs1)
                  throws IOException,
                         AutomationException

Custom maximum.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setCustomMax in interface IHistogram

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resetCustomMinMax

public void resetCustomMinMax()
                       throws IOException,
                              AutomationException

Resets custom minimum and maximum.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

resetCustomMinMax in interface IHistogram

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exclusionDoModal

public void exclusionDoModal(int parentHWnd,
                             boolean[] ok)
                      throws IOException,
                             AutomationException

Shows the exclusion dialog for the histogram.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

exclusionDoModal in interface IHistogram

Parameters:

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

ok - The ok (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hasExclusion

public void hasExclusion(boolean[] flag)
                  throws IOException,
                         AutomationException

Indicates if the histogram uses exclusion.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

hasExclusion in interface IHistogram

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

samplingDoModal

public void samplingDoModal(int parentHWnd,
                            boolean[] ok)
                     throws IOException,
                            AutomationException

Shows the sampling dialog for the histogram.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

samplingDoModal in interface IHistogram

Parameters:

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

ok - The ok (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hasSampling

public void hasSampling(boolean[] flag)
                 throws IOException,
                        AutomationException

Indicates if the histogram uses data sampling.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

hasSampling in interface IHistogram

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setData

public void setData(Object doubleArrayValues)
             throws IOException,
                    AutomationException

Sets data from a array of values (doubles).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setData in interface IDataHistogram

Parameters:

doubleArrayValues - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHistogramData

public void setHistogramData(Object doubleArrayValues,
                             Object longArrayFrequencies)
                      throws IOException,
                             AutomationException

Sets data from a histogram; an array of values (doubles) and a paired array of frequencies (longs).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setHistogramData in interface IDataHistogram

Parameters:

doubleArrayValues - A Variant (in)

longArrayFrequencies - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws IOException,
                    AutomationException

The count of the values.

Description

Returns the Count of data values in the BaseStatistics used to derive the statistics. Use this property when IGenerateStatistics.SimpleStats is set to true.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCount in interface IStatisticsResults

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinimum

public double getMinimum()
                  throws IOException,
                         AutomationException

The minimum value.

Description

Returns the Minimum data values in the BaseStatistics. Use this property when IGenerateStatistics.SimpleStats is set to true.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMinimum in interface IStatisticsResults

Returns:

The min

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaximum

public double getMaximum()
                  throws IOException,
                         AutomationException

The maximum value.

Description

Returns the Maximum data values in the BaseStatistics. Use this property when IGenerateStatistics.SimpleStats is set to true.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMaximum in interface IStatisticsResults

Returns:

The max

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSum

public double getSum()
              throws IOException,
                     AutomationException

The sum of the values.

Description

Returns the Sum of all the data values in the BaseStatistics. Use this property when IGenerateStatistics.SimpleStats is set to true.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSum in interface IStatisticsResults

Returns:

The sum

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMean

public double getMean()
               throws IOException,
                      AutomationException

The arithmetic mean.

Description

Returns the arithmetic Mean of all the data values in the BaseStatistics. Use this property when IGenerateStatistics.SimpleStats is set to true.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMean in interface IStatisticsResults

Returns:

The mean

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStandardDeviation

public double getStandardDeviation()
                            throws IOException,
                                   AutomationException

The standard deviation, based on sample flag.

Description

Returns the StandardDeviation of all the data values in the BaseStatistics.

If your data is a sample of the real data, you should indicate so with IGenerateStatistics::Sample before calling StandardDeviation.

Remarks

By default it returns the Sample Standard Deviation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getStandardDeviation in interface IStatisticsResults

Returns:

The stdDev

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IGenerateStatistics.setSample(boolean)