com.esri.arcgis.datasourcesraster
Interface IOverviewBuilder

All Superinterfaces:

Serializable

All Known Implementing Classes:

IOverviewBuilderProxy, OverviewBuilder

public interface IOverviewBuilder
extends Serializable

Provides access to members that control an overview builder.

Product Availability

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

Method Summary

boolean	generateImage(IOverviewItemURI pItemURI) Generates the overview raster dataset associated with the specified overview item URI object.
ICellSizeLevels	getCellSizeLevels() The cell size levels associated with the overview tiling schema.
IDefineOverviewsParameters	getOverviewParameters() The parameters object that control how overview items are created.
void	setCellSizeLevelsByRef(ICellSizeLevels ppCellSizeLevels) The cell size levels associated with the overview tiling schema.
void	setOverviewParametersByRef(IDefineOverviewsParameters ppParameters) The parameters object that control how overview items are created.

Method Detail

setOverviewParametersByRef

void setOverviewParametersByRef(IDefineOverviewsParameters ppParameters)
                                throws IOException,
                                       AutomationException

The parameters object that control how overview items are created.

Product Availability

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

Parameters:

ppParameters - A reference to a com.esri.arcgis.datasourcesraster.IDefineOverviewsParameters (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOverviewParameters

IDefineOverviewsParameters getOverviewParameters()
                                                 throws IOException,
                                                        AutomationException

The parameters object that control how overview items are created.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCellSizeLevelsByRef

void setCellSizeLevelsByRef(ICellSizeLevels ppCellSizeLevels)
                            throws IOException,
                                   AutomationException

The cell size levels associated with the overview tiling schema.

Product Availability

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

Parameters:

ppCellSizeLevels - A reference to a com.esri.arcgis.datasourcesraster.ICellSizeLevels (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCellSizeLevels

ICellSizeLevels getCellSizeLevels()
                                  throws IOException,
                                         AutomationException

The cell size levels associated with the overview tiling schema.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

generateImage

boolean generateImage(IOverviewItemURI pItemURI)
                      throws IOException,
                             AutomationException

Generates the overview raster dataset associated with the specified overview item URI object.

Product Availability

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

Parameters:

pItemURI - A reference to a com.esri.arcgis.datasourcesraster.IOverviewItemURI (in)

Returns:

The pbAllParticipantsOK

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.