com.esri.arcgis.carto
Class RasterCatalogRendererPickerDefault

java.lang.Object
  com.esri.arcgis.carto.RasterCatalogRendererPickerDefault

All Implemented Interfaces:

IRasterCatalogRendererPicker, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class RasterCatalogRendererPickerDefault
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterCatalogRendererPicker

A chooser for picking raster renderer for a raster catalog.

Description

The RasterCatalogRendererPickerDefault object defines a set of default raster renderer picking rules that are used by the system in rendering geodatabase raster catalogs.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

RasterCatalogRendererPickerDefault()
Constructs a RasterCatalogRendererPickerDefault using ArcGIS Engine.

RasterCatalogRendererPickerDefault(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterCatalogRendererPickerDefault theRasterCatalogRendererPickerDefault = (RasterCatalogRendererPickerDefault) obj;

Method Summary

boolean	equals(Object o) Compare this object with another
String[]	getAllAvailableRenderersCLSID() The ProgIDs of all available raster renderers.
static String	getClsid() getClsid.
String[]	getDefaultUseRenderersCLSID() The ProgIDs of the default raster renderers.
int	getPriority() The priority of the renderer.
int	hashCode() the hashcode for this object
IRasterRenderer	pick(IArray pRenderers, IRasterDataset pRasterDataset) Chooses the renderers from a given list.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

RasterCatalogRendererPickerDefault

public RasterCatalogRendererPickerDefault()
                                   throws IOException,
                                          UnknownHostException

Constructs a RasterCatalogRendererPickerDefault using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

RasterCatalogRendererPickerDefault

public RasterCatalogRendererPickerDefault(Object obj)
                                   throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterCatalogRendererPickerDefault theRasterCatalogRendererPickerDefault = (RasterCatalogRendererPickerDefault) obj;

Construct a RasterCatalogRendererPickerDefault using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to RasterCatalogRendererPickerDefault.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getPriority

public int getPriority()
                throws IOException,
                       AutomationException

The priority of the renderer.

Remarks

The Priority property returns the priority of this raster catalog renderer picker relative to others in the system. The priority of the system default RasterCatalogRendererPickerDefault object is 0. You need to return a bigger number when you create your custom renderer picker.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPriority in interface IRasterCatalogRendererPicker

Returns:

The pPriority

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultUseRenderersCLSID

public String[] getDefaultUseRenderersCLSID()
                                     throws IOException,
                                            AutomationException

The ProgIDs of the default raster renderers.

Remarks

The DefaultUseRenderersCLSID, a read only property, returns an array of ProgIDs of the raster renderers that are used in rendering the raster catalog layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDefaultUseRenderersCLSID in interface IRasterCatalogRendererPicker

Returns:

The pCLSIDArrayy

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAllAvailableRenderersCLSID

public String[] getAllAvailableRenderersCLSID()
                                       throws IOException,
                                              AutomationException

The ProgIDs of all available raster renderers.

Remarks

The AllAvailableRenderersCLSID property returns an array of ProgIDs of all the available renderers that are associated with the raster catalog layer. An example of ProgID is “esriCarto.RasterRGBRenderer” for the RasterRGBRenderer object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAllAvailableRenderersCLSID in interface IRasterCatalogRendererPicker

Returns:

The pCLSIDArrayy

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

pick

public IRasterRenderer pick(IArray pRenderers,
                            IRasterDataset pRasterDataset)
                     throws IOException,
                            AutomationException

Chooses the renderers from a given list.

Remarks

The Pick method sets the rules for rendering raster datasets in a raster catalog. This is where you can apply your own rendering rules. Based on the property of the input raster dataset, you need to return a renderer from the available renderers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

pick in interface IRasterCatalogRendererPicker

Parameters:

pRenderers - A reference to a com.esri.arcgis.system.IArray (in)

pRasterDataset - A reference to a com.esri.arcgis.geodatabase.IRasterDataset (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.