com.esri.arcgis.datasourcesraster
Interface IItemURI

All Superinterfaces:

Serializable

All Known Subinterfaces:

IItemURI2

All Known Implementing Classes:

CellSizeLevel, CompositeItemURI, FileItemURI, IItemURIProxy, IndexedItemURI, ItemURI, MultiPartItemURI, OverviewItemURI, RasterTypeItemURI, RPFItemURI

public interface IItemURI
extends Serializable

Provides access to members that control an item URI.

Product Availability

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

Method Summary

IStringArray	getAuxiliaryPaths() Paths to all auxiliary data source items that aid in the construction of this item.
String	getDisplayName() The friendly-name identifying this item in the mosaic dataset.
String	getGroup() The name of the collection to which the item belongs.
String	getKey() A phrase that uniquely identifies the item's data source in the mosaic dataset.
String	getProductName() The name of the sensor product associated with the item's data source.
Date	getSourceTimeStamp() The timestamp associated with the data source referenced by this item URI.
String	getTag() The unique identifier of the item within a group.
void	setAuxiliaryPathsByRef(IStringArray ppAuxiliaryPaths) Paths to all auxiliary data source items that aid in the construction of this item.
void	setDisplayName(String pDisplayName) The friendly-name identifying this item in the mosaic dataset.
void	setGroup(String pItemGroup) The name of the collection to which the item belongs.
void	setKey(String pKeyString) A phrase that uniquely identifies the item's data source in the mosaic dataset.
void	setProductName(String pProductName) The name of the sensor product associated with the item's data source.
void	setSourceTimeStamp(Date pSourceTimeStamp) The timestamp associated with the data source referenced by this item URI.
void	setTag(String pItemTag) The unique identifier of the item within a group.

Method Detail

setKey

void setKey(String pKeyString)
            throws 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.

Product Availability

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

Parameters:

pKeyString - The pKeyString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getKey

String getKey()
              throws 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.

Product Availability

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

Returns:

The pKeyString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTag

void setTag(String pItemTag)
            throws 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.

Product Availability

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

Parameters:

pItemTag - The pItemTag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTag

String getTag()
              throws 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.

Product Availability

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

Returns:

The pItemTag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGroup

void setGroup(String pItemGroup)
              throws 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.

Product Availability

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

Parameters:

pItemGroup - The pItemGroup (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGroup

String getGroup()
                throws 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.

Product Availability

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

Returns:

The pItemGroup

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayName

void setDisplayName(String pDisplayName)
                    throws 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.

Product Availability

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

Parameters:

pDisplayName - The pDisplayName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayName

String getDisplayName()
                      throws 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.

Product Availability

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

Returns:

The pDisplayName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProductName

void setProductName(String pProductName)
                    throws 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.

Product Availability

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

Parameters:

pProductName - The pProductName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProductName

String getProductName()
                      throws 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.

Product Availability

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

Returns:

The pProductName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourceTimeStamp

void setSourceTimeStamp(Date pSourceTimeStamp)
                        throws IOException,
                               AutomationException

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

Product Availability

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

Parameters:

pSourceTimeStamp - The pSourceTimeStamp (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourceTimeStamp

Date getSourceTimeStamp()
                        throws IOException,
                               AutomationException

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

Product Availability

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

Returns:

The pSourceTimeStamp

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAuxiliaryPathsByRef

void setAuxiliaryPathsByRef(IStringArray ppAuxiliaryPaths)
                            throws IOException,
                                   AutomationException

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

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAuxiliaryPaths

IStringArray getAuxiliaryPaths()
                               throws IOException,
                                      AutomationException

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

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.