com.esri.arcgis.carto
Class BasicTableHistogram

java.lang.Object
  extended by com.esri.arcgis.carto.BasicTableHistogram
All Implemented Interfaces:
IBasicHistogram, IDataNormalization, ITableHistogram, ITableHistogram2, com.esri.arcgis.interop.RemoteObjRef, IStatisticsResults, Serializable

public class BasicTableHistogram
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IBasicHistogram, ITableHistogram, ITableHistogram2, IDataNormalization, IStatisticsResults

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

Remarks

BasicTableHistogram is used to produce a histogram data structure based on input from an object that supports ITable. This data structure is commonly used as input to the classification coclasses (e.g. NaturalBreaks, Quantile). Use this object if you are developing against only ArcEngine components. The BasicTableHistogram performs a simliar function to TableHistogram, but unlike TableHistogram , it is available to ArcEngine developers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
BasicTableHistogram()
          Constructs a BasicTableHistogram using ArcGIS Engine.
BasicTableHistogram(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
BasicTableHistogram theBasicTableHistogram = (BasicTableHistogram) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 int getCount()
          The count of the values.
 IDataExclusion getExclusion()
          Data exclusion options.
 String getExclusionClause()
          Data Exclusion where clause.
 String getField()
          Value field.
 boolean getHistogram(Object[] doubleArrayValues, Object[] longArrayFrequencies)
          Histogram as an array of values (doubles) and a paired array of frequencies (longs).
 double getMaximum()
          The maximum value.
 int getMaxSampleSize()
          Data Sampling Max Size.
 double getMean()
          The arithmetic mean.
 double getMinimum()
          The minimum value.
 String getNormalizationField()
          Normalization field.
 String getNormalizationFieldAlias()
          Normalization field alias.
 double getNormalizationTotal()
          Total of all values (used when normalizing by percent of total).
 int getNormalizationType()
          Normalization type.
 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.
 int hashCode()
          the hashcode for this object
 void invalidate()
          Causes to recreate the Histogram from the Table for the next GetHistogram call.
 void resetCustomMinMax()
          Resets custom minimum and maximum.
 void setCustomMax(double rhs1)
          Custom maximum.
 void setCustomMin(double rhs1)
          Custom minimum.
 void setExclusionByRef(IDataExclusion dataExclusion)
          Data exclusion options.
 void setExclusionClause(String name)
          Data Exclusion where clause.
 void setField(String name)
          Value field.
 void setMaxSampleSize(int size)
          Data Sampling Max Size.
 void setNormalizationField(String fieldName)
          Normalization field.
 void setNormalizationFieldAlias(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(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
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

BasicTableHistogram

public BasicTableHistogram()
                    throws IOException,
                           UnknownHostException
Constructs a BasicTableHistogram using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

BasicTableHistogram

public BasicTableHistogram(Object obj)
                    throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
BasicTableHistogram theBasicTableHistogram = (BasicTableHistogram) obj;

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

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

getHistogram

public boolean 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 Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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:
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 Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCustomMin in interface IBasicHistogram
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 Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCustomMax in interface IBasicHistogram
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 Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
resetCustomMinMax in interface IBasicHistogram
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

invalidate

public void invalidate()
                throws IOException,
                       AutomationException
Causes to recreate the Histogram from the Table for the next GetHistogram call.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
invalidate in interface IBasicHistogram
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTableByRef

public void setTableByRef(ITable table)
                   throws IOException,
                          AutomationException
The associated table.

Product Availability

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

Specified by:
setTableByRef in interface ITableHistogram
Parameters:
table - 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.

getTable

public ITable getTable()
                throws IOException,
                       AutomationException
The associated table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getTable in interface ITableHistogram
Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExclusionByRef

public void setExclusionByRef(IDataExclusion dataExclusion)
                       throws IOException,
                              AutomationException
Data exclusion options.

Product Availability

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

Specified by:
setExclusionByRef in interface ITableHistogram
Parameters:
dataExclusion - A reference to a com.esri.arcgis.carto.IDataExclusion (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExclusion

public IDataExclusion getExclusion()
                            throws IOException,
                                   AutomationException
Data exclusion options.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getExclusion in interface ITableHistogram
Returns:
A reference to a com.esri.arcgis.carto.IDataExclusion
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSamplingByRef

public void setSamplingByRef(IDataSampling dataSampling)
                      throws IOException,
                             AutomationException
Data sampling options.

Product Availability

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

Specified by:
setSamplingByRef in interface ITableHistogram
Parameters:
dataSampling - A reference to a com.esri.arcgis.carto.IDataSampling (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSampling

public IDataSampling getSampling()
                          throws IOException,
                                 AutomationException
Data sampling options.

Remarks

In implementations of ITableHistogram, the sampling property is null by default. Specify the sample method desired when utilizing the histogram if sampling is desired.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSampling in interface ITableHistogram
Returns:
A reference to a com.esri.arcgis.carto.IDataSampling
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setField

public void setField(String name)
              throws IOException,
                     AutomationException
Value field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setField in interface ITableHistogram
Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getField

public String getField()
                throws IOException,
                       AutomationException
Value field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getField in interface ITableHistogram
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNormField

public void setNormField(String name)
                  throws IOException,
                         AutomationException
Normalization field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setNormField in interface ITableHistogram
Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNormField

public String getNormField()
                    throws IOException,
                           AutomationException
Normalization field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getNormField in interface ITableHistogram
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExclusionClause

public void setExclusionClause(String name)
                        throws IOException,
                               AutomationException
Data Exclusion where clause.

Product Availability

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

Specified by:
setExclusionClause in interface ITableHistogram2
Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExclusionClause

public String getExclusionClause()
                          throws IOException,
                                 AutomationException
Data Exclusion where clause.

Product Availability

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

Specified by:
getExclusionClause in interface ITableHistogram2
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaxSampleSize

public void setMaxSampleSize(int size)
                      throws IOException,
                             AutomationException
Data Sampling Max Size.

Product Availability

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

Specified by:
setMaxSampleSize in interface ITableHistogram2
Parameters:
size - The size (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxSampleSize

public int getMaxSampleSize()
                     throws IOException,
                            AutomationException
Data Sampling Max Size.

Product Availability

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

Specified by:
getMaxSampleSize in interface ITableHistogram2
Returns:
The size
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNormalizationField

public String getNormalizationField()
                             throws IOException,
                                    AutomationException
Normalization field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getNormalizationField in interface IDataNormalization
Returns:
The fieldName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNormalizationField

public void setNormalizationField(String fieldName)
                           throws IOException,
                                  AutomationException
Normalization field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setNormalizationField in interface IDataNormalization
Parameters:
fieldName - The fieldName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNormalizationFieldAlias

public String getNormalizationFieldAlias()
                                  throws IOException,
                                         AutomationException
Normalization field alias.

Description

NormalizationField alias is not implemented by many of the classes implementing IDataNormalization and will return E_NOTIMPL in those cases.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getNormalizationFieldAlias in interface IDataNormalization
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNormalizationFieldAlias

public void setNormalizationFieldAlias(String name)
                                throws IOException,
                                       AutomationException
Normalization field alias.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setNormalizationFieldAlias in interface IDataNormalization
Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNormalizationType

public int getNormalizationType()
                         throws IOException,
                                AutomationException
Normalization type.

Remarks

esriNormalizeByField requires that the NormalizationField be set.

esriNormalizeByLog takes a base 10 logarithm of the data values.

esriNormalizeByPercentageOfTotal requires the NormalizationTotal field to be set to the total data value. This is used to calculate percentages. Each value is divided by the NormalizationTotal and then multiplied by 100. You can use IDataStatistics to generate NormalizationTotal .

esriNormalizeByArea is not implemented.

esriNormalizeByNothing disables normalization.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getNormalizationType in interface IDataNormalization
Returns:
A com.esri.arcgis.carto.esriDataNormalization constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNormalizationType

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setNormalizationType in interface IDataNormalization
Parameters:
type - A com.esri.arcgis.carto.esriDataNormalization constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNormalizationTotal

public double getNormalizationTotal()
                             throws IOException,
                                    AutomationException
Total of all values (used when normalizing by percent of total).

Description

Not implemented by ProportionalSymbolRenderer .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getNormalizationTotal in interface IDataNormalization
Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNormalizationTotal

public void setNormalizationTotal(double value)
                           throws IOException,
                                  AutomationException
Total of all values (used when normalizing by percent of total).

Description

Not implemented by ProportionalSymbolRenderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setNormalizationTotal in interface IDataNormalization
Parameters:
value - The value (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)