com.esri.arcgis.geoanalyst
Class RasterDescriptor

java.lang.Object
  com.esri.arcgis.geoanalyst.RasterDescriptor

All Implemented Interfaces:

IGeoDataDescriptor, IRasterDescriptor, IGeoDataset, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, Serializable

public class RasterDescriptor
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGeoDataset, IRasterDescriptor, ISupportErrorInfo

GeoAnalyst Raster descriptor object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

RasterDescriptor()
Constructs a RasterDescriptor using ArcGIS Engine.

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

Method Summary

void	create(IRaster raster, IQueryFilter filter, String fieldName) Create a Raster descriptor.
void	createFromSelectionSet(ISelectionSet selectionSet, IQueryFilter filter, String fieldName) Creates a GeoDataset descriptor with a SelectionSet.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
IEnvelope	getExtent() The extent of the GeoDataset.
IField	getField() The field of the GeoDataset descriptor.
String	getFieldName() The field name of the GeoDataset descriptor.
IQueryFilter	getQueryFilter() The query filter of the GeoDataset descriptor.
IRaster	getRaster() The Raster in the descriptor.
ISelectionSet	getSelectionSet() The SelectionSet of the GeoDataset descriptor.
ISpatialReference	getSpatialReference() The spatial reference of the GeoDataset.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo

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

RasterDescriptor

public RasterDescriptor()
                 throws IOException,
                        UnknownHostException

Constructs a RasterDescriptor using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

RasterDescriptor

public RasterDescriptor(Object obj)
                 throws IOException

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

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

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

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws IOException,
                                             AutomationException

The spatial reference of the GeoDataset.

Remarks

This property is read only. For layers, when the first layer is added to ArcMap, its spatial reference is read by this property, and the map is set to this spatial reference.

Instances of the esriCarto.GroupLayer class will return null for this property, as a group layer can contain multiple datasets with different spatial references.

Modifications to a spatial reference returned by this property will not be persisted. To modify the spatial reference of a dataset, the IGeoDatasetSchemaEdit and IGeoDatasetSchemaEdit2 interfaces should be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSpatialReference in interface IGeoDataset

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

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 GeoDataset.

Remarks

The IGeoDataset::Extent property returns an envelope representing the maximum extent of data which has been stored in the dataset.

Consider the following scenario. A new feature class has features added to it. The IGeoDataset::Extent is then requested and an envelope is returned. The extents of the envelope returned are represented by the red box in the image below.

If a portion of the features were then deleted and the extent is again requested an envelope with the exact same extents as during the first request would be returned (see image below). This is because the deletion of features does not shrink the extent. However all additions of features outside the red box would increase the envelope returned to encompass the newly added features.

If you would like to update the IGeoDataset::Extent property to reflect the current features in your dataset please see IFeatureClassManage::UpdateExtent (also see IFeatureClassLoad). In the image below the extent has been updated and a new envelope is being returned.

ESRI's GroupLayer implements this property differently from most other layer coclasses. When you instantiate a new GroupLayer, this property will return a valid envelope with zero height and width. With most other newly instantiated layers (for example FeatureLayer, RasterLayer, TinLayer), this property initally returns Nothing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExtent in interface IGeoDataset

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.

create

public void create(IRaster raster,
                   IQueryFilter filter,
                   String fieldName)
            throws IOException,
                   AutomationException

Create a Raster descriptor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

create in interface IRasterDescriptor

Parameters:

raster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

filter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

fieldName - The fieldName (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 in the descriptor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getRaster in interface IRasterDescriptor

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.

createFromSelectionSet

public void createFromSelectionSet(ISelectionSet selectionSet,
                                   IQueryFilter filter,
                                   String fieldName)
                            throws IOException,
                                   AutomationException

Creates a GeoDataset descriptor with a SelectionSet.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

createFromSelectionSet in interface IGeoDataDescriptor

Parameters:

selectionSet - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)

filter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

fieldName - The fieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getQueryFilter

public IQueryFilter getQueryFilter()
                            throws IOException,
                                   AutomationException

The query filter of the GeoDataset descriptor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getQueryFilter in interface IGeoDataDescriptor

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectionSet

public ISelectionSet getSelectionSet()
                              throws IOException,
                                     AutomationException

The SelectionSet of the GeoDataset descriptor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSelectionSet in interface IGeoDataDescriptor

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getField

public IField getField()
                throws IOException,
                       AutomationException

The field of the GeoDataset descriptor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getField in interface IGeoDataDescriptor

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldName

public String getFieldName()
                    throws IOException,
                           AutomationException

The field name of the GeoDataset descriptor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFieldName in interface IGeoDataDescriptor

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.