com.esri.arcgis.datasourcesraster
Interface IRasterTypeDataSourceHandler

All Superinterfaces:

Serializable

All Known Implementing Classes:

RasterTypeEnvironment

public interface IRasterTypeDataSourceHandler
extends Serializable

Provides access to members that control the raster type data source handler.

Product Availability

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

Method Summary

IArray	canOpen(IRasterTypeDataSourceHandlerParameters pParameters) Indicates whether a valid raster type is available in the specified collection that's capable of opening the given data source and returns a collection of all such valid raster types.
IBuilderItem	open(IRasterTypeDataSourceHandlerParameters pParameters) Builds the specified data source using the specified raster types and returns the constructed function raster dataset.
void	querySupportedFilesInFolder(IRasterTypeDataSourceHandlerParameters pParameters, IStringArray[] ppSupportedFilePaths, IArray[] ppAssociatedRasterTypes) Searches the given folder path, non-recursively, for files that can be opened by the specified collection of raster types and returns an array of valid file paths.

Method Detail

canOpen

IArray canOpen(IRasterTypeDataSourceHandlerParameters pParameters)
               throws IOException,
                      AutomationException

Indicates whether a valid raster type is available in the specified collection that's capable of opening the given data source and returns a collection of all such valid raster types. This method uses RasterTypeEnvironment.GlobalSensorRasterTypes collection if????&

Product Availability

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

Parameters:

pParameters - A reference to a com.esri.arcgis.datasourcesraster.IRasterTypeDataSourceHandlerParameters (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

querySupportedFilesInFolder

void querySupportedFilesInFolder(IRasterTypeDataSourceHandlerParameters pParameters,
                                 IStringArray[] ppSupportedFilePaths,
                                 IArray[] ppAssociatedRasterTypes)
                                 throws IOException,
                                        AutomationException

Searches the given folder path, non-recursively, for files that can be opened by the specified collection of raster types and returns an array of valid file paths. This method uses RasterTypeEnvironment.GlobalSensorRasterTypes collection if no input raster typ????&

Product Availability

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

Parameters:

pParameters - A reference to a com.esri.arcgis.datasourcesraster.IRasterTypeDataSourceHandlerParameters (in)

ppSupportedFilePaths - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)

ppAssociatedRasterTypes - A reference to a com.esri.arcgis.system.IArray (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

open

IBuilderItem open(IRasterTypeDataSourceHandlerParameters pParameters)
                  throws IOException,
                         AutomationException

Builds the specified data source using the specified raster types and returns the constructed function raster dataset. This method uses RasterTypeEnvironment.GlobalSensorRasterTypes collection if no input raster type array is supplied.

Product Availability

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

Parameters:

pParameters - A reference to a com.esri.arcgis.datasourcesraster.IRasterTypeDataSourceHandlerParameters (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.