com.esri.arcgis.datasourcesraster
Interface IOverviewItemURI

All Superinterfaces:

Serializable

All Known Implementing Classes:

IOverviewItemURIProxy, OverviewItemURI

public interface IOverviewItemURI
extends Serializable

Provides access to members that control an overview item URI.

Product Availability

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

Method Summary

void	deleteDataset() Deletes the overview raster dataset.
String	getItemName() Name of the overview item.
IEnvelope	getNativeExtent() The original extent of the overview item URI.
IRasterInfo	getRasterInfo() The RasterInfo object describing a dummy overview tile.
IName	getStorageName() Name of the storage location for the overview raster dataset.
int	getTileColOffset() The column offset of the overview tile in the grid.
int	getTileRowOffset() The row offset of the overview tile in the grid.
boolean	isDatasetExists() Indicates whether the overview raster dataset exists in the storage location.
boolean	isManagedDataset() Indicates whether the mosaic dataset manages the lifetime of the overview raster dataset.
void	setItemName(String pItemName) Name of the overview item.
void	setNativeExtentByRef(IEnvelope ppEnvelope) The original extent of the overview item URI.
void	setRasterInfoByRef(IRasterInfo ppRasterInfo) The RasterInfo object describing a dummy overview tile.
void	setStorageNameByRef(IName ppStorageName) Name of the storage location for the overview raster dataset.
void	setTileColOffset(int pTileColOffset) The column offset of the overview tile in the grid.
void	setTileRowOffset(int pTileRowOffset) The row offset of the overview tile in the grid.
IRasterDataset	updateDataset(IRaster pRaster, String imageFormatName, IRasterStorageDef pRasterStorageDef) Regenerates and returns the overview raster dataset using a raster object and storage definition.

Method Detail

setItemName

void setItemName(String pItemName)
                 throws IOException,
                        AutomationException

Name of the overview item.

Product Availability

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

Parameters:

pItemName - The pItemName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getItemName

String getItemName()
                   throws IOException,
                          AutomationException

Name of the overview item.

Product Availability

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

Returns:

The pItemName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStorageNameByRef

void setStorageNameByRef(IName ppStorageName)
                         throws IOException,
                                AutomationException

Name of the storage location for the overview raster dataset.

Product Availability

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

Parameters:

ppStorageName - A reference to a com.esri.arcgis.system.IName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStorageName

IName getStorageName()
                     throws IOException,
                            AutomationException

Name of the storage location for the overview raster dataset.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.system.IName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDatasetExists

boolean isDatasetExists()
                        throws IOException,
                               AutomationException

Indicates whether the overview raster dataset exists in the storage location.

Product Availability

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

Returns:

The pbDatasetExists

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isManagedDataset

boolean isManagedDataset()
                         throws IOException,
                                AutomationException

Indicates whether the mosaic dataset manages the lifetime of the overview raster dataset. Raster datasets associated with managed overview items are moved, copied, and deleted along with the parent mosaic dataset.

Product Availability

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

Returns:

The pbIsManagedDataset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteDataset

void deleteDataset()
                   throws IOException,
                          AutomationException

Deletes the overview raster dataset.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateDataset

IRasterDataset updateDataset(IRaster pRaster,
                             String imageFormatName,
                             IRasterStorageDef pRasterStorageDef)
                             throws IOException,
                                    AutomationException

Regenerates and returns the overview raster dataset using a raster object and storage definition.

Product Availability

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

Parameters:

pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

imageFormatName - The imageFormatName (in)

pRasterStorageDef - A reference to a com.esri.arcgis.geodatabase.IRasterStorageDef (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTileRowOffset

void setTileRowOffset(int pTileRowOffset)
                      throws IOException,
                             AutomationException

The row offset of the overview tile in the grid.

Product Availability

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

Parameters:

pTileRowOffset - The pTileRowOffset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTileRowOffset

int getTileRowOffset()
                     throws IOException,
                            AutomationException

The row offset of the overview tile in the grid.

Product Availability

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

Returns:

The pTileRowOffset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTileColOffset

void setTileColOffset(int pTileColOffset)
                      throws IOException,
                             AutomationException

The column offset of the overview tile in the grid.

Product Availability

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

Parameters:

pTileColOffset - The pTileColOffset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTileColOffset

int getTileColOffset()
                     throws IOException,
                            AutomationException

The column offset of the overview tile in the grid.

Product Availability

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

Returns:

The pTileColOffset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNativeExtentByRef

void setNativeExtentByRef(IEnvelope ppEnvelope)
                          throws IOException,
                                 AutomationException

The original extent of the overview item URI.

Product Availability

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

Parameters:

ppEnvelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNativeExtent

IEnvelope getNativeExtent()
                          throws IOException,
                                 AutomationException

The original extent of the overview item URI.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRasterInfoByRef

void setRasterInfoByRef(IRasterInfo ppRasterInfo)
                        throws IOException,
                               AutomationException

The RasterInfo object describing a dummy overview tile.

Product Availability

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

Parameters:

ppRasterInfo - A reference to a com.esri.arcgis.datasourcesraster.IRasterInfo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRasterInfo

IRasterInfo getRasterInfo()
                          throws IOException,
                                 AutomationException

The RasterInfo object describing a dummy overview tile.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.