com.esri.arcgis.geoprocessing
Class GPRasterSchema

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.GPRasterSchema
All Implemented Interfaces:
IGPRasterSchema, IGPSchema, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class GPRasterSchema
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPSchema, IGPRasterSchema, IClone, IPersistStream, IXMLSerialize, Externalizable

Geoprocessing Raster Schema object.

Description

This object is new at ArcGIS 9.3.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
GPRasterSchema()
          Constructs a GPRasterSchema using ArcGIS Engine.
GPRasterSchema(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPRasterSchema theGPRasterSchema = (GPRasterSchema) obj;
 
Method Summary
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 boolean equals(Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 double getCellSize()
          The cellSize property.
 int getCellSizeRule()
          Inidicates how the cellSize property is to be managed.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 IEnvelope getExtent()
          The extent property.
 int getExtentRule()
          Inidicates how the extent property is to be managed.
 int getRasterFormatRule()
          Inidicates how the raster format property is to be managed.
 int getRasterRule()
          Inidicates how the raster is integer property is to be managed.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int hashCode()
          the hashcode for this object
 boolean isCloneDependency()
          Inidicates if the output value is to be cloned from the input.
 void isDirty()
          isDirty
 boolean isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 boolean isGenerateOutputCatalogPath()
          Inidicates if the output catalog path is to be generated from the input.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 void load(IStream pstm)
          load
 void populateOutputValue(String baseName, IGPParameter3 param, IArray params, IGPEnvironmentManager envMgr)
          Populate the value of the output parameter for validate.
 void readExternal(ObjectInput in)
           
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 void setCellSize(double cellSize)
          The cellSize property.
 void setCellSizeRule(int type)
          Inidicates how the cellSize property is to be managed.
 void setCloneDependency(boolean cloneDependency)
          Inidicates if the output value is to be cloned from the input.
 void setExtentByRef(IEnvelope extent)
          The extent property.
 void setExtentRule(int type)
          Inidicates how the extent property is to be managed.
 void setGenerateOutputCatalogPath(boolean generatePath)
          Inidicates if the output catalog path is to be generated from the input.
 void setRasterFormatRule(int type)
          Inidicates how the raster format property is to be managed.
 void setRasterRule(int type)
          Inidicates how the raster is integer property is to be managed.
 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

GPRasterSchema

public GPRasterSchema()
               throws IOException,
                      UnknownHostException
Constructs a GPRasterSchema using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

GPRasterSchema

public GPRasterSchema(Object obj)
               throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPRasterSchema theGPRasterSchema = (GPRasterSchema) obj;

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

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

isCloneDependency

public boolean isCloneDependency()
                          throws IOException,
                                 AutomationException
Inidicates if the output value is to be cloned from the input.

Product Availability

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

Specified by:
isCloneDependency in interface IGPSchema
Returns:
The cloneDependency
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCloneDependency

public void setCloneDependency(boolean cloneDependency)
                        throws IOException,
                               AutomationException
Inidicates if the output value is to be cloned from the input.

Product Availability

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

Specified by:
setCloneDependency in interface IGPSchema
Parameters:
cloneDependency - The cloneDependency (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isGenerateOutputCatalogPath

public boolean isGenerateOutputCatalogPath()
                                    throws IOException,
                                           AutomationException
Inidicates if the output catalog path is to be generated from the input.

Product Availability

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

Specified by:
isGenerateOutputCatalogPath in interface IGPSchema
Returns:
The generatePath
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGenerateOutputCatalogPath

public void setGenerateOutputCatalogPath(boolean generatePath)
                                  throws IOException,
                                         AutomationException
Inidicates if the output catalog path is to be generated from the input.

Product Availability

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

Specified by:
setGenerateOutputCatalogPath in interface IGPSchema
Parameters:
generatePath - The generatePath (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

populateOutputValue

public void populateOutputValue(String baseName,
                                IGPParameter3 param,
                                IArray params,
                                IGPEnvironmentManager envMgr)
                         throws IOException,
                                AutomationException
Populate the value of the output parameter for validate.

Product Availability

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

Specified by:
populateOutputValue in interface IGPSchema
Parameters:
baseName - The baseName (in)
param - A reference to a com.esri.arcgis.geoprocessing.IGPParameter3 (in)
params - A reference to a com.esri.arcgis.system.IArray (in)
envMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtentRule

public int getExtentRule()
                  throws IOException,
                         AutomationException
Inidicates how the extent property is to be managed.

Product Availability

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

Specified by:
getExtentRule in interface IGPRasterSchema
Returns:
A com.esri.arcgis.geoprocessing.esriGPSchemaExtentType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExtentRule

public void setExtentRule(int type)
                   throws IOException,
                          AutomationException
Inidicates how the extent property is to be managed.

Product Availability

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

Specified by:
setExtentRule in interface IGPRasterSchema
Parameters:
type - A com.esri.arcgis.geoprocessing.esriGPSchemaExtentType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws IOException,
                           AutomationException
The extent property.

Product Availability

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

Specified by:
getExtent in interface IGPRasterSchema
Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExtentByRef

public void setExtentByRef(IEnvelope extent)
                    throws IOException,
                           AutomationException
The extent property.

Product Availability

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

Specified by:
setExtentByRef in interface IGPRasterSchema
Parameters:
extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCellSizeRule

public int getCellSizeRule()
                    throws IOException,
                           AutomationException
Inidicates how the cellSize property is to be managed.

Product Availability

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

Specified by:
getCellSizeRule in interface IGPRasterSchema
Returns:
A com.esri.arcgis.geoprocessing.esriGPSchemaCellSizeType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCellSizeRule

public void setCellSizeRule(int type)
                     throws IOException,
                            AutomationException
Inidicates how the cellSize property is to be managed.

Product Availability

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

Specified by:
setCellSizeRule in interface IGPRasterSchema
Parameters:
type - A com.esri.arcgis.geoprocessing.esriGPSchemaCellSizeType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCellSize

public double getCellSize()
                   throws IOException,
                          AutomationException
The cellSize property.

Product Availability

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

Specified by:
getCellSize in interface IGPRasterSchema
Returns:
The cellSize
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCellSize

public void setCellSize(double cellSize)
                 throws IOException,
                        AutomationException
The cellSize property.

Product Availability

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

Specified by:
setCellSize in interface IGPRasterSchema
Parameters:
cellSize - The cellSize (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRasterRule

public int getRasterRule()
                  throws IOException,
                         AutomationException
Inidicates how the raster is integer property is to be managed.

Product Availability

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

Specified by:
getRasterRule in interface IGPRasterSchema
Returns:
A com.esri.arcgis.geoprocessing.esriGPSchemaRasterType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRasterRule

public void setRasterRule(int type)
                   throws IOException,
                          AutomationException
Inidicates how the raster is integer property is to be managed.

Product Availability

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

Specified by:
setRasterRule in interface IGPRasterSchema
Parameters:
type - A com.esri.arcgis.geoprocessing.esriGPSchemaRasterType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRasterFormatRule

public int getRasterFormatRule()
                        throws IOException,
                               AutomationException
Inidicates how the raster format property is to be managed.

Product Availability

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

Specified by:
getRasterFormatRule in interface IGPRasterSchema
Returns:
A com.esri.arcgis.geoprocessing.esriGPSchemaRasterFormatType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRasterFormatRule

public void setRasterFormatRule(int type)
                         throws IOException,
                                AutomationException
Inidicates how the raster format property is to be managed.

Product Availability

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

Specified by:
setRasterFormatRule in interface IGPRasterSchema
Parameters:
type - A com.esri.arcgis.geoprocessing.esriGPSchemaRasterFormatType constant (in)
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
Returns TRUE when 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
Returns TRUE when 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.

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.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException
Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
serialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException
Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
deserialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (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