com.esri.arcgis.datasourcesraster
Interface IDrLoader

All Superinterfaces:

Serializable

All Known Implementing Classes:

DrLoader

public interface IDrLoader
extends Serializable

Provides access to members that controls a distributed raster catalog loader.

Description

Then IDrLoader interface provides the functionality to load raster datasets to a raster catalog in an ArcGIS server environment. The storage parameters can be specified while loading, and the settings apply to all rasters in the raster catalog.

ServerName specifies the ArcGIS server name.

Load method launches the loader process for loading a directory of rasters to the given raster catalog.

LoadDatasets launches the loader process for loading a list of raster datasets to the given raster catalog.

The storage parameters can be specified in RasterCatalogLoader.

Product Availability

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

Method Summary

void	cancel() Cancels loading.
String	getInvalidDatasets() The current list of semicolon delimited failed dataset names.
IErrorInfo	getLastError() The last loading error.
IRasterCatalogLoader	getRasterCatalogLoader() The raster catalog loader to be distributed.
String	getServerName() The ArcGIS server name to host loaders.
void	getStats(String[] pName, double[] pMillis) Gets the current loading stats.
int	getThreadHandle() Gets the loading thread handle.
boolean	isBusy() Indicates if the loader is currently busy.
void	load(String catalog, String directory) Loads all datasets in a directory into a given raster catalog.
void	loadDatasets(String catalog, String namelist) Loads all datasets in a name list into a given raster catalog.
void	setRasterCatalogLoaderByRef(IRasterCatalogLoader ppLoader) The raster catalog loader to be distributed.
void	setServerName(String pServerName) The ArcGIS server name to host loaders.

Method Detail

getServerName

String getServerName()
                     throws IOException,
                            AutomationException

The ArcGIS server name to host loaders.

Description

ServerName is the name of the ArcGIS server machine that hosts the loaders.

Product Availability

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

Returns:

The pServerName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setServerName

void setServerName(String pServerName)
                   throws IOException,
                          AutomationException

The ArcGIS server name to host loaders.

Description

Set the ArcGIS server machine name.

Product Availability

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

Parameters:

pServerName - The pServerName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRasterCatalogLoader

IRasterCatalogLoader getRasterCatalogLoader()
                                            throws IOException,
                                                   AutomationException

The raster catalog loader to be distributed.

Description

The RasterCatalogLoader to be distributed among the available ArcGIS containers. The storage parameters can be specified for the loader to instruct how the data will be stored in the geodatabase, also whether the data will be transformed or projected can be set.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRasterCatalogLoaderByRef

void setRasterCatalogLoaderByRef(IRasterCatalogLoader ppLoader)
                                 throws IOException,
                                        AutomationException

The raster catalog loader to be distributed.

Product Availability

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

Parameters:

ppLoader - A reference to a com.esri.arcgis.datasourcesraster.IRasterCatalogLoader (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInvalidDatasets

String getInvalidDatasets()
                          throws IOException,
                                 AutomationException

The current list of semicolon delimited failed dataset names.

Description

Get the list of the raster dataset names that failed to load to the raster catalog. The list is delimited by new line.

Product Availability

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

Returns:

The pInvalidDatasets

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBusy

boolean isBusy()
               throws IOException,
                      AutomationException

Indicates if the loader is currently busy.

Description

Get the status of the loader, whether it is in use or not.

Product Availability

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

Returns:

The pIsBusy

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLastError

IErrorInfo getLastError()
                        throws IOException,
                               AutomationException

The last loading error.

Description

Get the last error occurred during the loading.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

void load(String catalog,
          String directory)
          throws IOException,
                 AutomationException

Loads all datasets in a directory into a given raster catalog.

Description

Perform the loading of raster datasets to the raster catalog.

Product Availability

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

Parameters:

catalog - The catalog (in)

directory - The directory (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadDatasets

void loadDatasets(String catalog,
                  String namelist)
                  throws IOException,
                         AutomationException

Loads all datasets in a name list into a given raster catalog.

Description

Load a list of raster datasets to the raster catalog, the list contains raster dataset with full pathname and it is delimited by newline.

Product Availability

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

Parameters:

catalog - The catalog (in)

namelist - The namelist (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

cancel

void cancel()
            throws IOException,
                   AutomationException

Cancels loading.

Description

Cancel the loading operation.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStats

void getStats(String[] pName,
              double[] pMillis)
              throws IOException,
                     AutomationException

Gets the current loading stats.

Description

Get the status of the loading performance, with the raster dataset name and time used to load it to the raster catalog.

Product Availability

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

Parameters:

pName - The pName (out: use single element array)

pMillis - The pMillis (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getThreadHandle

int getThreadHandle()
                    throws IOException,
                           AutomationException

Gets the loading thread handle.

Description

Get the handle of the loader.

Product Availability

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

Returns:

The pHandle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.