com.esri.arcgis.geodatabase
Class RasterValue

java.lang.Object
  com.esri.arcgis.geodatabase.RasterValue

All Implemented Interfaces:

IRasterValue, IRasterValue2, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, Externalizable, Serializable

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

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
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
IEnvelope	getExtent() The extent of the raster value.
IGeodataXform	getPersistXform() The geodata transformation to be persisted.
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.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
void	isDirty() isDirty
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	setEmptyRasterDataset(int nBands, int pixelType) Sets up the empty raster dataset.
void	setExtentByRef(IEnvelope extent) The extent of the raster value.
void	setPersistXformByRef(IGeodataXform xform) The geodata transformation to be persisted.
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.
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

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.

setExtentByRef

public void setExtentByRef(IEnvelope extent)
                    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:

setExtentByRef in interface IRasterValue

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.

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.

getPersistXform

public IGeodataXform getPersistXform()
                              throws IOException,
                                     AutomationException

The geodata transformation to be persisted.

Product Availability

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

Specified by:

getPersistXform in interface IRasterValue2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPersistXformByRef

public void setPersistXformByRef(IGeodataXform xform)
                          throws IOException,
                                 AutomationException

The geodata transformation to be persisted.

Description

Set the geodata transformation information to the rastervalue, the raster will be stored in native coordinate system, and the geodata transformation is stored separately, when the raster is accessed, rasters in both native coordinate system and transformed system can be accessed.

Product Availability

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

Specified by:

setPersistXformByRef in interface IRasterValue2

Parameters:

xform - A reference to a com.esri.arcgis.geodatabase.IGeodataXform (in)

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.

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