com.esri.arcgis.cartoUI
Class TableHistogram

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

All Implemented Interfaces:

IBasicHistogram, IDataNormalization, ITableHistogram, IHistogram, IHistogram2, com.esri.arcgis.interop.RemoteObjRef, IStatisticsResults, java.io.Serializable

public class TableHistogram
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IBasicHistogram, IHistogram, IHistogram2, ITableHistogram, IDataNormalization, IStatisticsResults

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

Description 'A histogram data structure that is created from table data. Use this to pass data to a classification object.' 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.carto.IBasicHistogram

IID, IIDd7dd57c6_6a35_4dbf_8f64_affdced5c364, xxDummy

Fields inherited from interface com.esri.arcgis.cartoUI.IHistogram

IID, IID962bd9ab_1ec8_11d3_9f4d_00c04f6bc709, xxDummy

Fields inherited from interface com.esri.arcgis.cartoUI.IHistogram2

IID, IID233a0652_5ad8_4fa8_a61f_65de6260c4eb, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ITableHistogram

IID, IIDfd21f230_67a6_11d3_9f66_00c04f6bc709, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IDataNormalization

IID, IID678d02a5_e3fa_11d3_9f7b_00c04f6bc709, xxDummy

Fields inherited from interface com.esri.arcgis.system.IStatisticsResults

IID, IIDb9c4358a_78b8_11d2_ae60_080009ec732a, xxDummy

Constructor Summary

TableHistogram()
Constructs a TableHistogram using ArcGIS Engine.

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

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
void	exclusionDoModal(int parentHWnd, boolean[] ok) Shows the exclusion dialog for the histogram.
static java.lang.String	getClsid() getClsid.
int	getCount() The count of the values.
IDataExclusion	getExclusion() Data exclusion options.
java.lang.String	getField() Value field.
boolean	getHistogram(java.lang.Object[] doubleArrayValues, java.lang.Object[] longArrayFrequencies) Histogram as an array of values (doubles) and a paired array of frequencies (longs).
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
double	getMaximum() The maximum value.
double	getMean() The arithmetic mean.
double	getMinimum() The minimum value.
java.lang.String	getNormalizationField() Normalization field.
java.lang.String	getNormalizationFieldAlias() Normalization field alias.
double	getNormalizationTotal() Total of all values (used when normalizing by percent of total).
int	getNormalizationType() Normalization type.
java.lang.String	getNormField() Normalization field.
IDataSampling	getSampling() Data sampling options.
double	getStandardDeviation() The standard deviation, based on sample flag.
double	getSum() The sum of the values.
ITable	getTable() The associated table.
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(java.lang.Object[] doubleArrayValues, java.lang.Object[] longArrayFrequencies) Histogram as an array of values (doubles) and a paired array of frequencies (longs).
void	invalidate() Causes to recreate the Histogram from the Table for the next GetHistogram call.
void	release() Release a TableHistogram.
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	setExclusionByRef(IDataExclusion dataExclusion) Data exclusion options.
void	setField(java.lang.String name) Value field.
void	setNormalizationField(java.lang.String fieldName) Normalization field.
void	setNormalizationFieldAlias(java.lang.String name) Normalization field alias.
void	setNormalizationTotal(double value) Total of all values (used when normalizing by percent of total).
void	setNormalizationType(int type) Normalization type.
void	setNormField(java.lang.String name) Normalization field.
void	setSamplingByRef(IDataSampling dataSampling) Data sampling options.
void	setTableByRef(ITable table) The associated table.

Methods inherited from class java.lang.Object

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

Constructor Detail

TableHistogram

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

Constructs a TableHistogram using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

TableHistogram

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

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

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

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

Specified by:

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

getHistogram

public boolean getHistogram(java.lang.Object[] doubleArrayValues,
                            java.lang.Object[] longArrayFrequencies)
                     throws java.io.IOException,
                            AutomationException

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

Specified by:

getHistogram in interface IBasicHistogram

Parameters:

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

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

Returns:

The isSampled

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCustomMin

public void setCustomMin(double rhs1)
                  throws java.io.IOException,
                         AutomationException

Custom minimum.

Specified by:

setCustomMin in interface IBasicHistogram

Specified by:

setCustomMin in interface IHistogram

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCustomMax

public void setCustomMax(double rhs1)
                  throws java.io.IOException,
                         AutomationException

Custom maximum.

Specified by:

setCustomMax in interface IBasicHistogram

Specified by:

setCustomMax in interface IHistogram

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

resetCustomMinMax

public void resetCustomMinMax()
                       throws java.io.IOException,
                              AutomationException

Resets custom minimum and maximum.

Specified by:

resetCustomMinMax in interface IBasicHistogram

Specified by:

resetCustomMinMax in interface IHistogram

Throws:

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

AutomationException - If the ArcObject component throws an exception.

invalidate

public void invalidate()
                throws java.io.IOException,
                       AutomationException

Causes to recreate the Histogram from the Table for the next GetHistogram call.

Specified by:

invalidate in interface IBasicHistogram

Specified by:

invalidate in interface IHistogram2

Throws:

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

AutomationException - If the ArcObject component throws an exception.

IHistogram_getHistogram

public void IHistogram_getHistogram(java.lang.Object[] doubleArrayValues,
                                    java.lang.Object[] longArrayFrequencies)
                             throws java.io.IOException,
                                    AutomationException

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

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:

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

AutomationException - If the ArcObject component throws an exception.

exclusionDoModal

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

Shows the exclusion dialog for the histogram.

Specified by:

exclusionDoModal in interface IHistogram

Parameters:

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

ok - The ok (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

hasExclusion

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

Indicates if the histogram uses exclusion.

Specified by:

hasExclusion in interface IHistogram

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

samplingDoModal

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

Shows the sampling dialog for the histogram.

Specified by:

samplingDoModal in interface IHistogram

Parameters:

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

ok - The ok (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

hasSampling

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

Indicates if the histogram uses data sampling.

Specified by:

hasSampling in interface IHistogram

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTableByRef

public void setTableByRef(ITable table)
                   throws java.io.IOException,
                          AutomationException

The associated table.

Specified by:

setTableByRef in interface ITableHistogram

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTable

public ITable getTable()
                throws java.io.IOException,
                       AutomationException

The associated table.

Specified by:

getTable in interface ITableHistogram

Returns:

A reference to a com.esri.arcgis.geodatabase.ITable

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExclusionByRef

public void setExclusionByRef(IDataExclusion dataExclusion)
                       throws java.io.IOException,
                              AutomationException

Data exclusion options.

Specified by:

setExclusionByRef in interface ITableHistogram

Parameters:

dataExclusion - A reference to a com.esri.arcgis.carto.IDataExclusion (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExclusion

public IDataExclusion getExclusion()
                            throws java.io.IOException,
                                   AutomationException

Data exclusion options.

Specified by:

getExclusion in interface ITableHistogram

Returns:

A reference to a com.esri.arcgis.carto.IDataExclusion

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSamplingByRef

public void setSamplingByRef(IDataSampling dataSampling)
                      throws java.io.IOException,
                             AutomationException

Data sampling options.

Specified by:

setSamplingByRef in interface ITableHistogram

Parameters:

dataSampling - A reference to a com.esri.arcgis.carto.IDataSampling (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSampling

public IDataSampling getSampling()
                          throws java.io.IOException,
                                 AutomationException

Data sampling options.

Specified by:

getSampling in interface ITableHistogram

Returns:

A reference to a com.esri.arcgis.carto.IDataSampling

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setField

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

Value field.

Specified by:

setField in interface ITableHistogram

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getField

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

Value field.

Specified by:

getField in interface ITableHistogram

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNormField

public void setNormField(java.lang.String name)
                  throws java.io.IOException,
                         AutomationException

Normalization field.

Specified by:

setNormField in interface ITableHistogram

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNormField

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

Normalization field.

Specified by:

getNormField in interface ITableHistogram

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNormalizationField

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

Normalization field.

Specified by:

getNormalizationField in interface IDataNormalization

Returns:

The fieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNormalizationField

public void setNormalizationField(java.lang.String fieldName)
                           throws java.io.IOException,
                                  AutomationException

Normalization field.

Specified by:

setNormalizationField in interface IDataNormalization

Parameters:

fieldName - The fieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNormalizationFieldAlias

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

Normalization field alias.

Specified by:

getNormalizationFieldAlias in interface IDataNormalization

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNormalizationFieldAlias

public void setNormalizationFieldAlias(java.lang.String name)
                                throws java.io.IOException,
                                       AutomationException

Normalization field alias.

Specified by:

setNormalizationFieldAlias in interface IDataNormalization

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNormalizationType

public int getNormalizationType()
                         throws java.io.IOException,
                                AutomationException

Normalization type.

Specified by:

getNormalizationType in interface IDataNormalization

Returns:

A com.esri.arcgis.carto.esriDataNormalization constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNormalizationType

public void setNormalizationType(int type)
                          throws java.io.IOException,
                                 AutomationException

Normalization type.

Specified by:

setNormalizationType in interface IDataNormalization

Parameters:

type - A com.esri.arcgis.carto.esriDataNormalization constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNormalizationTotal

public double getNormalizationTotal()
                             throws java.io.IOException,
                                    AutomationException

Total of all values (used when normalizing by percent of total).

Specified by:

getNormalizationTotal in interface IDataNormalization

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNormalizationTotal

public void setNormalizationTotal(double value)
                           throws java.io.IOException,
                                  AutomationException

Total of all values (used when normalizing by percent of total).

Specified by:

setNormalizationTotal in interface IDataNormalization

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws java.io.IOException,
                    AutomationException

The count of the values.

Specified by:

getCount in interface IStatisticsResults

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinimum

public double getMinimum()
                  throws java.io.IOException,
                         AutomationException

The minimum value.

Specified by:

getMinimum in interface IStatisticsResults

Returns:

The min

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaximum

public double getMaximum()
                  throws java.io.IOException,
                         AutomationException

The maximum value.

Specified by:

getMaximum in interface IStatisticsResults

Returns:

The max

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSum

public double getSum()
              throws java.io.IOException,
                     AutomationException

The sum of the values.

Specified by:

getSum in interface IStatisticsResults

Returns:

The sum

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMean

public double getMean()
               throws java.io.IOException,
                      AutomationException

The arithmetic mean.

Specified by:

getMean in interface IStatisticsResults

Returns:

The mean

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStandardDeviation

public double getStandardDeviation()
                            throws java.io.IOException,
                                   AutomationException

The standard deviation, based on sample flag.

Specified by:

getStandardDeviation in interface IStatisticsResults

Returns:

The stdDev

Throws:

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

AutomationException - If the ArcObject component throws an exception.