com.esri.arcgis.carto
Interface IRenderingRule

All Superinterfaces:

Serializable

All Known Implementing Classes:

RenderingRule

public interface IRenderingRule
extends Serializable

Provides access to members that control a rendering rule.

Description

IRenderingRule interface provides methods defining how an image service should be rendered to generate the requested image. A rendering rule consists of: (1) a raster function; (2) a raster renderer; (3) a name and description of a rendering rule that is defined on the image service. The raster function will be applied first to the image service, and followed by the raster renderer. The result will then be converted to requested format, e.g. jpeg, png, bmp, and etc. If the function and renderer are both missing, the name is assumed to be a rendering rule available on the service. If there is no rendering rule, and the image service still needs to be rendered to generate the requested image, a default renderer will be applied. A proper default renderer is created using the same rule as when a raster dataset of the same properties, e.g. number of band, pixel type, and etc is added to ArcMap.

Product Availability

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

Method Summary

IRasterFunctionArguments	getArguments() The raster function arguments.
String	getDescription() The rendering rule description.
IRasterFunction	getFunction() The raster function.
String	getName() The rendering rule name.
IRasterRenderer	getRenderer() The raster renderer.
String	getVariableName() The raster function variable name.
void	setArgumentsByRef(IRasterFunctionArguments ppArguments) The raster function arguments.
void	setDescription(String pDescription) The rendering rule description.
void	setFunctionByRef(IRasterFunction ppFunction) The raster function.
void	setName(String pName) The rendering rule name.
void	setRendererByRef(IRasterRenderer ppRenderer) The raster renderer.
void	setVariableName(String pVariableName) The raster function variable name.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

The rendering rule name.

Product Availability

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

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(String pName)
             throws IOException,
                    AutomationException

The rendering rule name.

Description

The rendering rule name. This is used to address a predefined rendering rule on the service when both the raster function and renderer are not specified.

Product Availability

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

Parameters:

pName - The pName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

String getDescription()
                      throws IOException,
                             AutomationException

The rendering rule description.

Product Availability

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

Returns:

The pDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

void setDescription(String pDescription)
                    throws IOException,
                           AutomationException

The rendering rule description.

Product Availability

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

Parameters:

pDescription - The pDescription (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFunction

IRasterFunction getFunction()
                            throws IOException,
                                   AutomationException

The raster function.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IRasterFunction

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFunctionByRef

void setFunctionByRef(IRasterFunction ppFunction)
                      throws IOException,
                             AutomationException

The raster function.

Description

It takes RasterFuntion object.The RasterFunction together with its arguments (RasterFunctionArguments) will be applied to the target service. The target image service will be assigned to the named argument of the function’s argument list, and the argument list is then bound to the function.

Product Availability

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

Parameters:

ppFunction - A reference to a com.esri.arcgis.datasourcesraster.IRasterFunction (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getArguments

IRasterFunctionArguments getArguments()
                                      throws IOException,
                                             AutomationException

The raster function arguments.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IRasterFunctionArguments

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setArgumentsByRef

void setArgumentsByRef(IRasterFunctionArguments ppArguments)
                       throws IOException,
                              AutomationException

The raster function arguments.

Description

The raster function arguments. One of the named arguments will be set using the target service.

Product Availability

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

Parameters:

ppArguments - A reference to a com.esri.arcgis.datasourcesraster.IRasterFunctionArguments (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVariableName

String getVariableName()
                       throws IOException,
                              AutomationException

The raster function variable name.

Product Availability

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

Returns:

The pVariableName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVariableName

void setVariableName(String pVariableName)
                     throws IOException,
                            AutomationException

The raster function variable name.

Description

The variable name in the list of named function arguments to which the target image service should be assigned.

Remarks

This could be "Raster" for ExtractBandFunction, "DEM" for HillshadeFunction, etc.

Product Availability

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

Parameters:

pVariableName - The pVariableName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRenderer

IRasterRenderer getRenderer()
                            throws IOException,
                                   AutomationException

The raster renderer.

Product Availability

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

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.

setRendererByRef

void setRendererByRef(IRasterRenderer ppRenderer)
                      throws IOException,
                             AutomationException

The raster renderer.

Description

The raster renderer. The raster renderer will be used to render the target service, after the function is applied, to generate a requested image.

Product Availability

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

Parameters:

ppRenderer - A reference to a com.esri.arcgis.carto.IRasterRenderer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.