com.esri.arcgis.spatialanalyst
Class GPSAUtil

java.lang.Object
  com.esri.arcgis.spatialanalyst.GPSAUtil

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IGPSAUtil, Serializable

public class GPSAUtil
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPSAUtil

GeoProcessor Spatial SpatialUtil object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Singleton:

This type is a singleton.

See Also:

Serialized Form

Constructor Summary

GPSAUtil()
Constructs a GPSAUtil using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
int	getAPrioriEnum(String name) Gets the Apriori Enum.
static String	getClsid() getClsid.
ICodedValueDomain	getCodedValueDomainFromRemap(IGPValue pValue) Gets a CodedValueDomain From Remap.
int	getCostPathEnum(String name) Gets Cost Path Enum.
int	getFilterEnum(String name) Gets Filter Enum.
IGPValue	getRemapFromCodedValueDomain(ICodedValueDomain pCVDomain, IGPEvaluationScale pEvalScale) Gets Remap From a CodedValueDomain.
int	getSemiVariogramEnum(String svgName) Gets SemiVariogram Enum.
int	getSliceEnum(String name) Gets Slice Enum.
int	getSlopeEnum(String name) Gets Slope Enum.
int	getSortEnum(String name) Gets Sort Enum.
int	getSplineEnum(String name) Gets spline Enum.
int	getStatisticsEnum(String statsName, boolean bInteger) Gets Statistics Enum.
int	getStreamOrderEnum(String name) Gets Stream Order Enum.
int	getTopoFeatureEnum(String topoFeatureName) Gets the TopoFeature Enum.
String	getTopoFeatureName(int topoEnum) Gets the TopoFeature Name.
int	getTrendEnum(String name) Gets Trend Enum.
int	getVisibilityEnum(String name) Gets Visibility Enum.
int	getZonalGeometryEnum(String name) Gets Zonal Geometry Enum.
int	hashCode() the hashcode for this object
void	setStatisticsDomain(boolean bInteger, IGPCodedValueDomain[] pDomian) Sets a statistics domain.

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

GPSAUtil

public GPSAUtil()
         throws IOException,
                UnknownHostException

Constructs a GPSAUtil using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GPSAUtil

public GPSAUtil(Object obj)
         throws IOException

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

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

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

setStatisticsDomain

public void setStatisticsDomain(boolean bInteger,
                                IGPCodedValueDomain[] pDomian)
                         throws IOException,
                                AutomationException

Sets a statistics domain.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Specified by:

setStatisticsDomain in interface IGPSAUtil

Parameters:

bInteger - The bInteger (in)

pDomian - A reference to a com.esri.arcgis.geodatabase.IGPCodedValueDomain (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSplineEnum

public int getSplineEnum(String name)
                  throws IOException,
                         AutomationException

Gets spline Enum.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Specified by:

getSplineEnum in interface IGPSAUtil

Parameters:

name - The name (in)

Returns:

A com.esri.arcgis.geoanalyst.esriGeoAnalysisSplineEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTrendEnum

public int getTrendEnum(String name)
                 throws IOException,
                        AutomationException

Gets Trend Enum.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Specified by:

getTrendEnum in interface IGPSAUtil

Parameters:

name - The name (in)

Returns:

A com.esri.arcgis.geoanalyst.esriGeoAnalysisTrendEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVisibilityEnum

public int getVisibilityEnum(String name)
                      throws IOException,
                             AutomationException

Gets Visibility Enum.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Specified by:

getVisibilityEnum in interface IGPSAUtil

Parameters:

name - The name (in)

Returns:

A com.esri.arcgis.geoanalyst.esriGeoAnalysisVisibilityEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSlopeEnum

public int getSlopeEnum(String name)
                 throws IOException,
                        AutomationException

Gets Slope Enum.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Specified by:

getSlopeEnum in interface IGPSAUtil

Parameters:

name - The name (in)

Returns:

A com.esri.arcgis.geoanalyst.esriGeoAnalysisSlopeEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSliceEnum

public int getSliceEnum(String name)
                 throws IOException,
                        AutomationException

Gets Slice Enum.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Specified by:

getSliceEnum in interface IGPSAUtil

Parameters:

name - The name (in)

Returns:

A com.esri.arcgis.geoanalyst.esriGeoAnalysisSliceEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFilterEnum

public int getFilterEnum(String name)
                  throws IOException,
                         AutomationException

Gets Filter Enum.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Specified by:

getFilterEnum in interface IGPSAUtil

Parameters:

name - The name (in)

Returns:

A com.esri.arcgis.geoanalyst.esriGeoAnalysisFilterEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStatisticsEnum

public int getStatisticsEnum(String statsName,
                             boolean bInteger)
                      throws IOException,
                             AutomationException

Gets Statistics Enum.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Specified by:

getStatisticsEnum in interface IGPSAUtil

Parameters:

statsName - The statsName (in)

bInteger - The bInteger (in)

Returns:

A com.esri.arcgis.geoanalyst.esriGeoAnalysisStatisticsEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSemiVariogramEnum

public int getSemiVariogramEnum(String svgName)
                         throws IOException,
                                AutomationException

Gets SemiVariogram Enum.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Specified by:

getSemiVariogramEnum in interface IGPSAUtil

Parameters:

svgName - The svgName (in)

Returns:

A com.esri.arcgis.geoanalyst.esriGeoAnalysisSemiVariogramEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStreamOrderEnum

public int getStreamOrderEnum(String name)
                       throws IOException,
                              AutomationException

Gets Stream Order Enum.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Specified by:

getStreamOrderEnum in interface IGPSAUtil

Parameters:

name - The name (in)

Returns:

A com.esri.arcgis.spatialanalyst.esriGeoAnalysisStreamOrderEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCostPathEnum

public int getCostPathEnum(String name)
                    throws IOException,
                           AutomationException

Gets Cost Path Enum.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Specified by:

getCostPathEnum in interface IGPSAUtil

Parameters:

name - The name (in)

Returns:

A com.esri.arcgis.spatialanalyst.esriGeoAnalysisPathEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSortEnum

public int getSortEnum(String name)
                throws IOException,
                       AutomationException

Gets Sort Enum.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Specified by:

getSortEnum in interface IGPSAUtil

Parameters:

name - The name (in)

Returns:

A com.esri.arcgis.spatialanalyst.esriGeoAnalysisSortEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getZonalGeometryEnum

public int getZonalGeometryEnum(String name)
                         throws IOException,
                                AutomationException

Gets Zonal Geometry Enum.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Specified by:

getZonalGeometryEnum in interface IGPSAUtil

Parameters:

name - The name (in)

Returns:

A com.esri.arcgis.spatialanalyst.esriGeoAnalysisZonalGeometryEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAPrioriEnum

public int getAPrioriEnum(String name)
                   throws IOException,
                          AutomationException

Gets the Apriori Enum.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Specified by:

getAPrioriEnum in interface IGPSAUtil

Parameters:

name - The name (in)

Returns:

A com.esri.arcgis.spatialanalyst.esriGeoAnalysisAPrioriEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTopoFeatureName

public String getTopoFeatureName(int topoEnum)
                          throws IOException,
                                 AutomationException

Gets the TopoFeature Name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Specified by:

getTopoFeatureName in interface IGPSAUtil

Parameters:

topoEnum - A com.esri.arcgis.spatialanalyst.esriGPSATopoTypeEnum constant (in)

Returns:

The topoFeatureName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTopoFeatureEnum

public int getTopoFeatureEnum(String topoFeatureName)
                       throws IOException,
                              AutomationException

Gets the TopoFeature Enum.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Specified by:

getTopoFeatureEnum in interface IGPSAUtil

Parameters:

topoFeatureName - The topoFeatureName (in)

Returns:

A com.esri.arcgis.spatialanalyst.esriGPSATopoTypeEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCodedValueDomainFromRemap

public ICodedValueDomain getCodedValueDomainFromRemap(IGPValue pValue)
                                               throws IOException,
                                                      AutomationException

Gets a CodedValueDomain From Remap.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Specified by:

getCodedValueDomainFromRemap in interface IGPSAUtil

Parameters:

pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRemapFromCodedValueDomain

public IGPValue getRemapFromCodedValueDomain(ICodedValueDomain pCVDomain,
                                             IGPEvaluationScale pEvalScale)
                                      throws IOException,
                                             AutomationException

Gets Remap From a CodedValueDomain.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Specified by:

getRemapFromCodedValueDomain in interface IGPSAUtil

Parameters:

pCVDomain - A reference to a com.esri.arcgis.geodatabase.ICodedValueDomain (in)

pEvalScale - A reference to a com.esri.arcgis.spatialanalyst.IGPEvaluationScale (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.