com.esri.arcgis.geoanalyst
Class RasterModel

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

All Implemented Interfaces:

IGeoAnalysisEnvironment, IRasterAnalysisEnvironment, IRasterAnalysisGlobalEnvironment, IRasterModel, IRasterOpBase, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, java.io.Serializable

public class RasterModel
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterAnalysisEnvironment, IRasterAnalysisGlobalEnvironment, IRasterOpBase, IRasterModel, ISupportErrorInfo

COM Class 'RasterModel'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriGeoAnalyst.olb'

Description 'A mechanism that allows scripting of operations, and inclusion of non-raster input/output formats (feature data, tables, etc).' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.geoanalyst.IRasterAnalysisEnvironment

IID, IID3297e9c5_93a1_11d2_9f33_00c04f8ed1d7, xxDummy

Fields inherited from interface com.esri.arcgis.geoanalyst.IGeoAnalysisEnvironment

IID3297e9c8_93a1_11d2_9f33_00c04f8ed1d7

Fields inherited from interface com.esri.arcgis.geoanalyst.IRasterAnalysisGlobalEnvironment

IID, IID5aa98a9d_7f47_4d69_ad97_0fe4893f5dee, xxDummy

Fields inherited from interface com.esri.arcgis.geoanalyst.IRasterOpBase

IID, IID3a6957fc_a3f2_4a62_99da_5362833777f3, xxDummy

Fields inherited from interface com.esri.arcgis.geoanalyst.IRasterModel

IID, IID4606f163_b47d_11d2_9f3b_00c04f8ed1d7, xxDummy

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

RasterModel()
Constructs a RasterModel using ArcGIS Engine.

RasterModel(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterModel theRasterModel = (RasterModel) obj;

Method Summary

void	addOutputDatasetName(int index, IDatasetName pOutName) Adds an output dataset name to the specified index.
void	bindFeatureClass(IFeatureClass featureClass, java.lang.String symbol) Binds a symbol to a FeatureClass.
void	bindRaster(IRaster raster, java.lang.String symbol) Binds a symbol to a Raster.
void	bindString(java.lang.String strName, java.lang.String symbol) Binds a symbol to a String.
void	bindTable(ITable table, java.lang.String symbol) Binds a symbol to a Table.
boolean	equals(java.lang.Object o) Compare this object with another
void	execute() Produces a Raster by executing a script.
IFeatureClass	getBoundFeatureClass(java.lang.String symbol) Finds the FeatureClass corresponding to a symbol.
IRaster	getBoundRaster(java.lang.String symbol) Finds the Raster corresponding to a symbol.
ITable	getBoundTable(java.lang.String symbol) Finds the Table corresponding to a symbol.
java.lang.Object	getBoundUnknown(java.lang.String symbol) Finds the interface pointer corresponding to a symbol.
void	getCellSize(int[] envType, double[] cellSize) Gets the type and value of cell size in the RasterAnalysis.
static java.lang.String	getClsid() getClsid.
java.lang.String	getDefaultOutputRasterPrefix() The default output raster prefix.
java.lang.String	getDefaultOutputVectorPrefix() The default output vector prefix.
void	getExtent(int[] envType, IEnvelope[] extent) Gets the type and values of extent in the RasterAnalysis.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
IGeoDataset	getMask() Mask allows processing to occur only for a selected set of cells.
ISpatialReference	getOutSpatialReference() The output spatial reference of GeoAnalysis.
IWorkspace	getOutWorkspace() The output workspace of GeoAnalysis.
int	getVerifyType() The verify type of 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.
void	release() Release a RasterModel.
void	reset() Remove all previously stored default rasteranalysis environments.
void	restoreToPreviousDefaultEnvironment() Restores to the previous default raster analysis environment.
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	setCellSize(int envType, java.lang.Object cellSizeProvider) Sets the type and value of cell size in the RasterAnalysis.
void	setDefaultOutputRasterPrefix(java.lang.String rasterPrefix) The default output raster prefix.
void	setDefaultOutputVectorPrefix(java.lang.String vectorPrefix) The default output vector prefix.
void	setExtent(int envType, java.lang.Object extentProvider, java.lang.Object snapRasterData) Sets the type and values of extent in the RasterAnalysis.
void	setMaskByRef(IGeoDataset mask) Mask allows processing to occur only for a selected set of cells.
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	setScript(java.lang.String rhs1) The model script.
void	setVerifyType(int verifyType) The verify type of the RasterAnalysis.
void	unbindSymbol(java.lang.String symbol) Unbinds a symbol.

Methods inherited from class java.lang.Object

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

Constructor Detail

RasterModel

public RasterModel()
            throws java.io.IOException,
                   java.net.UnknownHostException

Constructs a RasterModel using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

RasterModel

public RasterModel(java.lang.Object obj)
            throws java.io.IOException

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

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

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()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a RasterModel.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

setCellSize

public void setCellSize(int envType,
                        java.lang.Object cellSizeProvider)
                 throws java.io.IOException,
                        AutomationException

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

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCellSize

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

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

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtent

public void setExtent(int envType,
                      java.lang.Object extentProvider,
                      java.lang.Object snapRasterData)
               throws java.io.IOException,
                      AutomationException

Sets the type and values of extent in the RasterAnalysis.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtent

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

Gets the type and values of extent in the RasterAnalysis.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaskByRef

public void setMaskByRef(IGeoDataset mask)
                  throws java.io.IOException,
                         AutomationException

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

Specified by:

setMaskByRef in interface IRasterAnalysisEnvironment

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMask

public IGeoDataset getMask()
                    throws java.io.IOException,
                           AutomationException

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

Specified by:

getMask in interface IRasterAnalysisEnvironment

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVerifyType

public void setVerifyType(int verifyType)
                   throws java.io.IOException,
                          AutomationException

The verify type of the RasterAnalysis.

Specified by:

setVerifyType in interface IRasterAnalysisEnvironment

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVerifyType

public int getVerifyType()
                  throws java.io.IOException,
                         AutomationException

The verify type of the RasterAnalysis.

Specified by:

getVerifyType in interface IRasterAnalysisEnvironment

Returns:

A com.esri.arcgis.geoanalyst.esriRasterVerifyEnum constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultOutputRasterPrefix

public java.lang.String getDefaultOutputRasterPrefix()
                                              throws java.io.IOException,
                                                     AutomationException

The default output raster prefix.

Specified by:

getDefaultOutputRasterPrefix in interface IRasterAnalysisEnvironment

Returns:

The rasterPrefix

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultOutputRasterPrefix

public void setDefaultOutputRasterPrefix(java.lang.String rasterPrefix)
                                  throws java.io.IOException,
                                         AutomationException

The default output raster prefix.

Specified by:

setDefaultOutputRasterPrefix in interface IRasterAnalysisEnvironment

Parameters:

rasterPrefix - The rasterPrefix (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultOutputVectorPrefix

public java.lang.String getDefaultOutputVectorPrefix()
                                              throws java.io.IOException,
                                                     AutomationException

The default output vector prefix.

Specified by:

getDefaultOutputVectorPrefix in interface IRasterAnalysisEnvironment

Returns:

The vectorPrefix

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultOutputVectorPrefix

public void setDefaultOutputVectorPrefix(java.lang.String vectorPrefix)
                                  throws java.io.IOException,
                                         AutomationException

The default output vector prefix.

Specified by:

setDefaultOutputVectorPrefix in interface IRasterAnalysisEnvironment

Parameters:

vectorPrefix - The vectorPrefix (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAsNewDefaultEnvironment

public void setAsNewDefaultEnvironment()
                                throws java.io.IOException,
                                       AutomationException

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

Specified by:

setAsNewDefaultEnvironment in interface IRasterAnalysisEnvironment

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

restoreToPreviousDefaultEnvironment

public void restoreToPreviousDefaultEnvironment()
                                         throws java.io.IOException,
                                                AutomationException

Restores to the previous default raster analysis environment.

Specified by:

restoreToPreviousDefaultEnvironment in interface IRasterAnalysisEnvironment

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws java.io.IOException,
                  AutomationException

Remove all previously stored default rasteranalysis environments.

Specified by:

reset in interface IRasterAnalysisEnvironment

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutWorkspaceByRef

public void setOutWorkspaceByRef(IWorkspace workspace)
                          throws java.io.IOException,
                                 AutomationException

The output workspace of GeoAnalysis.

Specified by:

setOutWorkspaceByRef in interface IGeoAnalysisEnvironment

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutWorkspace

public IWorkspace getOutWorkspace()
                           throws java.io.IOException,
                                  AutomationException

The output workspace of GeoAnalysis.

Specified by:

getOutWorkspace in interface IGeoAnalysisEnvironment

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutSpatialReferenceByRef

public void setOutSpatialReferenceByRef(ISpatialReference spatialReference)
                                 throws java.io.IOException,
                                        AutomationException

The output spatial reference of GeoAnalysis.

Specified by:

setOutSpatialReferenceByRef in interface IGeoAnalysisEnvironment

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutSpatialReference

public ISpatialReference getOutSpatialReference()
                                         throws java.io.IOException,
                                                AutomationException

The output spatial reference of GeoAnalysis.

Specified by:

getOutSpatialReference in interface IGeoAnalysisEnvironment

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAvoidDataConversion

public void setAvoidDataConversion(boolean bAvoid)
                            throws java.io.IOException,
                                   AutomationException

Indicates weather to avoid data conversion in the RasterAnalysis.

Specified by:

setAvoidDataConversion in interface IRasterAnalysisGlobalEnvironment

Parameters:

bAvoid - The bAvoid (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAvoidDataConversion

public boolean isAvoidDataConversion()
                              throws java.io.IOException,
                                     AutomationException

Indicates weather to avoid data conversion in the RasterAnalysis.

Specified by:

isAvoidDataConversion in interface IRasterAnalysisGlobalEnvironment

Returns:

The bAvoid

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addOutputDatasetName

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

Adds an output dataset name to the specified index.

Specified by:

addOutputDatasetName in interface IRasterOpBase

Parameters:

index - The index (in)

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputDatasetNameArrayByRef

public void setOutputDatasetNameArrayByRef(IArray rhs1)
                                    throws java.io.IOException,
                                           AutomationException

Puts output name array.

Specified by:

setOutputDatasetNameArrayByRef in interface IRasterOpBase

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setScript

public void setScript(java.lang.String rhs1)
               throws java.io.IOException,
                      AutomationException

The model script.

Specified by:

setScript in interface IRasterModel

Parameters:

rhs1 - The rhs1 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

bindRaster

public void bindRaster(IRaster raster,
                       java.lang.String symbol)
                throws java.io.IOException,
                       AutomationException

Binds a symbol to a Raster.

Specified by:

bindRaster in interface IRasterModel

Parameters:

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

symbol - The symbol (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

bindFeatureClass

public void bindFeatureClass(IFeatureClass featureClass,
                             java.lang.String symbol)
                      throws java.io.IOException,
                             AutomationException

Binds a symbol to a FeatureClass.

Specified by:

bindFeatureClass in interface IRasterModel

Parameters:

featureClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)

symbol - The symbol (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

bindTable

public void bindTable(ITable table,
                      java.lang.String symbol)
               throws java.io.IOException,
                      AutomationException

Binds a symbol to a Table.

Specified by:

bindTable in interface IRasterModel

Parameters:

table - A reference to a com.esri.arcgis.geodatabase.ITable (in)

symbol - The symbol (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

bindString

public void bindString(java.lang.String strName,
                       java.lang.String symbol)
                throws java.io.IOException,
                       AutomationException

Binds a symbol to a String.

Specified by:

bindString in interface IRasterModel

Parameters:

strName - The strName (in)

symbol - The symbol (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

execute

public void execute()
             throws java.io.IOException,
                    AutomationException

Produces a Raster by executing a script.

Specified by:

execute in interface IRasterModel

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBoundRaster

public IRaster getBoundRaster(java.lang.String symbol)
                       throws java.io.IOException,
                              AutomationException

Finds the Raster corresponding to a symbol.

Specified by:

getBoundRaster in interface IRasterModel

Parameters:

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

getBoundFeatureClass

public IFeatureClass getBoundFeatureClass(java.lang.String symbol)
                                   throws java.io.IOException,
                                          AutomationException

Finds the FeatureClass corresponding to a symbol.

Specified by:

getBoundFeatureClass in interface IRasterModel

Parameters:

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

getBoundTable

public ITable getBoundTable(java.lang.String symbol)
                     throws java.io.IOException,
                            AutomationException

Finds the Table corresponding to a symbol.

Specified by:

getBoundTable in interface IRasterModel

Parameters:

symbol - The symbol (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBoundUnknown

public java.lang.Object getBoundUnknown(java.lang.String symbol)
                                 throws java.io.IOException,
                                        AutomationException

Finds the interface pointer corresponding to a symbol.

Specified by:

getBoundUnknown in interface IRasterModel

Parameters:

symbol - The symbol (in)

Returns:

A reference to another Object (IUnknown)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

unbindSymbol

public void unbindSymbol(java.lang.String symbol)
                  throws java.io.IOException,
                         AutomationException

Unbinds a symbol.

Specified by:

unbindSymbol in interface IRasterModel

Parameters:

symbol - The symbol (in)

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

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.