com.esri.arcgis.geoanalyst
Class RasterAnalysis

java.lang.Object
  com.esri.arcgis.geoanalyst.RasterAnalysis

All Implemented Interfaces:

IGeoAnalysisEnvironment, IRasterAnalysisEnvironment, IRasterAnalysisGDBEnvironment, IRasterAnalysisGlobalEnvironment, IRasterOpBase, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, ISupportErrorInfo, Externalizable, Serializable

public class RasterAnalysis
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterAnalysisEnvironment, IRasterAnalysisGDBEnvironment, IRasterAnalysisGlobalEnvironment, IRasterOpBase, IPersistStream, IClone, ISupportErrorInfo, Externalizable

A collection of information about the raster analysis environment.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

RasterAnalysis()
Constructs a RasterAnalysis using ArcGIS Engine.

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

Method Summary

void	addOutputDatasetName(int index, IDatasetName pOutName) Adds an output dataset name to the specified index.
void	assign(IClone src) Assigns the properties of src to the receiver.
boolean	equals(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	getCellSize(int[] envType, double[] cellSize) Gets the type and value of cell size in the RasterAnalysis.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
int	getCompressionType() The type and value of compression in the RasterAnalysis.
String	getConfigurationKeyword() The configuration keyword in the RasterAnalysis.
String	getDefaultOutputRasterPrefix() The default output raster prefix.
String	getDefaultOutputVectorPrefix() The default output vector prefix.
void	getExtent(int[] envType, IEnvelope[] extent) Gets the type and values of extent in the RasterAnalysis.
ISpatialReference	getGDBDomains() The XY, Z and M domains in the RasterAnalysis.
String	getIgnoredValue() The ignored value in statistics calculation in RasterAnalysis.
int	getJpegQuality() Jpeg compression quality in the RasterAnalysis.
IGeoDataset	getMask() Mask allows processing to occur only for a selected set of cells.
int	getMosaicType() The mosaic type in the RasterAnalysis.
ISpatialReference	getOutSpatialReference() The output spatial reference of GeoAnalysis.
IWorkspace	getOutWorkspace() The output workspace of GeoAnalysis.
int	getPyramidLevel() The level in pyramid building in the RasterAnalysis.
int	getPyramidResampleType() The resample type in pyramid building in the RasterAnalysis.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getTileHeight() The GeoDatabase tile height in the RasterAnalysis.
int	getTileWidth() The GeoDatabase tile width in the RasterAnalysis.
int	getVerifyType() The verify type of the RasterAnalysis.
int	getXSkipFactor() The skip factor in X direction in statistics calculation in the RasterAnalysis.
int	getYSkipFactor() The skip factor in Y direction in statistics calculation in the RasterAnalysis.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isAvoidDataConversion() Indicates weather to avoid data conversion in the RasterAnalysis.
boolean	isBuildPyramid() Indicates if the pyramid building in the RasterAnalysis.
boolean	isCalculateStatistics() Indicates if the statistics calculation in the RasterAnalysis.
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isGlobeOptimized() Indicates if the globe optimized type in the RasterAnalysis.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	reset() Remove all previously stored default rasteranalysis environments.
void	restoreToPreviousDefaultEnvironment() Restores to the previous default raster analysis environment.
void	save(IStream pstm, int fClearDirty) save
void	setAsNewDefaultEnvironment() Sets the raster analysis environment of the object as new default environment.
void	setAvoidDataConversion(boolean bAvoid) Indicates weather to avoid data conversion in the RasterAnalysis.
void	setBuildPyramid(boolean buildParamid) Indicates if the pyramid building in the RasterAnalysis.
void	setCalculateStatistics(boolean calculateStatistics) Indicates if the statistics calculation in the RasterAnalysis.
void	setCellSize(int envType, Object cellSizeProvider) Sets the type and value of cell size in the RasterAnalysis.
void	setCompressionType(int compressionType) The type and value of compression in the RasterAnalysis.
void	setConfigurationKeyword(String configKeyword) The configuration keyword in the RasterAnalysis.
void	setDefaultOutputRasterPrefix(String rasterPrefix) The default output raster prefix.
void	setDefaultOutputVectorPrefix(String vectorPrefix) The default output vector prefix.
void	setExtent(int envType, Object extentProvider, Object snapRasterData) Sets the type and values of extent in the RasterAnalysis.
void	setGDBDomainsByRef(ISpatialReference domainsSpRef) The XY, Z and M domains in the RasterAnalysis.
void	setGlobeOptimized(boolean globeOptimized) Indicates if the globe optimized type in the RasterAnalysis.
void	setIgnoredValue(String ignoredValue) The ignored value in statistics calculation in RasterAnalysis.
void	setJpegQuality(int jpegQuality) Jpeg compression quality in the RasterAnalysis.
void	setMaskByRef(IGeoDataset mask) Mask allows processing to occur only for a selected set of cells.
void	setMosaicType(int mosaicType) The mosaic type in the RasterAnalysis.
void	setOutputDatasetNameArrayByRef(IArray rhs1) Puts output name array.
void	setOutSpatialReferenceByRef(ISpatialReference spatialReference) The output spatial reference of GeoAnalysis.
void	setOutWorkspaceByRef(IWorkspace workspace) The output workspace of GeoAnalysis.
void	setPyramidLevel(int level) The level in pyramid building in the RasterAnalysis.
void	setPyramidResampleType(int resampleType) The resample type in pyramid building in the RasterAnalysis.
void	setTileHeight(int tileHeight) The GeoDatabase tile height in the RasterAnalysis.
void	setTileWidth(int tileWidth) The GeoDatabase tile width in the RasterAnalysis.
void	setVerifyType(int verifyType) The verify type of the RasterAnalysis.
void	setXSkipFactor(int xSkipFactor) The skip factor in X direction in statistics calculation in the RasterAnalysis.
void	setYSkipFactor(int ySkipFactor) The skip factor in Y direction in statistics calculation in the RasterAnalysis.
void	writeExternal(ObjectOutput out)

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

RasterAnalysis

public RasterAnalysis()
               throws IOException,
                      UnknownHostException

Constructs a RasterAnalysis using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

RasterAnalysis

public RasterAnalysis(Object obj)
               throws IOException

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

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

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

setCellSize

public void setCellSize(int envType,
                        Object cellSizeProvider)
                 throws IOException,
                        AutomationException

Sets the type and value of cell size in the RasterAnalysis.

Remarks

envType

An enumeration type specifying the raster cellsize environment settings for analysis. All subsequent results will be to the value specified. It can be of type esriRasterEnvMaxOf – The largest cell size of all input raster datasets that are specifed in the function. This is the default. This option is not suitable for methods such as IInterpolationOp::IDW, IDensityOp:KernalDensity etc. where features are the only inputs. Use esriRasterEnvValue instead. esriRasterEnvMinOf - Smallest cell size of all input raster datasets. This option is not suitable for methods such as IInterpolationOp::IDW, IDensityOp:KernalDensity etc. where features are the only inputs. Use esriRasterEnvValue instead esriRasterEnvValue - Any user specified value for the cell size. Use this option to specify a particular value for a cell size or for methods such as IInterpolationOp::IDW, IDensityOp:KernalDensity etc. where features are the only input.

[cellSizeProvider]

A specified value (double) or RasterDataset that is used to provide the cellsize environment value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCellSize in interface IRasterAnalysisEnvironment

Parameters:

envType - A com.esri.arcgis.geoanalyst.esriRasterEnvSettingEnum constant (in)

cellSizeProvider - A Variant (in, optional, pass null if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCellSize

public void getCellSize(int[] envType,
                        double[] cellSize)
                 throws IOException,
                        AutomationException

Gets the type and value of cell size in the RasterAnalysis.

Remarks

envType	will return an enumeration type constant specifying the raster cellsize environment settings for analysis. It can be of type esriRasterEnvMaxOf - largest cell size of all input datasets. This is the default. esriRasterEnvMinOf - smallest cell size of all input datasets esriRasterEnvValue - User specified value.
cellsize	returns a value that specifying the current environment setting for cellsize

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCellSize in interface IRasterAnalysisEnvironment

Parameters:

envType - A com.esri.arcgis.geoanalyst.esriRasterEnvSettingEnum constant (out: use single element array)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtent

public void setExtent(int envType,
                      Object extentProvider,
                      Object snapRasterData)
               throws IOException,
                      AutomationException

Sets the type and values of extent in the RasterAnalysis.

Remarks

envType	An enumeration type specifying the raster extent environment settings for analysis. All subsequent results will be to this extent. It can be of type esriRasterEnvMinOf – Intersection of Inputs - All input feature extents are intersected and the extent common to all is used as the extent values for the study area. This is the default. esriRasterEnvMaxOf - Union of Inputs - All input feature extents are combined and the outer extent of the union is used. esriRasterEnvValue - Value - User specified values for the Left, Right, Top and Bottom extent (x, y values) of the study area.
[extentProvider]	An envelope object supporting IEnvelope interface or RasterDataset that is used to provide the environment values of the analysis extent.
[snapRasterData]	A RasterDataset that can be used to snap all output raster datasets to the cell registration of the specified raster. All subsequent results will share the lower-left corner and cell size of the specified raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setExtent in interface IRasterAnalysisEnvironment

Parameters:

envType - A com.esri.arcgis.geoanalyst.esriRasterEnvSettingEnum constant (in)

extentProvider - A Variant (in, optional, pass null if not required)

snapRasterData - A Variant (in, optional, pass null if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtent

public void getExtent(int[] envType,
                      IEnvelope[] extent)
               throws IOException,
                      AutomationException

Gets the type and values of extent in the RasterAnalysis.

Remarks

envType

will return an enumeration constant specifying the raster extent environment settings for analysis. It can be of type, esriRasterEnvMinOf – Intersection of Inputs - All input feature extents are intersected and the extent common to all is used as the extent values for the study area. This is the default. esriRasterEnvMaxOf - Union of Inputs - All input feature extents are combined and the outer extent of the union is used. esriRasterEnvValue - Value - User specified values for the Left, Right, Top and Bottom extent (x, y values) of the study area.

extent

An envelope object supporting IEnvelope interface used to describe the values of the analysis extent.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExtent in interface IRasterAnalysisEnvironment

Parameters:

envType - A com.esri.arcgis.geoanalyst.esriRasterEnvSettingEnum constant (out: use single element array)

extent - A reference to a com.esri.arcgis.geometry.IEnvelope (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaskByRef

public void setMaskByRef(IGeoDataset mask)
                  throws IOException,
                         AutomationException

Mask allows processing to occur only for a selected set of cells.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMaskByRef in interface IRasterAnalysisEnvironment

Parameters:

mask - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMask

public IGeoDataset getMask()
                    throws IOException,
                           AutomationException

Mask allows processing to occur only for a selected set of cells.

Remarks

The mask can be a reference to a Raster, RasterDataset, RasterBand, or RasterDescriptor object or FeatureClass, FeatureClassDescriptor object.

The mask identifies only those cells within the analysis extent that will be considered when performing an action. Only the identified cells will be processed in subsequent output raster datasets. All other cells are characterized as nodata.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMask in interface IRasterAnalysisEnvironment

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVerifyType

public void setVerifyType(int verifyType)
                   throws IOException,
                          AutomationException

The verify type of the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setVerifyType in interface IRasterAnalysisEnvironment

Parameters:

verifyType - A com.esri.arcgis.geoanalyst.esriRasterVerifyEnum constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVerifyType

public int getVerifyType()
                  throws IOException,
                         AutomationException

The verify type of the RasterAnalysis.

Remarks

The value is an enumeration environment setting that contols the way that an output RasterDatasets are written to file when during analysis. The verify enumeration can be of type

esriRasterEnvVerifyOn - specifies that the user will be prompted to verify the output already exists and it is okay to overwrite it

esriRasterEnvVerifyOff - specifies that output data will be automatically overwritten if already exists. This is the default environment setting.

esriRasterEnvVerifyError - specifies that an error will be produced when the output already exists.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getVerifyType in interface IRasterAnalysisEnvironment

Returns:

A com.esri.arcgis.geoanalyst.esriRasterVerifyEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultOutputRasterPrefix

public String getDefaultOutputRasterPrefix()
                                    throws IOException,
                                           AutomationException

The default output raster prefix.

Remarks

The user specified prefix which is included to all temporary output RasterDatasets during analysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDefaultOutputRasterPrefix in interface IRasterAnalysisEnvironment

Returns:

The rasterPrefix

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultOutputRasterPrefix

public void setDefaultOutputRasterPrefix(String rasterPrefix)
                                  throws IOException,
                                         AutomationException

The default output raster prefix.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDefaultOutputRasterPrefix in interface IRasterAnalysisEnvironment

Parameters:

rasterPrefix - The rasterPrefix (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultOutputVectorPrefix

public String getDefaultOutputVectorPrefix()
                                    throws IOException,
                                           AutomationException

The default output vector prefix.

Remarks

The user specified prefix which is included to all temporary output Shapefiles during analysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDefaultOutputVectorPrefix in interface IRasterAnalysisEnvironment

Returns:

The vectorPrefix

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultOutputVectorPrefix

public void setDefaultOutputVectorPrefix(String vectorPrefix)
                                  throws IOException,
                                         AutomationException

The default output vector prefix.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDefaultOutputVectorPrefix in interface IRasterAnalysisEnvironment

Parameters:

vectorPrefix - The vectorPrefix (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAsNewDefaultEnvironment

public void setAsNewDefaultEnvironment()
                                throws IOException,
                                       AutomationException

Sets the raster analysis environment of the object as new default environment.

Remarks

Will set all current environment settings of the RasterAnalysis object as the new default environment. All subsequent analysis will use the set object properties unless otherwise specified.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAsNewDefaultEnvironment in interface IRasterAnalysisEnvironment

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

restoreToPreviousDefaultEnvironment

public void restoreToPreviousDefaultEnvironment()
                                         throws IOException,
                                                AutomationException

Restores to the previous default raster analysis environment.

Remarks

This will restore the default environment to the settings of the "previous" RasterAnalysisEnvironment object used to set the default environement. Note: If multiple default environments have been set it will reference the past settings one at a time in order of sequence.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

restoreToPreviousDefaultEnvironment in interface IRasterAnalysisEnvironment

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws IOException,
                  AutomationException

Remove all previously stored default rasteranalysis environments.

Remarks

This method can be used to restore the system default raster environment settings for extent, cell size, precision, spatial reference and/or current workspace for analysis. This will change all previously altered environment settings made to the RasterAnlaysis object back to the original settings.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

reset in interface IRasterAnalysisEnvironment

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutWorkspaceByRef

public void setOutWorkspaceByRef(IWorkspace workspace)
                          throws IOException,
                                 AutomationException

The output workspace of GeoAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setOutWorkspaceByRef in interface IGeoAnalysisEnvironment

Parameters:

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

getOutWorkspace

public IWorkspace getOutWorkspace()
                           throws IOException,
                                  AutomationException

The output workspace of GeoAnalysis.

Remarks

The variable is an object specifying the directory or subdirectory to contain the output rasterdataset

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOutWorkspace in interface IGeoAnalysisEnvironment

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.

setOutSpatialReferenceByRef

public void setOutSpatialReferenceByRef(ISpatialReference spatialReference)
                                 throws IOException,
                                        AutomationException

The output spatial reference of GeoAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setOutSpatialReferenceByRef in interface IGeoAnalysisEnvironment

Parameters:

spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutSpatialReference

public ISpatialReference getOutSpatialReference()
                                         throws IOException,
                                                AutomationException

The output spatial reference of GeoAnalysis.

Remarks

The variable references an object that specifies the output features spatial reference. If not explicitly set the spatial reference of the input features will be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOutSpatialReference in interface IGeoAnalysisEnvironment

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGlobeOptimized

public void setGlobeOptimized(boolean globeOptimized)
                       throws IOException,
                              AutomationException

Indicates if the globe optimized type in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setGlobeOptimized in interface IRasterAnalysisGDBEnvironment

Parameters:

globeOptimized - The globeOptimized (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isGlobeOptimized

public boolean isGlobeOptimized()
                         throws IOException,
                                AutomationException

Indicates if the globe optimized type in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isGlobeOptimized in interface IRasterAnalysisGDBEnvironment

Returns:

The globeOptimized

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMosaicType

public void setMosaicType(int mosaicType)
                   throws IOException,
                          AutomationException

The mosaic type in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMosaicType in interface IRasterAnalysisGDBEnvironment

Parameters:

mosaicType - A com.esri.arcgis.datasourcesraster.rstMosaicOperatorType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMosaicType

public int getMosaicType()
                  throws IOException,
                         AutomationException

The mosaic type in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMosaicType in interface IRasterAnalysisGDBEnvironment

Returns:

A com.esri.arcgis.datasourcesraster.rstMosaicOperatorType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCompressionType

public void setCompressionType(int compressionType)
                        throws IOException,
                               AutomationException

The type and value of compression in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCompressionType in interface IRasterAnalysisGDBEnvironment

Parameters:

compressionType - A com.esri.arcgis.geoanalyst.esriRasterGDBCompressionEnum constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCompressionType

public int getCompressionType()
                       throws IOException,
                              AutomationException

The type and value of compression in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCompressionType in interface IRasterAnalysisGDBEnvironment

Returns:

A com.esri.arcgis.geoanalyst.esriRasterGDBCompressionEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setJpegQuality

public void setJpegQuality(int jpegQuality)
                    throws IOException,
                           AutomationException

Jpeg compression quality in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setJpegQuality in interface IRasterAnalysisGDBEnvironment

Parameters:

jpegQuality - The jpegQuality (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJpegQuality

public int getJpegQuality()
                   throws IOException,
                          AutomationException

Jpeg compression quality in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getJpegQuality in interface IRasterAnalysisGDBEnvironment

Returns:

The jpegQuality

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBuildPyramid

public void setBuildPyramid(boolean buildParamid)
                     throws IOException,
                            AutomationException

Indicates if the pyramid building in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBuildPyramid in interface IRasterAnalysisGDBEnvironment

Parameters:

buildParamid - The buildParamid (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBuildPyramid

public boolean isBuildPyramid()
                       throws IOException,
                              AutomationException

Indicates if the pyramid building in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isBuildPyramid in interface IRasterAnalysisGDBEnvironment

Returns:

The buildParamid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPyramidResampleType

public void setPyramidResampleType(int resampleType)
                            throws IOException,
                                   AutomationException

The resample type in pyramid building in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPyramidResampleType in interface IRasterAnalysisGDBEnvironment

Parameters:

resampleType - A com.esri.arcgis.geoanalyst.esriGeoAnalysisResampleEnum constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPyramidResampleType

public int getPyramidResampleType()
                           throws IOException,
                                  AutomationException

The resample type in pyramid building in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPyramidResampleType in interface IRasterAnalysisGDBEnvironment

Returns:

A com.esri.arcgis.geoanalyst.esriGeoAnalysisResampleEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPyramidLevel

public void setPyramidLevel(int level)
                     throws IOException,
                            AutomationException

The level in pyramid building in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPyramidLevel in interface IRasterAnalysisGDBEnvironment

Parameters:

level - The level (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPyramidLevel

public int getPyramidLevel()
                    throws IOException,
                           AutomationException

The level in pyramid building in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPyramidLevel in interface IRasterAnalysisGDBEnvironment

Returns:

The level

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCalculateStatistics

public void setCalculateStatistics(boolean calculateStatistics)
                            throws IOException,
                                   AutomationException

Indicates if the statistics calculation in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCalculateStatistics in interface IRasterAnalysisGDBEnvironment

Parameters:

calculateStatistics - The calculateStatistics (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCalculateStatistics

public boolean isCalculateStatistics()
                              throws IOException,
                                     AutomationException

Indicates if the statistics calculation in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isCalculateStatistics in interface IRasterAnalysisGDBEnvironment

Returns:

The calculateStatistics

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 skip factor in X direction in statistics calculation in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setXSkipFactor in interface IRasterAnalysisGDBEnvironment

Parameters:

xSkipFactor - The xSkipFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getXSkipFactor

public int getXSkipFactor()
                   throws IOException,
                          AutomationException

The skip factor in X direction in statistics calculation in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getXSkipFactor in interface IRasterAnalysisGDBEnvironment

Returns:

The xSkipFactor

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 skip factor in Y direction in statistics calculation in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setYSkipFactor in interface IRasterAnalysisGDBEnvironment

Parameters:

ySkipFactor - The ySkipFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getYSkipFactor

public int getYSkipFactor()
                   throws IOException,
                          AutomationException

The skip factor in Y direction in statistics calculation in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getYSkipFactor in interface IRasterAnalysisGDBEnvironment

Returns:

The ySkipFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIgnoredValue

public void setIgnoredValue(String ignoredValue)
                     throws IOException,
                            AutomationException

The ignored value in statistics calculation in RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setIgnoredValue in interface IRasterAnalysisGDBEnvironment

Parameters:

ignoredValue - The ignoredValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIgnoredValue

public String getIgnoredValue()
                       throws IOException,
                              AutomationException

The ignored value in statistics calculation in RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getIgnoredValue in interface IRasterAnalysisGDBEnvironment

Returns:

The ignoredValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTileWidth

public void setTileWidth(int tileWidth)
                  throws IOException,
                         AutomationException

The GeoDatabase tile width in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTileWidth in interface IRasterAnalysisGDBEnvironment

Parameters:

tileWidth - The tileWidth (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTileWidth

public int getTileWidth()
                 throws IOException,
                        AutomationException

The GeoDatabase tile width in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTileWidth in interface IRasterAnalysisGDBEnvironment

Returns:

The tileWidth

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTileHeight

public void setTileHeight(int tileHeight)
                   throws IOException,
                          AutomationException

The GeoDatabase tile height in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTileHeight in interface IRasterAnalysisGDBEnvironment

Parameters:

tileHeight - The tileHeight (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTileHeight

public int getTileHeight()
                  throws IOException,
                         AutomationException

The GeoDatabase tile height in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTileHeight in interface IRasterAnalysisGDBEnvironment

Returns:

The tileHeight

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConfigurationKeyword

public void setConfigurationKeyword(String configKeyword)
                             throws IOException,
                                    AutomationException

The configuration keyword in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setConfigurationKeyword in interface IRasterAnalysisGDBEnvironment

Parameters:

configKeyword - The configKeyword (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConfigurationKeyword

public String getConfigurationKeyword()
                               throws IOException,
                                      AutomationException

The configuration keyword in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getConfigurationKeyword in interface IRasterAnalysisGDBEnvironment

Returns:

The configKeyword

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGDBDomainsByRef

public void setGDBDomainsByRef(ISpatialReference domainsSpRef)
                        throws IOException,
                               AutomationException

The XY, Z and M domains in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setGDBDomainsByRef in interface IRasterAnalysisGDBEnvironment

Parameters:

domainsSpRef - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGDBDomains

public ISpatialReference getGDBDomains()
                                throws IOException,
                                       AutomationException

The XY, Z and M domains in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getGDBDomains in interface IRasterAnalysisGDBEnvironment

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAvoidDataConversion

public void setAvoidDataConversion(boolean bAvoid)
                            throws IOException,
                                   AutomationException

Indicates weather to avoid data conversion in the RasterAnalysis.

Remarks

Setting to false (the default setting) is the same as in versions before ArcGIS 9.4.

Setting the property to True ensures that all processing is performed natively on the raster data. This improves the overall performance as there is no need for the input data to be converted to ESRI grid format. The output data, however, is still temporary rasters in ESRI grid format.

Product Availability

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

Specified by:

setAvoidDataConversion in interface IRasterAnalysisGlobalEnvironment

Parameters:

bAvoid - The bAvoid (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAvoidDataConversion

public boolean isAvoidDataConversion()
                              throws IOException,
                                     AutomationException

Indicates weather to avoid data conversion in the RasterAnalysis.

Product Availability

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

Specified by:

isAvoidDataConversion in interface IRasterAnalysisGlobalEnvironment

Returns:

The bAvoid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addOutputDatasetName

public void addOutputDatasetName(int index,
                                 IDatasetName pOutName)
                          throws IOException,
                                 AutomationException

Adds an output dataset name to the specified index.

Product Availability

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

Specified by:

addOutputDatasetName in interface IRasterOpBase

Parameters:

index - The index (in)

pOutName - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputDatasetNameArrayByRef

public void setOutputDatasetNameArrayByRef(IArray rhs1)
                                    throws IOException,
                                           AutomationException

Puts output name array.

Product Availability

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

Specified by:

setOutputDatasetNameArrayByRef in interface IRasterOpBase

Parameters:

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

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

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.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException