com.esri.arcgis.carto
Interface IRasterRendererClassInfo

All Superinterfaces:
Serializable
All Known Implementing Classes:
RasterClassifyColorRampRenderer, RasterColormapRenderer, RasterStretchColorRampRenderer, RasterUniqueValueRenderer

public interface IRasterRendererClassInfo
extends Serializable

Provides access to members which contain info about renderer classes.

Remarks

While each of the single-band renderers produces different display effects, each at some point must divide the input data into classes. The unique value renderer creates a class for each value, the classified renderer creates an arbitrary number of classes defined by the user, and the stretched renderer divides the input data into 255 classes. The IRasterRendererClassInfo interface provides the ability to read these classes from each renderer through a common mechanism.

Example:

// This example assumes that there is a reference to an
// IRasterStretchColorRampRenderer object (pRen)
double[] vMin = {};
double[] vMax = {};
int[] vValue = {};

IRasterRendererClassInfo pRenClassInfo =
new IRasterRendererClassInfoProxy(pRen);

System.out.println(pRenClassInfo.getClassCount());

if(pRenClassInfo.IsNumericClasses()){
pRenClassInfo.queryNumberClass (0,vMin,vMax,vValue);
}

System.out.println(vMin + " " + vMax + " " + vValue);

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 int getClassCount()
          Number of classes in the renderer.
 String getClassificationField()
          Classification field name or an empty string if a table doesn't exist.
 String getNormalizationField()
          Normalization field name or an empty string if none.
 boolean isNumericClasses()
          Indicates if the classification field is numeric.
 void queryNumberClass(int classIndex, double[] minValue, double[] maxValue, int[] outValue)
          Information for a number class by index.
 void queryStringClass(int classIndex, String[] inValue, int[] outValue)
          Information for a string class by index.
 

Method Detail

getClassificationField

String getClassificationField()
                              throws IOException,
                                     AutomationException
Classification field name or an empty string if a table doesn't exist.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The classFieldName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNormalizationField

String getNormalizationField()
                             throws IOException,
                                    AutomationException
Normalization field name or an empty string if none.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The normFieldName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isNumericClasses

boolean isNumericClasses()
                         throws IOException,
                                AutomationException
Indicates if the classification field is numeric.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The bNumeric
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassCount

int getClassCount()
                  throws IOException,
                         AutomationException
Number of classes in the renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The classCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryNumberClass

void queryNumberClass(int classIndex,
                      double[] minValue,
                      double[] maxValue,
                      int[] outValue)
                      throws IOException,
                             AutomationException
Information for a number class by index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
classIndex - The classIndex (in)
minValue - The minValue (out: use single element array)
maxValue - The maxValue (out: use single element array)
outValue - The outValue (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryStringClass

void queryStringClass(int classIndex,
                      String[] inValue,
                      int[] outValue)
                      throws IOException,
                             AutomationException
Information for a string class by index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
classIndex - The classIndex (in)
inValue - The inValue (out: use single element array)
outValue - The outValue (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.