com.esri.arcgis.datasourcesraster
Class RasterLoader

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

All Implemented Interfaces:

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

public class RasterLoader
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterLoader, ISupportErrorInfo

A raster loader class.

Remarks

The RasterLoader coclass provides more flexibility to mosaic certain raster data to an existing raster dataset. If you have a rotated raster dataset, you may want to ignore the background values when mosaicking the data to an existing dataset. If the dataset has a colormap, you may want to load the colormap in certain ways.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

IRasterLoader, Serialized Form

Constructor Summary

RasterLoader()
Constructs a RasterLoader using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
Object	getBackground() The background value to filtered.
static String	getClsid() getClsid.
Object	getForeground() The foreground value for 1-Bit images.
int	getMosaicColormapMode() The colormap mode for loading psdeucolor raster datasets.
double	getPixelAlignmentTolerance() The pixel alignment tolerance.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	load(IRasterDataset pDataset, IRaster raster) Loads (mosaics) a Raster into a RasterDataset.
void	loadRasters(IRasterDataset pDataset, IArray rasters) Loads (mosaics) an array of Rasters into a RasterDataset.
void	setBackground(Object background) The background value to filtered.
void	setForeground(Object foreground) The foreground value for 1-Bit images.
void	setMosaicColormapMode(int mode) The colormap mode for loading psdeucolor raster datasets.
void	setPixelAlignmentTolerance(double tolerance) The pixel alignment tolerance.

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

RasterLoader

public RasterLoader()
             throws IOException,
                    UnknownHostException

Constructs a RasterLoader using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

RasterLoader

public RasterLoader(Object obj)
             throws IOException

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

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

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

getPixelAlignmentTolerance

public double getPixelAlignmentTolerance()
                                  throws IOException,
                                         AutomationException

The pixel alignment tolerance.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPixelAlignmentTolerance in interface IRasterLoader

Returns:

The tolerance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPixelAlignmentTolerance

public void setPixelAlignmentTolerance(double tolerance)
                                throws IOException,
                                       AutomationException

The pixel alignment tolerance.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPixelAlignmentTolerance in interface IRasterLoader

Parameters:

tolerance - The tolerance (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.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBackground in interface IRasterLoader

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.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBackground in interface IRasterLoader

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.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getForeground in interface IRasterLoader

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.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setForeground in interface IRasterLoader

Parameters:

foreground - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMosaicColormapMode

public int getMosaicColormapMode()
                          throws IOException,
                                 AutomationException

The colormap mode for loading psdeucolor raster datasets.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMosaicColormapMode in interface IRasterLoader

Returns:

A com.esri.arcgis.datasourcesraster.rstMosaicColormapMode constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMosaicColormapMode

public void setMosaicColormapMode(int mode)
                           throws IOException,
                                  AutomationException

The colormap mode for loading psdeucolor raster datasets.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMosaicColormapMode in interface IRasterLoader

Parameters:

mode - A com.esri.arcgis.datasourcesraster.rstMosaicColormapMode constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IRasterDataset pDataset,
                 IRaster raster)
          throws IOException,
                 AutomationException

Loads (mosaics) a Raster into a RasterDataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IRasterLoader

Parameters:

pDataset - A reference to a com.esri.arcgis.geodatabase.IRasterDataset (in)

raster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadRasters

public void loadRasters(IRasterDataset pDataset,
                        IArray rasters)
                 throws IOException,
                        AutomationException

Loads (mosaics) an array of Rasters into a RasterDataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

loadRasters in interface IRasterLoader

Parameters:

pDataset - A reference to a com.esri.arcgis.geodatabase.IRasterDataset (in)

rasters - A reference to a com.esri.arcgis.system.IArray (in)

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.