com.esri.arcgis.carto
Interface IClassBreaksDef

All Superinterfaces:

IDataClassificationDef, Serializable

All Known Implementing Classes:

ClassBreaksDef

public interface IClassBreaksDef
extends IDataClassificationDef, Serializable

Provides access to the available properties of a ClassBreaksDef object.

Remarks

Please note when ClassificationMethod is esriClassifyStandardDeviation, BreakCount is not required since the number of output classes depend on the StandardDeviationInterval and MapServer computes that internally.

Product Availability

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

Method Summary

int	getBreakCount() Number of breaks.
String	getClassificationField() Names of the classification field.
int	getClassificationMethod() Classification Method.
String	getNormalizationField() Normalization field.
int	getNormalizationType() Normalization Type.
double	getStandardDeviationInterval() Standard deviation interval.
void	setBreakCount(int breakCount) Number of breaks.
void	setClassificationField(String classificationField) Names of the classification field.
void	setClassificationMethod(int classifyMethod) Classification Method.
void	setNormalizationField(String normalizationField) Normalization field.
void	setNormalizationType(int normalizationType) Normalization Type.
void	setStandardDeviationInterval(double breakCount) Standard deviation interval.

Methods inherited from interface com.esri.arcgis.carto.IDataClassificationDef

getBaseSymbol, getColorRamp, setBaseSymbolByRef, setColorRampByRef

Method Detail

getClassificationField

String getClassificationField()
                              throws IOException,
                                     AutomationException

Names of the classification field.

Product Availability

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

Returns:

The classificationField

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClassificationField

void setClassificationField(String classificationField)
                            throws IOException,
                                   AutomationException

Names of the classification field.

Product Availability

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

Parameters:

classificationField - The classificationField (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBreakCount

int getBreakCount()
                  throws IOException,
                         AutomationException

Number of breaks.

Product Availability

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

Returns:

The breakCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBreakCount

void setBreakCount(int breakCount)
                   throws IOException,
                          AutomationException

Number of breaks.

Product Availability

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

Parameters:

breakCount - The breakCount (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassificationMethod

int getClassificationMethod()
                            throws IOException,
                                   AutomationException

Classification Method.

Product Availability

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

Returns:

A com.esri.arcgis.carto.esriClassifyMethod constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClassificationMethod

void setClassificationMethod(int classifyMethod)
                             throws IOException,
                                    AutomationException

Classification Method.

Product Availability

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

Parameters:

classifyMethod - A com.esri.arcgis.carto.esriClassifyMethod constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNormalizationField

String getNormalizationField()
                             throws IOException,
                                    AutomationException

Normalization field.

Product Availability

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

Returns:

The normalizationField

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNormalizationField

void setNormalizationField(String normalizationField)
                           throws IOException,
                                  AutomationException

Normalization field.

Product Availability

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

Parameters:

normalizationField - The normalizationField (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNormalizationType

int getNormalizationType()
                         throws IOException,
                                AutomationException

Normalization Type.

Product Availability

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

Returns:

A com.esri.arcgis.carto.esriDataNormalization constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNormalizationType

void setNormalizationType(int normalizationType)
                          throws IOException,
                                 AutomationException

Normalization Type.

Product Availability

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

Parameters:

normalizationType - A com.esri.arcgis.carto.esriDataNormalization constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStandardDeviationInterval

double getStandardDeviationInterval()
                                    throws IOException,
                                           AutomationException

Standard deviation interval.

Remarks

Valid values for StandardDeviationInterval are as follows:

Value	Description
1	1 Std Dev
0.5	1/2 Std Dev
0.33	1/3 Std Dev
0.25	1/4 Std Dev

Product Availability

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

Returns:

The breakCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStandardDeviationInterval

void setStandardDeviationInterval(double breakCount)
                                  throws IOException,
                                         AutomationException

Standard deviation interval.

Product Availability

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

Parameters:

breakCount - The breakCount (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.