com.esri.arcgis.datasourcesraster
Interface IMosaicRaster

All Superinterfaces:

Serializable

All Known Implementing Classes:

MosaicRaster

public interface IMosaicRaster
extends Serializable

Provides access to members that control a MosaicRaster.

Description

IMosaicRaster allows you to specify the raster catalog or the selection on a raster catalog to be mosaicked. A custom MosaicOperator or a predefined MosaicOperatorType for overlapping areas can also be set. If the raster datasets have colormap, setting the MosaicColormapMode will manipulate the colormap of the output mosaic.

Product Availability

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

See Also:

MosaicRaster

Method Summary

IRasterColormap	getColormap() The colormap to be used.
int	getMosaicColormapMode() The current mode for mosaicking pseucolor rasters.
IMosaicOperator	getMosaicOperator() The current mosaic operator.
int	getMosaicOperatorType() The current mosaic operator type.
String	getOrderByField() The Order By fields on the base RasterCatalog.
IRasterCatalog	getRasterCatalog() The base RasterCatalog.
String	getWhereClause() The Where Clause on the base RasterCatalog.
boolean	isAscending() Indicates whether the ascending flag of OrderBy.
void	setAscending(boolean ascending) Indicates whether the ascending flag of OrderBy.
void	setColormap(IRasterColormap ppColormap) The colormap to be used.
void	setMosaicColormapMode(int mode) The current mode for mosaicking pseucolor rasters.
void	setMosaicOperatorByRef(IMosaicOperator op) The current mosaic operator.
void	setMosaicOperatorType(int type) The current mosaic operator type.
void	setOrderByField(String orderByField) The Order By fields on the base RasterCatalog.
void	setRasterCatalogByRef(IRasterCatalog ppCatalog) The base RasterCatalog.
void	setWhereClause(String whereClause) The Where Clause on the base RasterCatalog.

Method Detail

getRasterCatalog

IRasterCatalog getRasterCatalog()
                                throws IOException,
                                       AutomationException

The base RasterCatalog.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.geodatabase.IRasterCatalog

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRasterCatalogByRef

void setRasterCatalogByRef(IRasterCatalog ppCatalog)
                           throws IOException,
                                  AutomationException

The base RasterCatalog.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

ppCatalog - A reference to a com.esri.arcgis.geodatabase.IRasterCatalog (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWhereClause

String getWhereClause()
                      throws IOException,
                             AutomationException

The Where Clause on the base RasterCatalog.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The whereClause

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWhereClause

void setWhereClause(String whereClause)
                    throws IOException,
                           AutomationException

The Where Clause on the base RasterCatalog.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

whereClause - The whereClause (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOrderByField

String getOrderByField()
                       throws IOException,
                              AutomationException

The Order By fields on the base RasterCatalog.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The orderByField

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOrderByField

void setOrderByField(String orderByField)
                     throws IOException,
                            AutomationException

The Order By fields on the base RasterCatalog.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

orderByField - The orderByField (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAscending

boolean isAscending()
                    throws IOException,
                           AutomationException

Indicates whether the ascending flag of OrderBy.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The ascending

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAscending

void setAscending(boolean ascending)
                  throws IOException,
                         AutomationException

Indicates whether the ascending flag of OrderBy.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

ascending - The ascending (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMosaicOperatorType

int getMosaicOperatorType()
                          throws IOException,
                                 AutomationException

The current mosaic operator type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.datasourcesraster.rstMosaicOperatorType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMosaicOperatorType

void setMosaicOperatorType(int type)
                           throws IOException,
                                  AutomationException

The current mosaic operator type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

type - A com.esri.arcgis.datasourcesraster.rstMosaicOperatorType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMosaicOperator

IMosaicOperator getMosaicOperator()
                                  throws IOException,
                                         AutomationException

The current mosaic operator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMosaicOperatorByRef

void setMosaicOperatorByRef(IMosaicOperator op)
                            throws IOException,
                                   AutomationException

The current mosaic operator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

op - A reference to a com.esri.arcgis.datasourcesraster.IMosaicOperator (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMosaicColormapMode

int getMosaicColormapMode()
                          throws IOException,
                                 AutomationException

The current mode for mosaicking pseucolor rasters.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.datasourcesraster.rstMosaicColormapMode constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMosaicColormapMode

void setMosaicColormapMode(int mode)
                           throws IOException,
                                  AutomationException

The current mode for mosaicking pseucolor rasters.

Remarks

It is only applicable to ArcSDE rasters.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

mode - A com.esri.arcgis.datasourcesraster.rstMosaicColormapMode constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColormap

IRasterColormap getColormap()
                            throws IOException,
                                   AutomationException

The colormap to be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.geodatabase.IRasterColormap

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColormap

void setColormap(IRasterColormap ppColormap)
                 throws IOException,
                        AutomationException

The colormap to be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

ppColormap - A reference to a com.esri.arcgis.geodatabase.IRasterColormap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.