com.esri.arcgis.datasourcesraster

Interface IDrLoader

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

DrLoader, IDrLoaderProxy

public interface IDrLoader
extends java.io.Serializable

COM Interface 'IDrLoader'. Generated 9/21/2023 10:01:48 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description: 'Provides access to members that controls a distributed raster catalog loader.' 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

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IID5e1714cd_cbca_458e_88ce_06f0ca5cccdf
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels loading.
java.lang.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.
java.lang.String	getServerName() The ArcGIS server name to host loaders.
void	getStats(java.lang.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(java.lang.String catalog, java.lang.String directory) Loads all datasets in a directory into a given raster catalog.
void	loadDatasets(java.lang.String catalog, java.lang.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(java.lang.String pServerName) The ArcGIS server name to host loaders.

Field Detail

IID5e1714cd_cbca_458e_88ce_06f0ca5cccdf

static final int IID5e1714cd_cbca_458e_88ce_06f0ca5cccdf

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

getServerName

java.lang.String getServerName()
                        throws java.io.IOException,
                               AutomationException

The ArcGIS server name to host loaders.

Returns:

The pServerName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setServerName

void setServerName(java.lang.String pServerName)
            throws java.io.IOException,
                   AutomationException

The ArcGIS server name to host loaders.

Parameters:

pServerName - The pServerName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRasterCatalogLoader

IRasterCatalogLoader getRasterCatalogLoader()
                                     throws java.io.IOException,
                                            AutomationException

The raster catalog loader to be distributed.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRasterCatalogLoaderByRef

void setRasterCatalogLoaderByRef(IRasterCatalogLoader ppLoader)
                          throws java.io.IOException,
                                 AutomationException

The raster catalog loader to be distributed.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getInvalidDatasets

java.lang.String getInvalidDatasets()
                             throws java.io.IOException,
                                    AutomationException

The current list of semicolon delimited failed dataset names.

Returns:

The pInvalidDatasets

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isBusy

boolean isBusy()
        throws java.io.IOException,
               AutomationException

Indicates if the loader is currently busy.

Returns:

The pIsBusy

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLastError

IErrorInfo getLastError()
                 throws java.io.IOException,
                        AutomationException

The last loading error.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

void load(java.lang.String catalog,
          java.lang.String directory)
   throws java.io.IOException,
          AutomationException

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

Parameters:

catalog - The catalog (in)

directory - The directory (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

loadDatasets

void loadDatasets(java.lang.String catalog,
                  java.lang.String namelist)
           throws java.io.IOException,
                  AutomationException

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

Parameters:

catalog - The catalog (in)

namelist - The namelist (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

cancel

void cancel()
     throws java.io.IOException,
            AutomationException

Cancels loading.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStats

void getStats(java.lang.String[] pName,
              double[] pMillis)
       throws java.io.IOException,
              AutomationException

Gets the current loading stats.

Parameters:

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getThreadHandle

int getThreadHandle()
             throws java.io.IOException,
                    AutomationException

Gets the loading thread handle.

Returns:

The pHandle

Throws:

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

AutomationException - If the ArcObject component throws an exception.