com.esri.arcgis.datasourcesraster

Class OverviewItemURI

java.lang.Object

com.esri.arcgis.datasourcesraster.OverviewItemURI

All Implemented Interfaces:

ICellSizeLevel, IItemPaths, IItemURI, IOverviewItemURI, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class OverviewItemURI
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IItemURI, IOverviewItemURI, ICellSizeLevel, IItemPaths

COM Class 'OverviewItemURI'. Generated 9/24/2024 11:01:26 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description 'An overview item URI object.' 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 =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.datasourcesraster.IItemURI

IID, IID0fc1719b_b1aa_4d23_af07_932490a18075, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IOverviewItemURI

IID, IID7061751b_3279_4719_86df_bdff9c73c809, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.ICellSizeLevel

IID, IIDcb2f5079_e498_4d7c_aedc_f7ecb4deb021, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IItemPaths

IID, IIDcafd4e87_0672_43e0_b92d_175306c1a309, xxDummy

Constructor Summary

Constructors

Constructor and Description
OverviewItemURI() Constructs a OverviewItemURI using ArcGIS Engine.
OverviewItemURI(java.lang.Object obj) Construct a OverviewItemURI using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

Modifier and Type	Method and Description
void	deleteDataset() Deletes the overview raster dataset.
boolean	equals(java.lang.Object o) Compare this object with another
IStringArray	getAuxiliaryPaths() Paths to all auxiliary data source items that aid in the construction of this item.
double	getCellSize() The cell size value assocated with the level.
static java.lang.String	getClsid() getClsid.
java.lang.String	getDisplayName() The friendly-name identifying this item in the mosaic dataset.
IGeometry	getGeometry() The geometry defining the boundary of the cell size level.
java.lang.String	getGroup() The name of the collection to which the item belongs.
int	getID() The unique ID associated with the cell size level.
java.lang.String	getItemName() Name of the overview item.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
java.lang.String	getKey() A phrase that uniquely identifies the item's data source in the mosaic dataset.
double	getMaximumCellSize() The maximum cell size value associated with the level.
double	getMinimumCellSize() The minimum cell size value associated with the level.
IEnvelope	getNativeExtent() The original extent of the overview item URI.
IStringArray	getPaths() Returns all paths associated with the object.
java.lang.String	getProductName() The name of the sensor product associated with the item's data source.
IRasterInfo	getRasterInfo() The RasterInfo object describing a dummy overview tile.
java.util.Date	getSourceTimeStamp() The timestamp associated with the data source referenced by this item URI.
IName	getStorageName() Name of the storage location for the overview raster dataset.
java.lang.String	getTag() The unique identifier of the item within a group.
int	getTileColOffset() The column offset of the overview tile in the grid.
int	getTileRowOffset() The row offset of the overview tile in the grid.
int	hashCode() the hashcode for this object
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	release() Release this COM object reference
void	replacePaths(IStringArray pOldPaths, IStringArray pNewPaths) Updates all paths associated with the object using the specified mapping rule.
void	setAuxiliaryPathsByRef(IStringArray ppAuxiliaryPaths) Paths to all auxiliary data source items that aid in the construction of this item.
void	setCellSize(double pCellsize) The cell size value assocated with the level.
void	setDisplayName(java.lang.String pDisplayName) The friendly-name identifying this item in the mosaic dataset.
void	setGeometryByRef(IGeometry ppLevelBoundary) The geometry defining the boundary of the cell size level.
void	setGroup(java.lang.String pItemGroup) The name of the collection to which the item belongs.
void	setID(int pDescriptionID) The unique ID associated with the cell size level.
void	setItemName(java.lang.String pItemName) Name of the overview item.
void	setKey(java.lang.String pKeyString) A phrase that uniquely identifies the item's data source in the mosaic dataset.
void	setMaximumCellSize(double pMaximumCellSize) The maximum cell size value associated with the level.
void	setMinimumCellSize(double pMinimumCellSize) The minimum cell size value associated with the level.
void	setNativeExtentByRef(IEnvelope ppEnvelope) The original extent of the overview item URI.
void	setProductName(java.lang.String pProductName) The name of the sensor product associated with the item's data source.
void	setRasterInfoByRef(IRasterInfo ppRasterInfo) The RasterInfo object describing a dummy overview tile.
void	setSourceTimeStamp(java.util.Date pSourceTimeStamp) The timestamp associated with the data source referenced by this item URI.
void	setStorageNameByRef(IName ppStorageName) Name of the storage location for the overview raster dataset.
void	setTag(java.lang.String pItemTag) The unique identifier of the item within a group.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

OverviewItemURI

public OverviewItemURI()
                throws java.io.IOException,
                       java.net.UnknownHostException

Constructs a OverviewItemURI using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

OverviewItemURI

public OverviewItemURI(java.lang.Object obj)
                throws java.io.IOException

Construct a OverviewItemURI using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to OverviewItemURI.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems OverviewItemURI theOverviewItemURI = (OverviewItemURI) obj;

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

setKey

public void setKey(java.lang.String pKeyString)
            throws java.io.IOException,
                   AutomationException

A phrase that uniquely identifies the item's data source in the mosaic dataset. The value in this property is used for computing a 'signature' that appears in the URIHash field of the mosaic catalog.

Specified by:

setKey in interface IItemURI

Parameters:

pKeyString - The pKeyString (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getKey

public java.lang.String getKey()
                        throws java.io.IOException,
                               AutomationException

A phrase that uniquely identifies the item's data source in the mosaic dataset. The value in this property is used for computing a 'signature' that appears in the URIHash field of the mosaic catalog.

Specified by:

getKey in interface IItemURI

Returns:

The pKeyString

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTag

public void setTag(java.lang.String pItemTag)
            throws java.io.IOException,
                   AutomationException

The unique identifier of the item within a group. The value in this property appears in the Tag field of the mosaic catalog.

Specified by:

setTag in interface IItemURI

Parameters:

pItemTag - The pItemTag (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTag

public java.lang.String getTag()
                        throws java.io.IOException,
                               AutomationException

The unique identifier of the item within a group. The value in this property appears in the Tag field of the mosaic catalog.

Specified by:

getTag in interface IItemURI

Returns:

The pItemTag

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGroup

public void setGroup(java.lang.String pItemGroup)
              throws java.io.IOException,
                     AutomationException

The name of the collection to which the item belongs. The value in this property appears in the GroupName field of the mosaic catalog.

Specified by:

setGroup in interface IItemURI

Parameters:

pItemGroup - The pItemGroup (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGroup

public java.lang.String getGroup()
                          throws java.io.IOException,
                                 AutomationException

The name of the collection to which the item belongs. The value in this property appears in the GroupName field of the mosaic catalog.

Specified by:

getGroup in interface IItemURI

Returns:

The pItemGroup

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayName

public void setDisplayName(java.lang.String pDisplayName)
                    throws java.io.IOException,
                           AutomationException

The friendly-name identifying this item in the mosaic dataset. The value in this property appears in the Name field of the mosaic catalog.

Specified by:

setDisplayName in interface IItemURI

Parameters:

pDisplayName - The pDisplayName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayName

public java.lang.String getDisplayName()
                                throws java.io.IOException,
                                       AutomationException

The friendly-name identifying this item in the mosaic dataset. The value in this property appears in the Name field of the mosaic catalog.

Specified by:

getDisplayName in interface IItemURI

Returns:

The pDisplayName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProductName

public void setProductName(java.lang.String pProductName)
                    throws java.io.IOException,
                           AutomationException

The name of the sensor product associated with the item's data source. The value in this property appears in the ProductName field of the mosaic catalog.

Specified by:

setProductName in interface IItemURI

Parameters:

pProductName - The pProductName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProductName

public java.lang.String getProductName()
                                throws java.io.IOException,
                                       AutomationException

The name of the sensor product associated with the item's data source. The value in this property appears in the ProductName field of the mosaic catalog.

Specified by:

getProductName in interface IItemURI

Returns:

The pProductName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourceTimeStamp

public void setSourceTimeStamp(java.util.Date pSourceTimeStamp)
                        throws java.io.IOException,
                               AutomationException

The timestamp associated with the data source referenced by this item URI.

Specified by:

setSourceTimeStamp in interface IItemURI

Parameters:

pSourceTimeStamp - The pSourceTimeStamp (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourceTimeStamp

public java.util.Date getSourceTimeStamp()
                                  throws java.io.IOException,
                                         AutomationException

The timestamp associated with the data source referenced by this item URI.

Specified by:

getSourceTimeStamp in interface IItemURI

Returns:

The pSourceTimeStamp

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAuxiliaryPathsByRef

public void setAuxiliaryPathsByRef(IStringArray ppAuxiliaryPaths)
                            throws java.io.IOException,
                                   AutomationException

Paths to all auxiliary data source items that aid in the construction of this item.

Specified by:

setAuxiliaryPathsByRef in interface IItemURI

Parameters:

ppAuxiliaryPaths - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAuxiliaryPaths

public IStringArray getAuxiliaryPaths()
                               throws java.io.IOException,
                                      AutomationException

Paths to all auxiliary data source items that aid in the construction of this item.

Specified by:

getAuxiliaryPaths in interface IItemURI

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setItemName

public void setItemName(java.lang.String pItemName)
                 throws java.io.IOException,
                        AutomationException

Name of the overview item.

Specified by:

setItemName in interface IOverviewItemURI

Parameters:

pItemName - The pItemName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getItemName

public java.lang.String getItemName()
                             throws java.io.IOException,
                                    AutomationException

Name of the overview item.

Specified by:

getItemName in interface IOverviewItemURI

Returns:

The pItemName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStorageNameByRef

public void setStorageNameByRef(IName ppStorageName)
                         throws java.io.IOException,
                                AutomationException

Name of the storage location for the overview raster dataset.

Specified by:

setStorageNameByRef in interface IOverviewItemURI

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

public IName getStorageName()
                     throws java.io.IOException,
                            AutomationException

Name of the storage location for the overview raster dataset.

Specified by:

getStorageName in interface IOverviewItemURI

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

public boolean isDatasetExists()
                        throws java.io.IOException,
                               AutomationException

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

Specified by:

isDatasetExists in interface IOverviewItemURI

Returns:

The pbDatasetExists

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isManagedDataset

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

Specified by:

isManagedDataset in interface IOverviewItemURI

Returns:

The pbIsManagedDataset

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteDataset

public void deleteDataset()
                   throws java.io.IOException,
                          AutomationException

Deletes the overview raster dataset.

Specified by:

deleteDataset in interface IOverviewItemURI

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateDataset

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

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTileRowOffset

public void setTileRowOffset(int pTileRowOffset)
                      throws java.io.IOException,
                             AutomationException

The row offset of the overview tile in the grid.

Specified by:

setTileRowOffset in interface IOverviewItemURI

Parameters:

pTileRowOffset - The pTileRowOffset (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTileRowOffset

public int getTileRowOffset()
                     throws java.io.IOException,
                            AutomationException

The row offset of the overview tile in the grid.

Specified by:

getTileRowOffset in interface IOverviewItemURI

Returns:

The pTileRowOffset

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTileColOffset

public void setTileColOffset(int pTileColOffset)
                      throws java.io.IOException,
                             AutomationException

The column offset of the overview tile in the grid.

Specified by:

setTileColOffset in interface IOverviewItemURI

Parameters:

pTileColOffset - The pTileColOffset (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTileColOffset

public int getTileColOffset()
                     throws java.io.IOException,
                            AutomationException

The column offset of the overview tile in the grid.

Specified by:

getTileColOffset in interface IOverviewItemURI

Returns:

The pTileColOffset

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNativeExtentByRef

public void setNativeExtentByRef(IEnvelope ppEnvelope)
                          throws java.io.IOException,
                                 AutomationException

The original extent of the overview item URI.

Specified by:

setNativeExtentByRef in interface IOverviewItemURI

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

public IEnvelope getNativeExtent()
                          throws java.io.IOException,
                                 AutomationException

The original extent of the overview item URI.

Specified by:

getNativeExtent in interface IOverviewItemURI

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

public void setRasterInfoByRef(IRasterInfo ppRasterInfo)
                        throws java.io.IOException,
                               AutomationException

The RasterInfo object describing a dummy overview tile.

Specified by:

setRasterInfoByRef in interface IOverviewItemURI

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

public IRasterInfo getRasterInfo()
                          throws java.io.IOException,
                                 AutomationException

The RasterInfo object describing a dummy overview tile.

Specified by:

getRasterInfo in interface IOverviewItemURI

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.

setCellSize

public void setCellSize(double pCellsize)
                 throws java.io.IOException,
                        AutomationException

The cell size value assocated with the level.

Specified by:

setCellSize in interface ICellSizeLevel

Parameters:

pCellsize - The pCellsize (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCellSize

public double getCellSize()
                   throws java.io.IOException,
                          AutomationException

The cell size value assocated with the level.

Specified by:

getCellSize in interface ICellSizeLevel

Returns:

The pCellsize

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGeometryByRef

public void setGeometryByRef(IGeometry ppLevelBoundary)
                      throws java.io.IOException,
                             AutomationException

The geometry defining the boundary of the cell size level.

Specified by:

setGeometryByRef in interface ICellSizeLevel

Parameters:

ppLevelBoundary - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGeometry

public IGeometry getGeometry()
                      throws java.io.IOException,
                             AutomationException

The geometry defining the boundary of the cell size level.

Specified by:

getGeometry in interface ICellSizeLevel

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinimumCellSize

public void setMinimumCellSize(double pMinimumCellSize)
                        throws java.io.IOException,
                               AutomationException

The minimum cell size value associated with the level.

Specified by:

setMinimumCellSize in interface ICellSizeLevel

Parameters:

pMinimumCellSize - The pMinimumCellSize (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinimumCellSize

public double getMinimumCellSize()
                          throws java.io.IOException,
                                 AutomationException

The minimum cell size value associated with the level.

Specified by:

getMinimumCellSize in interface ICellSizeLevel

Returns:

The pMinimumCellSize

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaximumCellSize

public void setMaximumCellSize(double pMaximumCellSize)
                        throws java.io.IOException,
                               AutomationException

The maximum cell size value associated with the level.

Specified by:

setMaximumCellSize in interface ICellSizeLevel

Parameters:

pMaximumCellSize - The pMaximumCellSize (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaximumCellSize

public double getMaximumCellSize()
                          throws java.io.IOException,
                                 AutomationException

The maximum cell size value associated with the level.

Specified by:

getMaximumCellSize in interface ICellSizeLevel

Returns:

The pMaximumCellSize

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setID

public void setID(int pDescriptionID)
           throws java.io.IOException,
                  AutomationException

The unique ID associated with the cell size level.

Specified by:

setID in interface ICellSizeLevel

Parameters:

pDescriptionID - The pDescriptionID (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getID

public int getID()
          throws java.io.IOException,
                 AutomationException

The unique ID associated with the cell size level.

Specified by:

getID in interface ICellSizeLevel

Returns:

The pDescriptionID

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPaths

public IStringArray getPaths()
                      throws java.io.IOException,
                             AutomationException

Returns all paths associated with the object.

Specified by:

getPaths in interface IItemPaths

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

replacePaths

public void replacePaths(IStringArray pOldPaths,
                         IStringArray pNewPaths)
                  throws java.io.IOException,
                         AutomationException

Updates all paths associated with the object using the specified mapping rule. The number of values in the two arrays must be the same.

Specified by:

replacePaths in interface IItemPaths

Parameters:

pOldPaths - A reference to a com.esri.arcgis.system.IStringArray (in)

pNewPaths - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.