com.esri.arcgis.datasourcesraster
Interface IOverviewItemURI

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
IOverviewItemURIProxy, OverviewItemURI

public interface IOverviewItemURI
extends java.io.Serializable

COM Interface 'IOverviewItemURI'. Generated 3/19/2015 1:20:55 PM from 'C:\ArcGIS\COM\esriDataSourcesRaster.olb'

Description: 'Provides access to members that control an overview item URI.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IID7061751b_3279_4719_86df_bdff9c73c809
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void deleteDataset()
          Deletes the overview raster dataset.
 java.lang.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(java.lang.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, java.lang.String imageFormatName, IRasterStorageDef pRasterStorageDef)
          Regenerates and returns the overview raster dataset using a raster object and storage definition.
 

Field Detail

IID7061751b_3279_4719_86df_bdff9c73c809

static final int IID7061751b_3279_4719_86df_bdff9c73c809
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

setItemName

void setItemName(java.lang.String pItemName)
                 throws java.io.IOException,
                        AutomationException
Name of the overview item.

Parameters:
pItemName - The pItemName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getItemName

java.lang.String getItemName()
                             throws java.io.IOException,
                                    AutomationException
Name of the overview item.

Returns:
The pItemName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStorageNameByRef

void setStorageNameByRef(IName ppStorageName)
                         throws java.io.IOException,
                                AutomationException
Name of the storage location for the overview raster dataset.

Parameters:
ppStorageName - A reference to a com.esri.arcgis.system.IName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStorageName

IName getStorageName()
                     throws java.io.IOException,
                            AutomationException
Name of the storage location for the overview raster dataset.

Returns:
A reference to a com.esri.arcgis.system.IName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDatasetExists

boolean isDatasetExists()
                        throws java.io.IOException,
                               AutomationException
Indicates whether the overview raster dataset exists in the storage location.

Returns:
The pbDatasetExists
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isManagedDataset

boolean isManagedDataset()
                         throws java.io.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.

Returns:
The pbIsManagedDataset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteDataset

void deleteDataset()
                   throws java.io.IOException,
                          AutomationException
Deletes the overview raster dataset.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateDataset

IRasterDataset updateDataset(IRaster pRaster,
                             java.lang.String imageFormatName,
                             IRasterStorageDef pRasterStorageDef)
                             throws java.io.IOException,
                                    AutomationException
Regenerates and returns the overview raster dataset using a raster object and storage definition.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTileRowOffset

void setTileRowOffset(int pTileRowOffset)
                      throws java.io.IOException,
                             AutomationException
The row offset of the overview tile in the grid.

Parameters:
pTileRowOffset - The pTileRowOffset (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTileRowOffset

int getTileRowOffset()
                     throws java.io.IOException,
                            AutomationException
The row offset of the overview tile in the grid.

Returns:
The pTileRowOffset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTileColOffset

void setTileColOffset(int pTileColOffset)
                      throws java.io.IOException,
                             AutomationException
The column offset of the overview tile in the grid.

Parameters:
pTileColOffset - The pTileColOffset (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTileColOffset

int getTileColOffset()
                     throws java.io.IOException,
                            AutomationException
The column offset of the overview tile in the grid.

Returns:
The pTileColOffset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNativeExtentByRef

void setNativeExtentByRef(IEnvelope ppEnvelope)
                          throws java.io.IOException,
                                 AutomationException
The original extent of the overview item URI.

Parameters:
ppEnvelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNativeExtent

IEnvelope getNativeExtent()
                          throws java.io.IOException,
                                 AutomationException
The original extent of the overview item URI.

Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRasterInfoByRef

void setRasterInfoByRef(IRasterInfo ppRasterInfo)
                        throws java.io.IOException,
                               AutomationException
The RasterInfo object describing a dummy overview tile.

Parameters:
ppRasterInfo - A reference to a com.esri.arcgis.datasourcesraster.IRasterInfo (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRasterInfo

IRasterInfo getRasterInfo()
                          throws java.io.IOException,
                                 AutomationException
The RasterInfo object describing a dummy overview tile.

Returns:
A reference to a com.esri.arcgis.datasourcesraster.IRasterInfo
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.