com.esri.arcgis.geoanalyst
Class RasterConvertHelper

java.lang.Object
  extended bycom.esri.arcgis.geoanalyst.RasterConvertHelper
All Implemented Interfaces:
IRasterConvertHelper, ISupportErrorInfo, java.io.Serializable

public class RasterConvertHelper
extends java.lang.Object
implements IRasterConvertHelper, ISupportErrorInfo

Raster conversion helper class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
RasterConvertHelper()
          Constructs a RasterConvertHelper using ArcGIS Engine.
RasterConvertHelper(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
 
Method Summary
 boolean equals(java.lang.Object o)
          Compare this object with another
 IRasterConvertHelper getAsIRasterConvertHelper()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ISupportErrorInfo getAsISupportErrorInfo()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
static java.lang.String getClsid()
           
 int hashCode()
          the hashcode for this object
 void interfaceSupportsErrorInfo(GUID riid)
          Supported Platforms
 IRaster toRaster1(IGeoDataset pIn1, java.lang.String rasterFormat, IRasterAnalysisEnvironment rasterEnv)
          Converts a GeoDataset to a Raster.
 void toRaster2(IGeoDataset pIn1, IGeoDataset pIn2, java.lang.String rasterFormat, IRasterAnalysisEnvironment rasterEnv, IRaster[] ppOut1, IRaster[] ppOut2)
          Converts two GeoDatasets to two Rasters.
 void toRaster3(IGeoDataset pIn1, IGeoDataset pIn2, IGeoDataset pIn3, java.lang.String rasterFormat, IRasterAnalysisEnvironment rasterEnv, IRaster[] ppOut1, IRaster[] ppOut2, IRaster[] ppOut3)
          Converts three GeoDatasets to three Rasters.
 IFeatureClass toShapefile(IGeoDataset pIn, int geometryType, IRasterAnalysisEnvironment rasterEnv)
          Converts a GeoDataset to a shapefile.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RasterConvertHelper

public RasterConvertHelper()
                    throws java.io.IOException,
                           java.net.UnknownHostException
Constructs a RasterConvertHelper using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

RasterConvertHelper

public RasterConvertHelper(java.lang.Object obj)
                    throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Construct a RasterConvertHelper using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to RasterConvertHelper.
RasterConvertHelper theRasterConvertHelper = (RasterConvertHelper) obj;

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()

getAsIRasterConvertHelper

public IRasterConvertHelper getAsIRasterConvertHelper()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsISupportErrorInfo

public ISupportErrorInfo getAsISupportErrorInfo()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


equals

public boolean equals(java.lang.Object o)
Compare this object with another


hashCode

public int hashCode()
the hashcode for this object


toRaster1

public IRaster toRaster1(IGeoDataset pIn1,
                         java.lang.String rasterFormat,
                         IRasterAnalysisEnvironment rasterEnv)
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IRasterConvertHelper
Converts a GeoDataset to a Raster.

Supported Platforms

Windows, Solaris, Linux

Remarks

rasterFormat

ESRI GRID, ERDAS Imagine or TIFF formats are supported. The strings for rasterformat are "GRID", "IMAGINE Image" and "TIFF" respectively and they are case sensitive.

The format string “GRID” creates an output  ESRI GRID with no file extension

The format string "TIFF" creates a TIFF file with ".tif" extension.  ArcGIS also supports TIFF format with ".tiff" and ".tff" extensions. A format string "TIF" creates a  TIFF file with ".tiff" extention and a format string "TFF" creates a TIFF file with ".tff" extension

The format string  “IMAGINE Image” creates a raster output with “.img” file extension

Specified by:
toRaster1 in interface IRasterConvertHelper
Parameters:
pIn1 - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
rasterFormat - The rasterFormat (in)
rasterEnv - A reference to a com.esri.arcgis.geoanalyst.IRasterAnalysisEnvironment (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IRaster
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

toRaster2

public void toRaster2(IGeoDataset pIn1,
                      IGeoDataset pIn2,
                      java.lang.String rasterFormat,
                      IRasterAnalysisEnvironment rasterEnv,
                      IRaster[] ppOut1,
                      IRaster[] ppOut2)
               throws java.io.IOException,
                      AutomationException
Description copied from interface: IRasterConvertHelper
Converts two GeoDatasets to two Rasters.

Supported Platforms

Windows, Solaris, Linux

Remarks

rasterFormat

ESRI GRID, ERDAS Imagine or TIFF formats are supported. The strings for rasterformat are "GRID", "IMAGINE Image" and "TIFF" respectively and they are case sensitive.

The format string “GRID” creates an output  ESRI GRID with no file extension

The format string "TIFF" creates a TIFF file with ".tif" extension.  ArcGIS also supports TIFF format with ".tiff" and ".tff" extensions. A format string "TIF" creates a  TIFF file with ".tiff" extention and a format string "TFF" creates a TIFF file with ".tff" extension

The format string  “IMAGINE Image” creates a raster output with “.img” file extension

Specified by:
toRaster2 in interface IRasterConvertHelper
Parameters:
pIn1 - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
pIn2 - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
rasterFormat - The rasterFormat (in)
rasterEnv - A reference to a com.esri.arcgis.geoanalyst.IRasterAnalysisEnvironment (in)
ppOut1 - A reference to a com.esri.arcgis.geodatabase.IRaster (out: use single element array)
ppOut2 - A reference to a com.esri.arcgis.geodatabase.IRaster (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

toRaster3

public void toRaster3(IGeoDataset pIn1,
                      IGeoDataset pIn2,
                      IGeoDataset pIn3,
                      java.lang.String rasterFormat,
                      IRasterAnalysisEnvironment rasterEnv,
                      IRaster[] ppOut1,
                      IRaster[] ppOut2,
                      IRaster[] ppOut3)
               throws java.io.IOException,
                      AutomationException
Description copied from interface: IRasterConvertHelper
Converts three GeoDatasets to three Rasters.

Supported Platforms

Windows, Solaris, Linux

Remarks

rasterFormat

ESRI GRID, ERDAS Imagine or TIFF formats are supported. The strings for rasterformat are "GRID", "IMAGINE Image" and "TIFF" respectively and they are case sensitive.

The format string “GRID” creates an output  ESRI GRID with no file extension

The format string "TIFF" creates a TIFF file with ".tif" extension.  ArcGIS also supports TIFF format with ".tiff" and ".tff" extensions. A format string "TIF" creates a  TIFF file with ".tiff" extention and a format string "TFF" creates a TIFF file with ".tff" extension

The format string  “IMAGINE Image” creates a raster output with “.img” file extension

Specified by:
toRaster3 in interface IRasterConvertHelper
Parameters:
pIn1 - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
pIn2 - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
pIn3 - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
rasterFormat - The rasterFormat (in)
rasterEnv - A reference to a com.esri.arcgis.geoanalyst.IRasterAnalysisEnvironment (in)
ppOut1 - A reference to a com.esri.arcgis.geodatabase.IRaster (out: use single element array)
ppOut2 - A reference to a com.esri.arcgis.geodatabase.IRaster (out: use single element array)
ppOut3 - A reference to a com.esri.arcgis.geodatabase.IRaster (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

toShapefile

public IFeatureClass toShapefile(IGeoDataset pIn,
                                 int geometryType,
                                 IRasterAnalysisEnvironment rasterEnv)
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IRasterConvertHelper
Converts a GeoDataset to a shapefile.

Supported Platforms

Windows, Solaris, Linux

Specified by:
toShapefile in interface IRasterConvertHelper
Parameters:
pIn - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
geometryType - A com.esri.arcgis.geometry.esriGeometryType constant (in)
rasterEnv - A reference to a com.esri.arcgis.geoanalyst.IRasterAnalysisEnvironment (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IFeatureClass
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException
Description copied from interface: ISupportErrorInfo

Supported Platforms

Windows, Solaris, Linux

Description

Indicates whether the interface supports IErrorInfo.

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.