com.esri.arcgis.carto
Interface IDataSampling

All Superinterfaces:

Serializable

All Known Implementing Classes:

ClassBreaksRenderer, LasPointElevationRenderer, TerrainPointAttributeRenderer, TerrainPointElevationRenderer, TinAspectRenderer, TinElevationRenderer, TinNodeElevationRenderer, TinSlopeRenderer

public interface IDataSampling
extends Serializable

Provides access to members that control the data sampling properties of a renderer.

Remarks

Use this interface to classify data for symbolization based on a subset of features instead of by considering all feature values. More specically, use this interface to specify the maximum number of features to consider when generating class breaks from a classification object.

To perform data sampling using this interface, first instantiate a renderer and set IDataSampling::MaxSampleSize. Next, pass this renderer to a TableHistogram or BasicTableHistogram using ITableHistogram::Sampling. Use IHistogram::GetHistogram to generate a list pair of values and frequencies. Then, classify your data using IClassifyGEN::Classify, passing these lists as parameters. Finally, take the class breaks that were generated by this operation and assign them to your renderer. For example, if working with a ClassBreaksRenderer, set your breaks using IClassBreaksRenderer::Break.

You can also use this interface to check to see if data sampling was used to generate the class breaks for an existing renderer. This works only if the renderer has been assigned by using the standard ArcMap user interface.

Product Availability

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

Method Summary

int	getMaxSampleSize() Maximum sample size.
int	getSamplingMethod() Data sampling method.
void	setMaxSampleSize(int size) Maximum sample size.
void	setSamplingMethod(int method) Data sampling method.

Method Detail

getMaxSampleSize

int getMaxSampleSize()
                     throws IOException,
                            AutomationException

Maximum sample size.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The size

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxSampleSize

void setMaxSampleSize(int size)
                      throws IOException,
                             AutomationException

Maximum sample size.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

size - The size (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSamplingMethod

int getSamplingMethod()
                      throws IOException,
                             AutomationException

Data sampling method.

Remarks

esriAllRecords samples all features up to the maximum sample size

esriRandomRecords is not implemented

esriEveryNthRecord is not implemented

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.carto.esriDataSampling constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSamplingMethod

void setSamplingMethod(int method)
                       throws IOException,
                              AutomationException

Data sampling method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

method - A com.esri.arcgis.carto.esriDataSampling constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.