com.esri.arcgis.carto
Interface IRendererClasses

All Superinterfaces:

Serializable

All Known Implementing Classes:

ClassBreaksRenderer, RepresentationRenderer, UniqueValueRenderer, UniqueValueTextRenderer

public interface IRendererClasses
extends Serializable

Provides access to members that provides the information of layer annotation classes.

Description

This interface provides access to properties of a renderer's classes. Some of this information can also be accessed via interfaces specific to the particular renderer.

Remarks

This interface is most useful for returning an SQL where clause that can be used to query for the features in a renderer class. This interface is supported only by the ClassBreaksRenderer and UniqueValueRenderer. The framework uses this interface to build label classes based on renderer symbology classes.

You can access Class and ClassCount information via the specific renderer interfaces IClassBreaksRenderer and IUniqueValueRenderer. You can also access this information via ILegendInfo for a given renderer.

To make a change to the number of classes in a given renderer, use the renderer specific interfaces.

Note that neither the ClassBreaksRenderer or UniqueValueRenderer structure their classes based on SQL where clauses. However, this interface can be used to generate a query to match the class defined for a particular renderer. This can be useful, for example, to select all of the features in a feature layer that fall within the 2nd highest class of the graduated color symbology assigned to the layer by a ClassBreaksRenderer.

Product Availability

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

Method Summary

String	esri_getClass(int index) Class name.
int	getClassCount() Number of classes.
String	getWhereClause(int index, ITable table) WhereClause.

Method Detail

getClassCount

int getClassCount()
                  throws IOException,
                         AutomationException

Number of classes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_getClass

String esri_getClass(int index)
                     throws IOException,
                            AutomationException

Class name.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWhereClause

String getWhereClause(int index,
                      ITable table)
                      throws IOException,
                             AutomationException

WhereClause.

Product Availability

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

Parameters:

index - The index (in)

table - A reference to a com.esri.arcgis.geodatabase.ITable (in)

Returns:

The whereClause

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.