com.esri.arcgis.server
Class ServerStatisticsResults

java.lang.Object
  com.esri.arcgis.server.ServerStatisticsResults

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IServerTimeRange, IStatisticsResults, Serializable

public class ServerStatisticsResults
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IStatisticsResults, IServerTimeRange

The ServerStatisticsResults object which returns a set of statistics, such as count, min, max, mean, for a single time period.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

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

Method Summary

boolean	equals(Object o) Compare this object with another
int	getCount() The count of the values.
Date	getEndTime() The end time for the period that the statistics represent.
double	getMaximum() The maximum value.
double	getMean() The arithmetic mean.
double	getMinimum() The minimum value.
double	getStandardDeviation() The standard deviation, based on sample flag.
Date	getStartTime() The start time for the period that the statistics represent.
double	getSum() The sum of the values.
int	hashCode() the hashcode for this object

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

ServerStatisticsResults

public ServerStatisticsResults(Object obj)
                        throws IOException

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

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

Throws:

IOException - if there are interop problems ServerStatisticsResults theServerStatisticsResults = (ServerStatisticsResults) 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

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)

getStartTime

public Date getStartTime()
                  throws IOException,
                         AutomationException

The start time for the period that the statistics represent.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getStartTime in interface IServerTimeRange

Returns:

The pTime

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEndTime

public Date getEndTime()
                throws IOException,
                       AutomationException

The end time for the period that the statistics represent.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getEndTime in interface IServerTimeRange

Returns:

The pTime

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.