com.esri.arcgis.geodatabaseextensions
Class TerrainFieldStatistics

java.lang.Object
  com.esri.arcgis.geodatabaseextensions.TerrainFieldStatistics

All Implemented Interfaces:

ITerrainFieldStatistics, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class TerrainFieldStatistics
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ITerrainFieldStatistics

ESRI TerrainFieldStatistics object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

TerrainFieldStatistics(Object obj)
Construct a TerrainFieldStatistics using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(Object o) Compare this object with another
double	getCount() The number of elements.
String	getFieldName() The field name associated with the statistics.
double	getMaximum() The maximum value.
double	getMean() The mean value.
double	getMinimum() The minimum value.
double	getStandardDeviation() The standard deviation.
IDoubleArray	getUniqueValueCounts() Returns the number of unique values.
IDoubleArray	getUniqueValuesAsDouble() Returns the unique values.
ILongArray	getUniqueValuesAsLong() Returns the unique values.
int	getUniqueValueType() Returns esriTerrainLong for integer-type data (except for unsigned long), and esriTerrainDouble for unsigned long and floating point data.
int	hashCode() the hashcode for this object
boolean	isEmpty() Indicates if the object is empty.
boolean	isNeedsUpdate() Indicates if update is necessary.

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

TerrainFieldStatistics

public TerrainFieldStatistics(Object obj)
                       throws IOException

Construct a TerrainFieldStatistics using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to TerrainFieldStatistics.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
TerrainFieldStatistics o = (TerrainFieldStatistics)obj; // will not work

TerrainFieldStatistics o = new TerrainFieldStatistics(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems TerrainFieldStatistics theTerrainFieldStatistics = (TerrainFieldStatistics) obj;

Method Detail

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

isEmpty

public boolean isEmpty()
                throws IOException,
                       AutomationException

Indicates if the object is empty.

Description

Returns TRUE if statistics have yet to be calculated for this field. See ITerrainEdit3.CalculateFieldStatistics.

Product Availability

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

Specified by:

isEmpty in interface ITerrainFieldStatistics

Returns:

The pbIsEmpty

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isNeedsUpdate

public boolean isNeedsUpdate()
                      throws IOException,
                             AutomationException

Indicates if update is necessary.

Description

Returns TRUE if the statistics for the field are out of date due to edits which have taken place on the terrain and need to be recalculated. See ITerrainEdit3.CalculateFieldStatistics.

Product Availability

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

Specified by:

isNeedsUpdate in interface ITerrainFieldStatistics

Returns:

The pbNeedsUpdate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldName

public String getFieldName()
                    throws IOException,
                           AutomationException

The field name associated with the statistics.

Description

The name of the field from which these statistics are based.

Product Availability

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

Specified by:

getFieldName in interface ITerrainFieldStatistics

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

public double getCount()
                throws IOException,
                       AutomationException

The number of elements.

Description

The total number of observations used to generate the statistics. The value is a whole number but a double is used to prevent overflow situations.

Product Availability

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

Specified by:

getCount in interface ITerrainFieldStatistics

Returns:

The pCount

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

The minimum of all observed values for the field.

Product Availability

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

Specified by:

getMinimum in interface ITerrainFieldStatistics

Returns:

The pMinimum

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

The maximum of all observed values for the field.

Product Availability

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

Specified by:

getMaximum in interface ITerrainFieldStatistics

Returns:

The pMaximum

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMean

public double getMean()
               throws IOException,
                      AutomationException

The mean value.

Description

The average of all observed values for the field.

Product Availability

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

Specified by:

getMean in interface ITerrainFieldStatistics

Returns:

The pMean

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.

Description

The standard deviation of all observed values for the field.

Product Availability

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

Specified by:

getStandardDeviation in interface ITerrainFieldStatistics

Returns:

The pStandardDeviation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUniqueValueType

public int getUniqueValueType()
                       throws IOException,
                              AutomationException

Returns esriTerrainLong for integer-type data (except for unsigned long), and esriTerrainDouble for unsigned long and floating point data.

Description

Used to indicate whether unique values for the field should be retrieved using ITerrainFieldStatistics.GetUniqueValuesAsLong or ITerrainFieldStatistics.GetUniqueValuesAsDouble. When a value of esriTerrainLong is returned call GetUniqueValuesAsLong. When a value of esriTerrainDouble is returned call GetUniqueValuesAsDouble. These two types can be be used to capture/represent other types if they happen to be stored as chars, shorts, or floats, etc.

Product Availability

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

Specified by:

getUniqueValueType in interface ITerrainFieldStatistics

Returns:

A com.esri.arcgis.geodatabaseextensions.esriTerrainBlobDataType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUniqueValuesAsLong

public ILongArray getUniqueValuesAsLong()
                                 throws IOException,
                                        AutomationException

Returns the unique values.

Description

Returns an array containing the unique values for the set of observations. For example, if a collection of 1000 observations only contains a few different values, say 1, 5, and 10, it is this function which returns just those three values.

Use ITerrainFieldStatistics.UniqueValueType to determine whether to obtain the values using this method or ITerrainFieldStatistics.GetUniqueValuesAsDouble.

There is a one to one correspondence between the values in this array and those returned by ITerrainFieldStatistics.GetUniqueValueCounts. The latter contains the number of observed values.

This method stops collecting unique values when there's more than 256. That indicates the data is more continuous in nature than discrete.

Product Availability

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

Specified by:

getUniqueValuesAsLong in interface ITerrainFieldStatistics

Returns:

A reference to a com.esri.arcgis.system.ILongArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUniqueValuesAsDouble

public IDoubleArray getUniqueValuesAsDouble()
                                     throws IOException,
                                            AutomationException

Returns the unique values.

Description

Returns an array containing the unique values for the set of observations. For example, if a collection of 1000 observations only contains a few different values, say 1.1, 5.4. and 10.3, it is this function which returns just those three values.

Use ITerrainFieldStatistics.UniqueValueType to determine whether to obtain the values using this method or ITerrainFieldStatistics.GetUniqueValuesAsLong.

There is a one to one correspondence between the values in this array and those returned by GetUniqueValueCounts. The latter contains the number of observed values.

This method stops collecting unique values when there's more than 256. That indicates the data is more continuous in nature than discrete.

Product Availability

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

Specified by:

getUniqueValuesAsDouble in interface ITerrainFieldStatistics

Returns:

A reference to a com.esri.arcgis.system.IDoubleArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUniqueValueCounts

public IDoubleArray getUniqueValueCounts()
                                  throws IOException,
                                         AutomationException

Returns the number of unique values.

Description

Returns an array where each entry is the number of observations with the same value. It can be used to generate a histogram. For example, if the field represents class codes and there are two values of class codes, say '2' and '5', the first value in the returned array represents the number of observations with a class code of 2, and the second the number with a class code of 5. The sum of the values returned in the array equals the total number of observations (i.e., ITerrainFieldStatistics.Count).

There is a one to one correspondence between the values in this array and those returned by ITerrainFieldStatistics.GetUniqueValuesAsDouble and ITerrainFieldStatistics.GetUniqueValuesAsLong. Those contain the observed values, this contains the number of observed values.

The array values are whole numbers but doubles are used to prevent overflow situations.

This method stops tallying unique values when there's more than 256. That indicates the data is more continuous in nature than discrete.

Product Availability

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

Specified by:

getUniqueValueCounts in interface ITerrainFieldStatistics

Returns:

A reference to a com.esri.arcgis.system.IDoubleArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.