com.esri.arcgis.carto
Interface IStatisticsRequest

All Superinterfaces:

Serializable

All Known Implementing Classes:

StatisticsRequest

public interface IStatisticsRequest
extends Serializable

Provides access to properties describing a request for statistics from a Map Server.

Product Availability

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

Method Summary

String	getGroupByFields() Comma-separated list of GROUP BY fields.
String	getOrderByFields() Comma-separated list of ORDER BY fields (with ASC or DESC specifiers).
IStatisticDescriptions	getStatisticDescriptions() The array of descriptions for individual statistics.
void	setGroupByFields(String groupByFields) Comma-separated list of GROUP BY fields.
void	setOrderByFields(String orderByFields) Comma-separated list of ORDER BY fields (with ASC or DESC specifiers).
void	setStatisticDescriptionsByRef(IStatisticDescriptions ppStats) The array of descriptions for individual statistics.

Method Detail

getStatisticDescriptions

IStatisticDescriptions getStatisticDescriptions()
                                                throws IOException,
                                                       AutomationException

The array of descriptions for individual statistics.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStatisticDescriptionsByRef

void setStatisticDescriptionsByRef(IStatisticDescriptions ppStats)
                                   throws IOException,
                                          AutomationException

The array of descriptions for individual statistics.

Product Availability

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

Parameters:

ppStats - A reference to a com.esri.arcgis.carto.IStatisticDescriptions (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOrderByFields

String getOrderByFields()
                        throws IOException,
                               AutomationException

Comma-separated list of ORDER BY fields (with ASC or DESC specifiers).

Product Availability

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

Returns:

The orderByFields

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOrderByFields

void setOrderByFields(String orderByFields)
                      throws IOException,
                             AutomationException

Comma-separated list of ORDER BY fields (with ASC or DESC specifiers).

Product Availability

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

Parameters:

orderByFields - The orderByFields (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGroupByFields

String getGroupByFields()
                        throws IOException,
                               AutomationException

Comma-separated list of GROUP BY fields.

Remarks

If GroupByFields is specified, statistics will be calculated separately for each unique attribute value. The output record will contain only one record if no GroupByFields is specified. If one is specified, there will be one record for each GroupByFields value.

Product Availability

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

Returns:

The groupByFields

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGroupByFields

void setGroupByFields(String groupByFields)
                      throws IOException,
                             AutomationException

Comma-separated list of GROUP BY fields.

Product Availability

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

Parameters:

groupByFields - The groupByFields (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.