com.esri.arcgis.geoprocessing
Class GPRasterGDBEnvCompressionType

java.lang.Object
  com.esri.arcgis.geoprocessing.GPRasterGDBEnvCompressionType

All Implemented Interfaces:

IGPDataType, IGPRasterGDBEnvCompressionType, com.esri.arcgis.interop.RemoteObjRef, IClone, Serializable

public class GPRasterGDBEnvCompressionType
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPRasterGDBEnvCompressionType, IGPDataType, IClone

GeoProcessor Spatial GDB Environment Compression Type object.

Product Availability

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

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

GPRasterGDBEnvCompressionType()
Constructs a GPRasterGDBEnvCompressionType using ArcGIS Engine.

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

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
IGPValue	createValue(String text) Creates a geoprocessing value object from the given string.
boolean	equals(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
static String	getClsid() getClsid.
IUID	getControlCLSID() The COM class id of the data type.
String	getDisplayName() The descriptive, user-friendly name.
IName	getFullName() The associated Name object.
int	getHelpContext() The context identifier of the topic within the help file.
String	getHelpFile() The name of the (CHM) file containing help information.
String	getMetadataFile() The name of the (XML) file containing the default metadata for this data type.
String	getName() The name of the data type.
int	hashCode() the hashcode for this object
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
IGPMessage	validateDataType(IGPDataType type) Validates if a given geoprocessing data type object is valid.
IGPMessage	validateValue(IGPValue value, IGPDomain domain) Validates if a given geoprocessing value object is the correct data type.

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

GPRasterGDBEnvCompressionType

public GPRasterGDBEnvCompressionType()
                              throws IOException,
                                     UnknownHostException

Constructs a GPRasterGDBEnvCompressionType using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GPRasterGDBEnvCompressionType

public GPRasterGDBEnvCompressionType(Object obj)
                              throws IOException

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

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

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

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the data type.

Remarks

The Name property returns the unique name assigned to the DataType object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IGPDataType

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayName

public String getDisplayName()
                      throws IOException,
                             AutomationException

The descriptive, user-friendly name.

Remarks

The DisplayName property returns the descriptive, user-friendly name of the DataType object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDisplayName in interface IGPDataType

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getControlCLSID

public IUID getControlCLSID()
                     throws IOException,
                            AutomationException

The COM class id of the data type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getControlCLSID in interface IGPDataType

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFullName

public IName getFullName()
                  throws IOException,
                         AutomationException

The associated Name object.

Remarks

The FullName property returns the full name of the DataType object, which is an IName object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFullName in interface IGPDataType

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IGPDataType.getFullName()

getHelpFile

public String getHelpFile()
                   throws IOException,
                          AutomationException

The name of the (CHM) file containing help information.

Remarks

The HelpFile property returns the string of the help file, which contains the help for the DataType.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getHelpFile in interface IGPDataType

Returns:

The file

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHelpContext

public int getHelpContext()
                   throws IOException,
                          AutomationException

The context identifier of the topic within the help file.

Remarks

The HelpContext property returns the context identifier to the topic inside the HelpFile for this DataType.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getHelpContext in interface IGPDataType

Returns:

The context

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMetadataFile

public String getMetadataFile()
                       throws IOException,
                              AutomationException

The name of the (XML) file containing the default metadata for this data type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMetadataFile in interface IGPDataType

Returns:

The file

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createValue

public IGPValue createValue(String text)
                     throws IOException,
                            AutomationException

Creates a geoprocessing value object from the given string.

Remarks

The CreateValue method creates the default Value object, which can subsequently be used in the parameter array that is passed to the Validate and the Execute methods of IGPFunction.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

createValue in interface IGPDataType

Parameters:

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

validateDataType

public IGPMessage validateDataType(IGPDataType type)
                            throws IOException,
                                   AutomationException

Validates if a given geoprocessing data type object is valid.

Remarks

The ValidateDataType method determines if a given DataType object is compatible. The method is used by ModelBuilder to evaluate if a variable can be associated with this DataType.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

validateDataType in interface IGPDataType

Parameters:

type - A reference to a com.esri.arcgis.geodatabase.IGPDataType (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

validateValue

public IGPMessage validateValue(IGPValue value,
                                IGPDomain domain)
                         throws IOException,
                                AutomationException

Validates if a given geoprocessing value object is the correct data type.

Remarks

The ValidateValue method is used to determine if a Value object is compatible with a DataType.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

validateValue in interface IGPDataType

Parameters:

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

domain - A reference to a com.esri.arcgis.geodatabase.IGPDomain (in)

Returns:

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

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.