com.esri.arcgis.datasourcesraster
Interface IRasterCatalogLoader

All Superinterfaces:

Serializable

All Known Implementing Classes:

RasterCatalogLoader

public interface IRasterCatalogLoader
extends Serializable

Provides access to members that control rastercatalog loading.

Remarks

The IRasterCatalogLoader interface provides functions to load a list of raster datasets or a directory of raster datasets to the given raster catalog. The storage parameters can be specified by StorageDef. If the raster datasets have transformations associated, the rasters can either be loaded and stored in its native spatial space and the transformation information stored separately; or transformed on-the-fly and the pixels stored in the transformed space. If the raster datasets have spatial reference that is different from the spatial reference of the raster column of the raster catalog, the rasters can either be projected on-the-fly or kept in its original spatial reference.

Load loads raster datasets in the given directory to the raster catalog.

LoadDatasets loads a list of raster datasets to the raster catalog.

Product Availability

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

Method Summary

Object	getBackground() The background value to filtered.
IPropertySet	getConnectionProperties() The GeoDatabase connection properties.
Object	getForeground() The foreground value for 1-Bit images.
Object	getIgnoreValues() The ignore values for statistics.
String	getInvalidDatasets() The current list of newline delimited failed dataset names.
IErrorInfo	getLastError() The last loading error.
String	getLastLoadedDataset() The last loaded dataset name.
IRasterStorageDef	getStorageDef() The GeoDatabase storage definition.
IWorkspace	getWorkspace() The GeoDatabase workspace.
int	getXSkipFactor() The X skip factor for statistics.
int	getYSkipFactor() The Y skip factor for statistics.
boolean	isEnableBuildStatistics() Indicates if statistics should be built on loading.
boolean	isProjected() Indicates if datasets are to be reprojected on loading.
boolean	isTransformed() Indicates if datasets are to be transformed on loading.
void	load(String catalog, String directory, ITrackCancel pCancelTracker) Loads all raster datasets in a given directory into a raster catalog.
void	loadDatasets(String catalog, String namelist, ITrackCancel pCancelTracker) Loads all raster datasets in a given name list file into a raster catalog.
void	setBackground(Object background) The background value to filtered.
void	setConnectionPropertiesByRef(IPropertySet ppConnectionProperties) The GeoDatabase connection properties.
void	setEnableBuildStatistics(boolean pEnableBuildStats) Indicates if statistics should be built on loading.
void	setForeground(Object foreground) The foreground value for 1-Bit images.
void	setIgnoreValues(Object vIgnoreValues) The ignore values for statistics.
void	setProjected(boolean projected) Indicates if datasets are to be reprojected on loading.
void	setStorageDefByRef(IRasterStorageDef ppStorageDef) The GeoDatabase storage definition.
void	setTransformed(boolean xformed) Indicates if datasets are to be transformed on loading.
void	setWorkspaceByRef(IWorkspace pWorkspace) The GeoDatabase workspace.
void	setXSkipFactor(int xSkipFactor) The X skip factor for statistics.
void	setYSkipFactor(int ySkipFactor) The Y skip factor for statistics.

Method Detail

getConnectionProperties

IPropertySet getConnectionProperties()
                                     throws IOException,
                                            AutomationException

The GeoDatabase connection properties.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConnectionPropertiesByRef

void setConnectionPropertiesByRef(IPropertySet ppConnectionProperties)
                                  throws IOException,
                                         AutomationException

The GeoDatabase connection properties.

Product Availability

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

Parameters:

ppConnectionProperties - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWorkspace

IWorkspace getWorkspace()
                        throws IOException,
                               AutomationException

The GeoDatabase workspace.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geodatabase.IWorkspace

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWorkspaceByRef

void setWorkspaceByRef(IWorkspace pWorkspace)
                       throws IOException,
                              AutomationException

The GeoDatabase workspace.

Product Availability

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

Parameters:

pWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackground

Object getBackground()
                     throws IOException,
                            AutomationException

The background value to filtered.

Product Availability

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBackground

void setBackground(Object background)
                   throws IOException,
                          AutomationException

The background value to filtered.

Product Availability

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

Parameters:

background - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getForeground

Object getForeground()
                     throws IOException,
                            AutomationException

The foreground value for 1-Bit images.

Product Availability

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setForeground

void setForeground(Object foreground)
                   throws IOException,
                          AutomationException

The foreground value for 1-Bit images.

Product Availability

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

Parameters:

foreground - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStorageDef

IRasterStorageDef getStorageDef()
                                throws IOException,
                                       AutomationException

The GeoDatabase storage definition.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geodatabase.IRasterStorageDef

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStorageDefByRef

void setStorageDefByRef(IRasterStorageDef ppStorageDef)
                        throws IOException,
                               AutomationException

The GeoDatabase storage definition.

Product Availability

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

Parameters:

ppStorageDef - A reference to a com.esri.arcgis.geodatabase.IRasterStorageDef (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTransformed

boolean isTransformed()
                      throws IOException,
                             AutomationException

Indicates if datasets are to be transformed on loading.

Product Availability

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

Returns:

The xformed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTransformed

void setTransformed(boolean xformed)
                    throws IOException,
                           AutomationException

Indicates if datasets are to be transformed on loading.

Product Availability

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

Parameters:

xformed - The xformed (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isProjected

boolean isProjected()
                    throws IOException,
                           AutomationException

Indicates if datasets are to be reprojected on loading.

Product Availability

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

Returns:

The projected

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProjected

void setProjected(boolean projected)
                  throws IOException,
                         AutomationException

Indicates if datasets are to be reprojected on loading.

Description

When it is set to be TRUE, the raster will be transformed first if it has a transformation and then proejcted.

Product Availability

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

Parameters:

projected - The projected (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnableBuildStatistics

boolean isEnableBuildStatistics()
                                throws IOException,
                                       AutomationException

Indicates if statistics should be built on loading.

Product Availability

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

Returns:

The pEnableBuildStats

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnableBuildStatistics

void setEnableBuildStatistics(boolean pEnableBuildStats)
                              throws IOException,
                                     AutomationException

Indicates if statistics should be built on loading.

Product Availability

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

Parameters:

pEnableBuildStats - The pEnableBuildStats (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getXSkipFactor

int getXSkipFactor()
                   throws IOException,
                          AutomationException

The X skip factor for statistics.

Product Availability

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

Returns:

The xSkipFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setXSkipFactor

void setXSkipFactor(int xSkipFactor)
                    throws IOException,
                           AutomationException

The X skip factor for statistics.

Product Availability

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

Parameters:

xSkipFactor - The xSkipFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getYSkipFactor

int getYSkipFactor()
                   throws IOException,
                          AutomationException

The Y skip factor for statistics.

Product Availability

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

Returns:

The ySkipFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setYSkipFactor

void setYSkipFactor(int ySkipFactor)
                    throws IOException,
                           AutomationException

The Y skip factor for statistics.

Product Availability

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

Parameters:

ySkipFactor - The ySkipFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIgnoreValues

Object getIgnoreValues()
                       throws IOException,
                              AutomationException

The ignore values for statistics.

Product Availability

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIgnoreValues

void setIgnoreValues(Object vIgnoreValues)
                     throws IOException,
                            AutomationException

The ignore values for statistics.

Product Availability

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

Parameters:

vIgnoreValues - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

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

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

Product Availability

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

Parameters:

catalog - The catalog (in)

directory - The directory (in)

pCancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadDatasets

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

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

Product Availability

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

Parameters:

catalog - The catalog (in)

namelist - The namelist (in)

pCancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)

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.

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.

getInvalidDatasets

String getInvalidDatasets()
                          throws IOException,
                                 AutomationException

The current list of newline delimited failed dataset names.

Product Availability

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

Returns:

The pInvalidDatasetNames

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLastLoadedDataset

String getLastLoadedDataset()
                            throws IOException,
                                   AutomationException

The last loaded dataset name.

Product Availability

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

Returns:

The pDatasetName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.