com.esri.arcgis.datasourcesraster
Class RasterCatalogLoader

java.lang.Object
  com.esri.arcgis.datasourcesraster.RasterCatalogLoader

All Implemented Interfaces:

IRasterCatalogLoader, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, Serializable

public class RasterCatalogLoader
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterCatalogLoader, ISupportErrorInfo

A raster catalog loader class.

Description

The RasterCatalogLoader object provides functions for loading raster datasets or directories of raster datasets to a geodatabase raster catalog. If the raster datasets have transformation information associated, it can be kept separated as property of the raster or be applied to the output raster. If the raster datasets have different spatial reference from the raster catalog, the rasters can either be projected or kept intact.

Product Availability

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

See Also:

IRasterCatalog, Serialized Form

Constructor Summary

RasterCatalogLoader()
Constructs a RasterCatalogLoader using ArcGIS Engine.

RasterCatalogLoader(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterCatalogLoader theRasterCatalogLoader = (RasterCatalogLoader) obj;

Method Summary

boolean	equals(Object o) Compare this object with another
Object	getBackground() The background value to filtered.
static String	getClsid() getClsid.
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.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

RasterCatalogLoader

public RasterCatalogLoader()
                    throws IOException,
                           UnknownHostException

Constructs a RasterCatalogLoader using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

RasterCatalogLoader

public RasterCatalogLoader(Object obj)
                    throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterCatalogLoader theRasterCatalogLoader = (RasterCatalogLoader) obj;

Construct a RasterCatalogLoader using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to RasterCatalogLoader.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getConnectionProperties

public IPropertySet getConnectionProperties()
                                     throws IOException,
                                            AutomationException

The GeoDatabase connection properties.

Product Availability

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

Specified by:

getConnectionProperties in interface IRasterCatalogLoader

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

public void setConnectionPropertiesByRef(IPropertySet ppConnectionProperties)
                                  throws IOException,
                                         AutomationException

The GeoDatabase connection properties.

Product Availability

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

Specified by:

setConnectionPropertiesByRef in interface IRasterCatalogLoader

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

public IWorkspace getWorkspace()
                        throws IOException,
                               AutomationException

The GeoDatabase workspace.

Product Availability

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

Specified by:

getWorkspace in interface IRasterCatalogLoader

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

public void setWorkspaceByRef(IWorkspace pWorkspace)
                       throws IOException,
                              AutomationException

The GeoDatabase workspace.

Product Availability

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

Specified by:

setWorkspaceByRef in interface IRasterCatalogLoader

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

public Object getBackground()
                     throws IOException,
                            AutomationException

The background value to filtered.

Product Availability

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

Specified by:

getBackground in interface IRasterCatalogLoader

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBackground

public void setBackground(Object background)
                   throws IOException,
                          AutomationException

The background value to filtered.

Product Availability

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

Specified by:

setBackground in interface IRasterCatalogLoader

Parameters:

background - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getForeground

public Object getForeground()
                     throws IOException,
                            AutomationException

The foreground value for 1-Bit images.

Product Availability

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

Specified by:

getForeground in interface IRasterCatalogLoader

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setForeground

public 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.

Specified by:

setForeground in interface IRasterCatalogLoader

Parameters:

foreground - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStorageDef

public IRasterStorageDef getStorageDef()
                                throws IOException,
                                       AutomationException

The GeoDatabase storage definition.

Product Availability

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

Specified by:

getStorageDef in interface IRasterCatalogLoader

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

public void setStorageDefByRef(IRasterStorageDef ppStorageDef)
                        throws IOException,
                               AutomationException

The GeoDatabase storage definition.

Product Availability

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

Specified by:

setStorageDefByRef in interface IRasterCatalogLoader

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

public 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.

Specified by:

isTransformed in interface IRasterCatalogLoader

Returns:

The xformed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTransformed

public 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.

Specified by:

setTransformed in interface IRasterCatalogLoader

Parameters:

xformed - The xformed (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isProjected

public 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.

Specified by:

isProjected in interface IRasterCatalogLoader

Returns:

The projected

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProjected

public 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.

Specified by:

setProjected in interface IRasterCatalogLoader

Parameters:

projected - The projected (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnableBuildStatistics

public boolean isEnableBuildStatistics()
                                throws IOException,
                                       AutomationException

Indicates if statistics should be built on loading.

Product Availability

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

Specified by:

isEnableBuildStatistics in interface IRasterCatalogLoader

Returns:

The pEnableBuildStats

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnableBuildStatistics

public 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.

Specified by:

setEnableBuildStatistics in interface IRasterCatalogLoader

Parameters:

pEnableBuildStats - The pEnableBuildStats (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getXSkipFactor

public int getXSkipFactor()
                   throws IOException,
                          AutomationException

The X skip factor for statistics.

Product Availability

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

Specified by:

getXSkipFactor in interface IRasterCatalogLoader

Returns:

The xSkipFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setXSkipFactor

public void setXSkipFactor(int xSkipFactor)
                    throws IOException,
                           AutomationException

The X skip factor for statistics.

Product Availability

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

Specified by:

setXSkipFactor in interface IRasterCatalogLoader

Parameters:

xSkipFactor - The xSkipFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getYSkipFactor

public int getYSkipFactor()
                   throws IOException,
                          AutomationException

The Y skip factor for statistics.

Product Availability

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

Specified by:

getYSkipFactor in interface IRasterCatalogLoader

Returns:

The ySkipFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setYSkipFactor

public void setYSkipFactor(int ySkipFactor)
                    throws IOException,
                           AutomationException

The Y skip factor for statistics.

Product Availability

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

Specified by:

setYSkipFactor in interface IRasterCatalogLoader

Parameters:

ySkipFactor - The ySkipFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIgnoreValues

public Object getIgnoreValues()
                       throws IOException,
                              AutomationException

The ignore values for statistics.

Product Availability

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

Specified by:

getIgnoreValues in interface IRasterCatalogLoader

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIgnoreValues

public void setIgnoreValues(Object vIgnoreValues)
                     throws IOException,
                            AutomationException

The ignore values for statistics.

Product Availability

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

Specified by:

setIgnoreValues in interface IRasterCatalogLoader

Parameters:

vIgnoreValues - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public 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.

Specified by:

load in interface IRasterCatalogLoader

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

public 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.

Specified by:

loadDatasets in interface IRasterCatalogLoader

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

public IErrorInfo getLastError()
                        throws IOException,
                               AutomationException

The last loading error.

Product Availability

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

Specified by:

getLastError in interface IRasterCatalogLoader

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

public 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.

Specified by:

getInvalidDatasets in interface IRasterCatalogLoader

Returns:

The pInvalidDatasetNames

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLastLoadedDataset

public String getLastLoadedDataset()
                            throws IOException,
                                   AutomationException

The last loaded dataset name.

Product Availability

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

Specified by:

getLastLoadedDataset in interface IRasterCatalogLoader

Returns:

The pDatasetName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.