com.esri.arcgis.datasourcesraster
Class IOverviewItemURIProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.datasourcesraster.IOverviewItemURIProxy

All Implemented Interfaces:

IOverviewItemURI, Externalizable, Serializable

public class IOverviewItemURIProxy
extends com.esri.arcgis.interop.Dispatch
implements IOverviewItemURI, Serializable

Provides access to members that control an overview item URI.

Product Availability

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

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IOverviewItemURIProxy()
	IOverviewItemURIProxy(Object obj)
protected	IOverviewItemURIProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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	removeListener(String iidStr, Object theListener)
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.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IOverviewItemURIProxy

public IOverviewItemURIProxy()

IOverviewItemURIProxy

public IOverviewItemURIProxy(Object obj)
                      throws IOException

Throws:

IOException

IOverviewItemURIProxy

protected IOverviewItemURIProxy(Object obj,
                                String iid)
                         throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

setItemName

public void setItemName(String pItemName)
                 throws IOException,
                        AutomationException

Name of the overview item.

Product Availability

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

Specified by:

setItemName in interface IOverviewItemURI

Parameters:

pItemName - The pItemName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getItemName

public String getItemName()
                   throws IOException,
                          AutomationException

Name of the overview item.

Product Availability

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

Specified by:

getItemName in interface IOverviewItemURI

Returns:

The pItemName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStorageNameByRef

public 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.

Specified by:

setStorageNameByRef in interface IOverviewItemURI

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

public 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.

Specified by:

getStorageName in interface IOverviewItemURI

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

public 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.

Specified by:

isDatasetExists in interface IOverviewItemURI

Returns:

The pbDatasetExists

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isManagedDataset

public 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.

Specified by:

isManagedDataset in interface IOverviewItemURI

Returns:

The pbIsManagedDataset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteDataset

public void deleteDataset()
                   throws IOException,
                          AutomationException

Deletes the overview raster dataset.

Product Availability

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

Specified by:

deleteDataset in interface IOverviewItemURI

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateDataset

public 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.

Specified by:

updateDataset in interface IOverviewItemURI

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

public 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.

Specified by:

setTileRowOffset in interface IOverviewItemURI

Parameters:

pTileRowOffset - The pTileRowOffset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTileRowOffset

public 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.

Specified by:

getTileRowOffset in interface IOverviewItemURI

Returns:

The pTileRowOffset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTileColOffset

public 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.

Specified by:

setTileColOffset in interface IOverviewItemURI

Parameters:

pTileColOffset - The pTileColOffset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTileColOffset

public 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.

Specified by:

getTileColOffset in interface IOverviewItemURI

Returns:

The pTileColOffset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNativeExtentByRef

public 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.

Specified by:

setNativeExtentByRef in interface IOverviewItemURI

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

public IEnvelope getNativeExtent()
                          throws IOException,
                                 AutomationException

The original extent of the overview item URI.

Product Availability

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

Specified by:

getNativeExtent in interface IOverviewItemURI

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

public 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.

Specified by:

setRasterInfoByRef in interface IOverviewItemURI

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

public IRasterInfo getRasterInfo()
                          throws IOException,
                                 AutomationException

The RasterInfo object describing a dummy overview tile.

Product Availability

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

Specified by:

getRasterInfo in interface IOverviewItemURI

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.