com.esri.arcgis.geodatabase
Class RasterValue

java.lang.Object
  extended by com.esri.arcgis.geodatabase.RasterValue
All Implemented Interfaces:
IRasterValue, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class RasterValue
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterValue

The Raster Value Class.

Description

The RasterValue represents the value of a Raster field, similar to the value of a Geometry field. A RasterValue consists a RasterDataset and its storage properties specified by RasterStorageDef, including tile size, pyramid definition, compression, cellsize and origin. A RasterVaue in an ArcSDE geodatabase consists of a database RasterDataset, while a RasterValue in a personal geodatabase consists a file based RasterDataset.

The RasterValue object is used to set or update a Raster field with a given Raser, RasterDataset or RasterDatasetName. It works the same way for Personal, File and ArcSDE geodatabases, except for a RasterValue stored in a Personal geodatabase since most of the storage properties (tilesize, compression options and pyramids options) are ignored.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
IRasterCatalogItem, RasterCatalog, RasterStorageDef, Serialized Form

Constructor Summary
RasterValue()
          Constructs a RasterValue using ArcGIS Engine.
RasterValue(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterValue theRasterValue = (RasterValue) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 IEnvelope getExtent()
          The extent of the raster value.
 IRaster getRaster()
          The raster of the raster value.
 IRasterDataset getRasterDataset()
          The raster dataset of the raster value.
 IName getRasterDatasetName()
          The raster dataset name of the raster value.
 IRasterStorageDef getRasterStorageDef()
          The raster storage properties.
 int hashCode()
          the hashcode for this object
 void setEmptyRasterDataset(int nBands, int pixelType)
          Sets up the empty raster dataset.
 void setRasterByRef(IRaster raster)
          The raster of the raster value.
 void setRasterDatasetByRef(IRasterDataset dataset)
          The raster dataset of the raster value.
 void setRasterDatasetNameByRef(IName datasetName)
          The raster dataset name of the raster value.
 void setRasterStorageDefByRef(IRasterStorageDef storageDef)
          The raster storage properties.
 
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

RasterValue

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

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

RasterValue

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

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

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

getRasterStorageDef

public IRasterStorageDef getRasterStorageDef()
                                      throws IOException,
                                             AutomationException
The raster storage properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getRasterStorageDef in interface IRasterValue
Returns:
A reference to a com.esri.arcgis.geodatabase.IRasterStorageDef
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRasterStorageDefByRef

public void setRasterStorageDefByRef(IRasterStorageDef storageDef)
                              throws IOException,
                                     AutomationException
The raster storage properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setRasterStorageDefByRef in interface IRasterValue
Parameters:
storageDef - A reference to a com.esri.arcgis.geodatabase.IRasterStorageDef (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 of the raster value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getExtent in interface IRasterValue
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.

getRasterDataset

public IRasterDataset getRasterDataset()
                                throws IOException,
                                       AutomationException
The raster dataset of the raster value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getRasterDataset in interface IRasterValue
Returns:
A reference to a com.esri.arcgis.geodatabase.IRasterDataset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRasterDatasetByRef

public void setRasterDatasetByRef(IRasterDataset dataset)
                           throws IOException,
                                  AutomationException
The raster dataset of the raster value.

Remarks

Assigns a RasterDataset to the RasterValue, if the raster has a different spatial reference from the raster column of the raster catalog, the raster spatial reference is ignored and the raster column spatial reference is applied to the raster, but no projection or transformation is performed. To set the raster dataset spatial reference correctly, you need to get the raster datasets and alter its xform.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setRasterDatasetByRef in interface IRasterValue
Parameters:
dataset - A reference to a com.esri.arcgis.geodatabase.IRasterDataset (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRasterDatasetName

public IName getRasterDatasetName()
                           throws IOException,
                                  AutomationException
The raster dataset name of the raster value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getRasterDatasetName in interface IRasterValue
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.

setRasterDatasetNameByRef

public void setRasterDatasetNameByRef(IName datasetName)
                               throws IOException,
                                      AutomationException
The raster dataset name of the raster value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getRaster

public IRaster getRaster()
                  throws IOException,
                         AutomationException
The raster of the raster value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getRaster in interface IRasterValue
Returns:
A reference to a com.esri.arcgis.geodatabase.IRaster
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRasterByRef

public void setRasterByRef(IRaster raster)
                    throws IOException,
                           AutomationException
The raster of the raster value.

Remarks

Assigns a Raster to the RasterValue, if the raster has a different spatial reference from the raster column of the raster catalog, the raster spatial reference is ignored and the raster column spatial reference is applied to the raster, but no projection or transformation is performed. To set the raster spatial reference correctly, you need to get the raster and alter its xform.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setRasterByRef in interface IRasterValue
Parameters:
raster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEmptyRasterDataset

public void setEmptyRasterDataset(int nBands,
                                  int pixelType)
                           throws IOException,
                                  AutomationException
Sets up the empty raster dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setEmptyRasterDataset in interface IRasterValue
Parameters:
nBands - The nBands (in)
pixelType - A com.esri.arcgis.geodatabase.rstPixelType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.