com.esri.arcgis.datasourcesraster
Class RasterDataset

java.lang.Object
  extended by com.esri.arcgis.datasourcesraster.RasterDataset
All Implemented Interfaces:
IRasterBandCollection, IRasterPyramid, ITemporaryDataset, IWorldFileExport, IDataset, IDatasetAnalyze, IDatasetFileStat, IGeoDataset, IGeoDatasetSchemaEdit, IMetadata, IMetadataEdit, INativeTypeInfo, IRasterDataset, IRasterDataset2, IRasterDataset3, IRasterDatasetEdit, IRasterDatasetEdit2, ISaveAs, ISaveAs2, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, Serializable

public class RasterDataset
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterDataset, IRasterDataset2, IRasterDataset3, IRasterDatasetEdit, IRasterDatasetEdit2, IDataset, IGeoDataset, IGeoDatasetSchemaEdit, IRasterBandCollection, IRasterPyramid, IMetadata, IMetadataEdit, INativeTypeInfo, ITemporaryDataset, IDatasetAnalyze, IDatasetFileStat, ISupportErrorInfo, IWorldFileExport, ISaveAs, ISaveAs2

A representation of a raster dataset on disk.

Description

The RasterDataset object represents a dataset on disk or in a geodatabase. It is composed of one or more persistent raster bands.

The RasterDataset object performs basic dataset management functions, such as copy, rename, and delete. It can also be used to examine dataset properties including raster format, extent, spatial reference, and number of bands, etc.

RasterDataset can be used to change some of the properties of the dataset. For example, RasterDataset can be used to change the spatial reference associated with the dataset, to manipulate the colormap of the raster dataset, to build pyramids (reduced-resolution datasets) which improve display performance for large raster datasets, and to build statistics which enhances raster renderering. RasterDataset object can merge pixels from another raster dataset to itself.

A RasterDataset can be saved to anther file format or geodatabase using ISaveAs or IRasterBandCollection.

The IRasterWorkspace interface and IRasterWorkspaceEx interface, through an Access workspace, create a file based RasterDataset; IRasterWorkspaceEx interface, through a database workspace, creates a database RasterDataset.

A file based RasterDataset and database RasterDataset work the same way except on a few interfaces. For example, ITemporyDataset and IWorldFileExport interfaces are not supported by a database RasterDataset.

Remarks

The RasterDataset object represents a dataset on disk or in a database. It is composed of one or more persistent raster bands. The dataset provides access only to operations that apply to the entire dataset, with the RasterBand providing access to operations that occur on individual bands.

The RasterDataset object performs basic dataset management functions, such as copy, rename, and delete. It can also instantiat RasterBand and Raster objects representing other aspects of the data. It can be used to examine dataset properties including different format, extent, spatial reference, and number of bands.

The spatial reference of the raster raster dataset can be changed through interface IGeoDatasetSchemaEdit, but it does not project the dataset, only changes the coordinate system associated with the dataset.
The pyramid of the raster dataset can be built or rebuilt to improve display performance for large raster datasets.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
RasterDataset()
          Constructs a RasterDataset using ArcGIS Engine.
RasterDataset(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterDataset theRasterDataset = (RasterDataset) obj;
 
Method Summary
 void add(IRasterBand element, int index)
          Adds a RasterBand to the band collection.
 void alterAttributeTable(ITable newTable)
          Alters the raster attribute table.
 void alterColormap(IRasterColormap colormap)
          Alters colormap.
 void alterSpatialReference(ISpatialReference spatialReference)
          Alters the spatial reference of the dataset to match the coordinate system of the input spatial reference, does not reproject the data.
 void analyze(int tableComponents)
          Analyze the data to update/generate DBMS statistics.
 void appendBand(IRasterBand element)
          Appends a RasterBand to the band collection.
 void appendBands(IRasterBandCollection bands)
          Appends a collection of RasterBands to the band collection.
 void appendNewBand()
          Appends a new raster band.
 void buildAttributeTable()
          Builds the raster attribute table.
 boolean canCopy()
          Returns true if this dataset can be copied.
 boolean canDelete()
          True if this dataset can be deleted.
 boolean canRename()
          True if this dataset can be renamed.
 boolean canSaveAs(String format)
          Checks if it's can be saved as a new persistent Dataset of a given format.
 void clear()
          Removes all the elements in the collection.
 void computeStats(int pyramidLevel)
          Calculates statistics and histograms from a given pyramid level.
 IDataset copy(String copyName, IWorkspace copyWorkspace)
          Copies this dataset to a new dataset with the specified name.
 void create()
          Build raster pyramids for this raster.
 IRaster createDefaultRaster()
          Creates a raster object with the default properties for this dataset.
 IRaster createFullRaster()
          Creates a raster containing all bands in this raster dataset.
 IRaster createRaster()
          Creates an empty raster.
 void delete()
          Deletes this dataset.
 void deleteAttributeTable()
          Deletes the raster attribute table.
 void deleteColormap()
          Deletes colormap.
 void deleteStats()
          Deletes statistics and histograms.
 boolean equals(Object o)
          Compare this object with another
 void erase(IEnvelope extent)
          Erases a rectanglar area of this RasterDataset.
 int getAllowableComponents()
          The allowable components to be analyzed.
 IRasterBand getBandByName(String name)
          A RasterBand given its name.
 int getBandIndex(String name)
          The index of a RasterBand given its name.
 IEnumRasterBand getBands()
          All the bands in the collection as an interface to the RasterBands enumerator object.
 int getBlockHeight()
          The native block height.
 int getBlockWidth()
          The native block width.
 String getBrowseName()
          The browse name of the dataset.
 String getCategory()
          The category of the dataset.
static String getClsid()
          getClsid.
 String getCompleteName()
          The full path of the RasterDataset.
 String getCompressionType()
          The compression technique applied to this RasterDataset.
 int getCount()
          The number of bands in the collection.
 IEnvelope getExtent()
          The extent of the GeoDataset.
 int getFirstPyramidLevel()
          The first available pyramid level.
 String getFormat()
          The format of this RasterRataset.
 IName getFullName()
          The associated name object.
 IRasterLODInfos getLODInfos()
          The custom LOD infos.
 int getMaximumPyramidLevel()
          The maximum available pyramid level.
 IPropertySet getMetadata()
          The PropertySet containing metadata.
 IPnt getMinimumSize()
          The minimum raster pyramid size.
 String getName()
          The name of the Dataset.
 INativeType getNativeType()
          The native type.
 IPropertySet getPropertySet()
          The set of properties for the dataset.
 String getSensorType()
          The sensor type used for this RasterDataset.
 ISpatialReference getSpatialReference()
          The spatial reference of the GeoDataset.
 int getStatMode()
          The access mode.
 int getStatSize()
          The size.
 int getStatTime(int dateMode)
          The date modified/created/accessed.
 IEnumDataset getSubsets()
          Datasets contained within this dataset.
 int getType()
          The type of the Dataset.
 IWorkspace getWorkspace()
          The workspace containing this dataset.
 int hashCode()
          the hashcode for this object
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 boolean isCanAlterAttributeTable()
          Indicates if the raster attribute table can be altered.
 boolean isCanAlterSpatialReference()
          Indicates if the spatial reference of the dataset can be altered.
 boolean isCanEditMetadata()
          Indicates if metadata can be edited.
 boolean isCanWrite()
          Indicates if this RasterDataset is writable.
 boolean isEmpty()
          Indicates whether the raster dataset is empty.
 boolean isPresent()
          Indicates whether pyramid layers exist.
 boolean isTemporary()
          Indicates if the dataset is temporary.
 IRasterBand item(int bandIndex)
          Returns a RasterBand given its index.
 void makePermanent()
          Persists this temporary dataset permanent.
 IDataset makePermanentAs(String new_name, IWorkspace workspace, String format)
          Persists this temporary dataset to a new permanent dataset.
 void mosaic(IRaster raster, double tolerance)
          Mosaics a Raster into this RasterDataset.
 void mosaicBands(IRaster raster, int start, double tolerance)
          Mosaics a Raster into this RasterDataset at a given starting band index.
 void precalculateStats(Object index_list)
          Calculates statistics and histograms for specified bands.
 void read(IPnt tlc, IRaster raster, IPixelBlock pixelBlock)
          Reads a block of pixels starting from the top left corner.
 void readPyramid(IPnt tlc, int pyramidLevel, IRaster raster, IPixelBlock pixelBlock)
          Reads a block of pixels at a given pyramid level.
 void refresh()
          Refreshes opened RasterDataset.
 void remove(int index)
          Removes an element from the collection.
 void rename(String name)
          Renames this Dataset.
 IDataset saveAs(String new_name, IWorkspace worksp, String format)
          Creates a new persistent RasterDataset with the bands in the collection.
 IRasterDataset saveAsRasterDataset(String name, IWorkspace workspace, String format, IRasterStorageDef storageDef)
          Creates a new persistent Raster Dataset of a given format and specified storage definition.
 void setBrowseName(String name)
          The browse name of the dataset.
 void setMetadata(IPropertySet ppPropertySet)
          The PropertySet containing metadata.
 void setMinimumSize(IPnt ppVal)
          The minimum raster pyramid size.
 void synchronize(int action, int interval)
          Updates metadata with the current properties; may create metadata if it doesn't already exist.
 void write()
          Creates a World File.
 void write(IPnt tlc, IRaster raster, int mode, IPixelBlock pixelBlock)
          Writes a block of pixels starting from the top left corner.
 
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

RasterDataset

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

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

RasterDataset

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

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

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

getFormat

public String getFormat()
                 throws IOException,
                        AutomationException
The format of this RasterRataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFormat in interface IRasterDataset
Returns:
The format
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSensorType

public String getSensorType()
                     throws IOException,
                            AutomationException
The sensor type used for this RasterDataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSensorType in interface IRasterDataset
Returns:
The sensorType
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCompressionType

public String getCompressionType()
                          throws IOException,
                                 AutomationException
The compression technique applied to this RasterDataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCompressionType in interface IRasterDataset
Returns:
The comp
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createDefaultRaster

public IRaster createDefaultRaster()
                            throws IOException,
                                   AutomationException
Creates a raster object with the default properties for this dataset.

Remarks

The CreateDefaultRaster method creates a Raster that has a square cell size and contains only three raster bands if the dataset has more than three bands. The three bands are the default bands used in raster RGB renderer and are determined by the settings for default raster behavior made on the RasterDefaultsEnv object in esriCarto library.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
createDefaultRaster in interface IRasterDataset
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.

canCopy

public boolean canCopy()
                throws IOException,
                       AutomationException
Returns true if this dataset can be copied.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
canCopy in interface IDataset
Specified by:
canCopy in interface IRasterDataset
Returns:
The canCopy
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

copy

public IDataset copy(String copyName,
                     IWorkspace copyWorkspace)
              throws IOException,
                     AutomationException
Copies this dataset to a new dataset with the specified name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
copy in interface IDataset
Specified by:
copy in interface IRasterDataset
Parameters:
copyName - The copyName (in)
copyWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IDataset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

precalculateStats

public void precalculateStats(Object index_list)
                       throws IOException,
                              AutomationException
Calculates statistics and histograms for specified bands.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
precalculateStats in interface IRasterDataset
Parameters:
index_list - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCompleteName

public String getCompleteName()
                       throws IOException,
                              AutomationException
The full path of the RasterDataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCompleteName in interface IRasterDataset
Returns:
The completeName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createRaster

public IRaster createRaster()
                     throws IOException,
                            AutomationException
Creates an empty raster.

Remarks

An empty raster means that properties of the Raster are not defined. The width, height, and the number of bands of the raster are all 0. It can not be used before populating pixels to it.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
createRaster in interface IRasterDataset2
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.

createFullRaster

public IRaster createFullRaster()
                         throws IOException,
                                AutomationException
Creates a raster containing all bands in this raster dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
createFullRaster in interface IRasterDataset2
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.

isEmpty

public boolean isEmpty()
                throws IOException,
                       AutomationException
Indicates whether the raster dataset is empty.

Remarks

An empty raster means that properties of the Raster are not defined. The width, height, and the number of bands of the raster are all 0. It can not be used before populating pixels to it.

Co-create a Raster and IRasterDataset2::CreateRaster create an empty raster.

IRasterBandCollection::AppendBands or AppendBand allows you to populate this raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getBlockWidth

public int getBlockWidth()
                  throws IOException,
                         AutomationException
The native block width.

Product Availability

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

Specified by:
getBlockWidth in interface IRasterDataset3
Returns:
The width
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBlockHeight

public int getBlockHeight()
                   throws IOException,
                          AutomationException
The native block height.

Product Availability

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

Specified by:
getBlockHeight in interface IRasterDataset3
Returns:
The height
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaximumPyramidLevel

public int getMaximumPyramidLevel()
                           throws IOException,
                                  AutomationException
The maximum available pyramid level.

Product Availability

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

Specified by:
getMaximumPyramidLevel in interface IRasterDataset3
Returns:
The maxLevel
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFirstPyramidLevel

public int getFirstPyramidLevel()
                         throws IOException,
                                AutomationException
The first available pyramid level.

Product Availability

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

Specified by:
getFirstPyramidLevel in interface IRasterDataset3
Returns:
The firstLevel
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLODInfos

public IRasterLODInfos getLODInfos()
                            throws IOException,
                                   AutomationException
The custom LOD infos.

Product Availability

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

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

isCanWrite

public boolean isCanWrite()
                   throws IOException,
                          AutomationException
Indicates if this RasterDataset is writable.

Product Availability

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

Specified by:
isCanWrite in interface IRasterDataset3
Returns:
The canWrite
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

read

public void read(IPnt tlc,
                 IRaster raster,
                 IPixelBlock pixelBlock)
          throws IOException,
                 AutomationException
Reads a block of pixels starting from the top left corner.

Product Availability

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

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

write

public void write(IPnt tlc,
                  IRaster raster,
                  int mode,
                  IPixelBlock pixelBlock)
           throws IOException,
                  AutomationException
Writes a block of pixels starting from the top left corner.

Product Availability

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

Specified by:
write in interface IRasterDataset3
Parameters:
tlc - A reference to a com.esri.arcgis.geodatabase.IPnt (in)
raster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)
mode - A com.esri.arcgis.geodatabase.esriRasterWriteMode constant (in)
pixelBlock - A reference to a com.esri.arcgis.geodatabase.IPixelBlock (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

refresh

public void refresh()
             throws IOException,
                    AutomationException
Refreshes opened RasterDataset.

Product Availability

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

Specified by:
refresh in interface IRasterDataset3
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

readPyramid

public void readPyramid(IPnt tlc,
                        int pyramidLevel,
                        IRaster raster,
                        IPixelBlock pixelBlock)
                 throws IOException,
                        AutomationException
Reads a block of pixels at a given pyramid level.

Product Availability

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

Specified by:
readPyramid in interface IRasterDataset3
Parameters:
tlc - A reference to a com.esri.arcgis.geodatabase.IPnt (in)
pyramidLevel - The pyramidLevel (in)
raster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)
pixelBlock - A reference to a com.esri.arcgis.geodatabase.IPixelBlock (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

mosaic

public void mosaic(IRaster raster,
                   double tolerance)
            throws IOException,
                   AutomationException
Mosaics a Raster into this RasterDataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

mosaicBands

public void mosaicBands(IRaster raster,
                        int start,
                        double tolerance)
                 throws IOException,
                        AutomationException
Mosaics a Raster into this RasterDataset at a given starting band index.

Remarks

This method is supported by RasterDataset instances created from geodatabase and TIFF, Imagine and GRID raster formats.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

erase

public void erase(IEnvelope extent)
           throws IOException,
                  AutomationException
Erases a rectanglar area of this RasterDataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
erase in interface IRasterDatasetEdit
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.

computeStats

public void computeStats(int pyramidLevel)
                  throws IOException,
                         AutomationException
Calculates statistics and histograms from a given pyramid level.

Remarks

This method is avaliable only on raster datasets in File and ArcSDE geodatabases.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

deleteStats

public void deleteStats()
                 throws IOException,
                        AutomationException
Deletes statistics and histograms.

Remarks

This method is avaliable only on raster datasets in File and ArcSDE geodatabases.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
deleteStats in interface IRasterDatasetEdit
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

alterColormap

public void alterColormap(IRasterColormap colormap)
                   throws IOException,
                          AutomationException
Alters colormap.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

deleteColormap

public void deleteColormap()
                    throws IOException,
                           AutomationException
Deletes colormap.

Remarks

This method only applies to database Rasterdataset , a raster dataset stored in a File or ArcSDE geodatabase.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
deleteColormap in interface IRasterDatasetEdit
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

appendNewBand

public void appendNewBand()
                   throws IOException,
                          AutomationException
Appends a new raster band.

Remarks

This method is available only on a raster dataset in File and ArcSDE geodatabases.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
appendNewBand in interface IRasterDatasetEdit
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

alterAttributeTable

public void alterAttributeTable(ITable newTable)
                         throws IOException,
                                AutomationException
Alters the raster attribute table.

Product Availability

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

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

deleteAttributeTable

public void deleteAttributeTable()
                          throws IOException,
                                 AutomationException
Deletes the raster attribute table.

Product Availability

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

Specified by:
deleteAttributeTable in interface IRasterDatasetEdit2
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanAlterAttributeTable

public boolean isCanAlterAttributeTable()
                                 throws IOException,
                                        AutomationException
Indicates if the raster attribute table can be altered.

Product Availability

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

Specified by:
isCanAlterAttributeTable in interface IRasterDatasetEdit2
Returns:
The canAlter
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

buildAttributeTable

public void buildAttributeTable()
                         throws IOException,
                                AutomationException
Builds the raster attribute table.

Product Availability

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

Specified by:
buildAttributeTable in interface IRasterDatasetEdit2
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException
The name of the Dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getName in interface IDataset
Returns:
The name
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 a Name object for the dataset. The Name object can be persisted and provides a way to get back to the dataset in a future session of the application, via the Open method on the Name object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFullName in interface IDataset
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.

getBrowseName

public String getBrowseName()
                     throws IOException,
                            AutomationException
The browse name of the dataset.

Remarks

BrowseName returns file names without their extension. For example, States.shp would appear as States.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBrowseName in interface IDataset
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBrowseName

public void setBrowseName(String name)
                   throws IOException,
                          AutomationException
The browse name of the dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getType

public int getType()
            throws IOException,
                   AutomationException
The type of the Dataset.

Remarks

The Type property returns the an esriDatasetType value indicating the dataset type, such as esriDTTable or esriDTFeatureClass.

Example:


// Assume we have a reference to an IfeatureClass (pFeatureClass) IDataset pDataset = null;
pDataset = new IDatasetProxy(pFeatureClass);
System.out.println(pDataset.getName() + " " + pDataset.getType());
if(pFeatureClass != null){
pDataset = pFeatureClass.getFeatureDataset();
System.out.println(pDataset.getName() + " " + pDataset.getType());
}
pDataset = new IDatasetProxy(pDataset.getWorkspace());
System.out.println(pDataset.getName() + " " +
pDataset.getType());

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getType in interface IDataset
Returns:
A com.esri.arcgis.geodatabase.esriDatasetType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCategory

public String getCategory()
                   throws IOException,
                          AutomationException
The category of the dataset.

Remarks

IDataset::Category returns a description of the category of the dataset. The description returned from the Category property is the same value that is displayed in the Type column within the Contents tab in ArcCatalog. The value will contain a description of the dataset such as "Topology" prefixed with a description of the type of workspace containing the dataset such as "File Geodatabase".

The description returned from IDataset::Category may change between releases of ArcGIS. In addition to this, returned strings are localized, meaning that code relying on a specific string being provided may fail when deployed with a different version of ArcGIS than it was developed with, or when deployed to a client using a different language than it was developed with.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCategory in interface IDataset
Returns:
The category
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSubsets

public IEnumDataset getSubsets()
                        throws IOException,
                               AutomationException
Datasets contained within this dataset.

Description

The Subsets property returns other Dataset objects contained in this dataset.

Remarks

IDataset::Subsets is not supported for Graph objects such as a Geometric Network. To return the feature classes contained in a Geometric Network, use the IFeatureClassContainer interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getWorkspace

public IWorkspace getWorkspace()
                        throws IOException,
                               AutomationException
The workspace containing this dataset.

Description

The Workspace property returns the containing workspace for this dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getPropertySet

public IPropertySet getPropertySet()
                            throws IOException,
                                   AutomationException
The set of properties for the dataset.

Description

The PropertySet property is used to return any additional intrinsic properties (but not metadata properties) that may apply to the dataset. One use of this property is to distinguish between the types of File Geodatabase datafile formats. If called on a Feature Class or Table in a File Geodatabase the Datafile Format property can either be esriFGDBStandardDatafile or esriFGDBCompressedDatafile.

Most datasets do not implement this property and will either raise an error or return a null value if it's called. There are a handful of exceptions that will return property sets; these include the datasets from file geodatabases (as mentioned above) and coverages.

Remarks

Examples of intrinsic properties for which explicit methods exist include the SpatialReference and the Extent methods available on the IGeoDataset interface. In most cases this PropertySet will be empty.

IDataset::PropertySet is not supported for Graph objects such as a Geometric Network.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getPropertySet in interface IDataset
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canDelete

public boolean canDelete()
                  throws IOException,
                         AutomationException
True if this dataset can be deleted.

Remarks

The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

delete

public void delete()
            throws IOException,
                   AutomationException
Deletes this dataset.

Remarks

Certain feature classes, such as network and topology feature classes, cannot be deleted until their containing objects are deleted.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
delete in interface IDataset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canRename

public boolean canRename()
                  throws IOException,
                         AutomationException
True if this dataset can be renamed.

Remarks

The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete or rename a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

rename

public void rename(String name)
            throws IOException,
                   AutomationException
Renames this Dataset.

Remarks

IDataset::Rename does not support the renaming of Graph objects such as a Geometric Network. In addition, certain feature classes, such as network feature classes, cannot be renamed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

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.

The red box represents the IGeoDataset extent

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.

The red box represents the IGeoDataset extent after some of the features have been deleted

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.

The red box represents the IGeoDataset extent after it has been updated

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.

isCanAlterSpatialReference

public boolean isCanAlterSpatialReference()
                                   throws IOException,
                                          AutomationException
Indicates if the spatial reference of the dataset can be altered.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isCanAlterSpatialReference in interface IGeoDatasetSchemaEdit
Returns:
The canAlter
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

alterSpatialReference

public void alterSpatialReference(ISpatialReference spatialReference)
                           throws IOException,
                                  AutomationException
Alters the spatial reference of the dataset to match the coordinate system of the input spatial reference, does not reproject the data.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

add

public void add(IRasterBand element,
                int index)
         throws IOException,
                AutomationException
Adds a RasterBand to the band collection.

Remarks

This method is only applicable to work with a Raster, not with a RasterDataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
add in interface IRasterBandCollection
Parameters:
element - A reference to a com.esri.arcgis.datasourcesraster.IRasterBand (in)
index - The index (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws IOException,
                    AutomationException
The number of bands in the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCount in interface IRasterBandCollection
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clear

public void clear()
           throws IOException,
                  AutomationException
Removes all the elements in the collection.

Remarks

This method is only applicable to work with a Raster, not with a RasterDataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
clear in interface IRasterBandCollection
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

remove

public void remove(int index)
            throws IOException,
                   AutomationException
Removes an element from the collection.

Remarks

This method is only applicable to work with a Raster, not with a RasterDataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getBandIndex

public int getBandIndex(String name)
                 throws IOException,
                        AutomationException
The index of a RasterBand given its name.

Product Availability

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

Specified by:
getBandIndex in interface IRasterBandCollection
Parameters:
name - The name (in)
Returns:
The bandIndex
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBandByName

public IRasterBand getBandByName(String name)
                          throws IOException,
                                 AutomationException
A RasterBand given its name.

Product Availability

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

Specified by:
getBandByName in interface IRasterBandCollection
Parameters:
name - The name (in)
Returns:
A reference to a com.esri.arcgis.datasourcesraster.IRasterBand
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBands

public IEnumRasterBand getBands()
                         throws IOException,
                                AutomationException
All the bands in the collection as an interface to the RasterBands enumerator object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBands in interface IRasterBandCollection
Returns:
A reference to a com.esri.arcgis.datasourcesraster.IEnumRasterBand
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

item

public IRasterBand item(int bandIndex)
                 throws IOException,
                        AutomationException
Returns a RasterBand given its index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
item in interface IRasterBandCollection
Parameters:
bandIndex - The bandIndex (in)
Returns:
A reference to a com.esri.arcgis.datasourcesraster.IRasterBand
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

saveAs

public IDataset saveAs(String new_name,
                       IWorkspace worksp,
                       String format)
                throws IOException,
                       AutomationException
Creates a new persistent RasterDataset with the bands in the collection.

Remarks

The SaveAs method can create a raster dataset in Imagine, TIFF, GRID, JPEG2000, JPEG, BMP, GIF, PNG, PCI Raster, USGS ASCII DEM, X11 Pixmap, Memory Raster and geodatabase raster.

The format strings used for the supported formats are below, and they are case sensitive:

Format Name String Used
Imagine "IMAGINE Image"
TIFF "TIFF"
GRID "GRID"
JPEG "JPG"
JP2000 "JP2"
BMP "BMP"
PNG "PNG"
GIF "GIF"
PCI Raster "PIX"
X11 Pixmap "XPM"
PCRaster "MAP"
Memory Raster "MEM"
HDF4 "HDF4"
BIL "BIL"
BIP "BIP"
BSQ "BSQ"
Idrisi Raster Format "RST"
ENVI Raster Format "ENVI"
Geodatabase Raster "GDB"

The format string "TIFF" creates a TIFF file with ".tif" extension. ArcGIS also supports TIFF format with ".tiff" and ".tff" extensions. A format string "TIF" creates a TIFF file with ".tiff" extention and a format string "TFF" creates a TIFF file with ".tff" extension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
saveAs in interface IRasterBandCollection
Specified by:
saveAs in interface ISaveAs
Parameters:
new_name - The new_name (in)
worksp - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
format - The format (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IDataset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

appendBand

public void appendBand(IRasterBand element)
                throws IOException,
                       AutomationException
Appends a RasterBand to the band collection.

Remarks

This method is only applicable to work with a Raster, not with a RasterDataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
appendBand in interface IRasterBandCollection
Parameters:
element - A reference to a com.esri.arcgis.datasourcesraster.IRasterBand (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

appendBands

public void appendBands(IRasterBandCollection bands)
                 throws IOException,
                        AutomationException
Appends a collection of RasterBands to the band collection.

Remarks

This method is only applicable to work with a Raster, not with a RasterDataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
appendBands in interface IRasterBandCollection
Parameters:
bands - A reference to a com.esri.arcgis.datasourcesraster.IRasterBandCollection (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isPresent

public boolean isPresent()
                  throws IOException,
                         AutomationException
Indicates whether pyramid layers exist.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isPresent in interface IRasterPyramid
Returns:
The present
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMinimumSize

public void setMinimumSize(IPnt ppVal)
                    throws IOException,
                           AutomationException
The minimum raster pyramid size.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getMinimumSize

public IPnt getMinimumSize()
                    throws IOException,
                           AutomationException
The minimum raster pyramid size.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

create

public void create()
            throws IOException,
                   AutomationException
Build raster pyramids for this raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
create in interface IRasterPyramid
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMetadata

public IPropertySet getMetadata()
                         throws IOException,
                                AutomationException
The PropertySet containing metadata.

Remarks

The variable to hold the data must be of IPropertySet data type.

The metadata property is frequently used to save, or update, changes to metadata documents that have taken place through methods available on the IPropertySet, IXmlPropertySet, and/or IXmlPropertySet2 interfaces.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMetadata in interface IMetadata
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMetadata

public void setMetadata(IPropertySet ppPropertySet)
                 throws IOException,
                        AutomationException
The PropertySet containing metadata.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

synchronize

public void synchronize(int action,
                        int interval)
                 throws IOException,
                        AutomationException
Updates metadata with the current properties; may create metadata if it doesn't already exist.

Description

The Synchronize method is used to extract metadata properties from an object and write those properties to the metadata .xml. Depending on the value of the esriMetaSyncAction, the Synchronize method may generate a new set of metadata if it doesn't already exist.

Remarks

The following actions will result in synchronization given each of the listed conditions:

Action Metadata status Esri/Sync element Interval parameter
esriMSAAccessed Doesn't matter Must not be FALSE Must be less than actual interval
esriMSAAlways Doesn't matter Doesn't matter Doesn't matter
esriMSACreated Must not exist Must not be FALSE Must be less than actual interval
esriMSANotCreated Must exist Must not be FALSE Must be less than actual interval
esriMSAOverwrite Doesn't matter Doesn't matter Doesn't matter

The difference between esriMSAAlways and esriMSAOverwrite lies in which elements are synchronized. esriMSAAlways will honor the removal or value change of an element's Sync attribute (to disable synchronization), whereas using esriMSAOverwrite is equivalent to setting the IXmlPropertySet2.OverwriteSyncAttribute to true for the metadata's property set, meaning that even elements without a Sync attribute of TRUE will be synchronized.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
synchronize in interface IMetadata
Parameters:
action - A com.esri.arcgis.geodatabase.esriMetadataSyncAction constant (in)
interval - The interval (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanEditMetadata

public boolean isCanEditMetadata()
                          throws IOException,
                                 AutomationException
Indicates if metadata can be edited.

Remarks

This property is available to those objects that support metadata.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isCanEditMetadata in interface IMetadataEdit
Returns:
The pCanEdit
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNativeType

public INativeType getNativeType()
                          throws IOException,
                                 AutomationException
The native type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isTemporary

public boolean isTemporary()
                    throws IOException,
                           AutomationException
Indicates if the dataset is temporary.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isTemporary in interface ITemporaryDataset
Returns:
The temporary
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

makePermanent

public void makePermanent()
                   throws IOException,
                          AutomationException
Persists this temporary dataset permanent.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
makePermanent in interface ITemporaryDataset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

makePermanentAs

public IDataset makePermanentAs(String new_name,
                                IWorkspace workspace,
                                String format)
                         throws IOException,
                                AutomationException
Persists this temporary dataset to a new permanent dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
makePermanentAs in interface ITemporaryDataset
Parameters:
new_name - The new_name (in)
workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
format - The format (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IDataset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

analyze

public void analyze(int tableComponents)
             throws IOException,
                    AutomationException
Analyze the data to update/generate DBMS statistics.

Remarks

When applied to a feature dataset, Analyze updates the statistics for all of the tables.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getAllowableComponents

public int getAllowableComponents()
                           throws IOException,
                                  AutomationException
The allowable components to be analyzed.

Remarks

The AllowableComponents property indicates which parts of the table or feature class can be analyzed. The returned value is based on the esriTableComponents enumeration. Members from this enumeration can be bitwise ord together.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getAllowableComponents in interface IDatasetAnalyze
Returns:
The allowableComponents
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStatTime

public int getStatTime(int dateMode)
                throws IOException,
                       AutomationException
The date modified/created/accessed.

Product Availability

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

Specified by:
getStatTime in interface IDatasetFileStat
Parameters:
dateMode - A com.esri.arcgis.geodatabase.esriDatasetFileStatTimeMode constant (in)
Returns:
The pTime
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStatSize

public int getStatSize()
                throws IOException,
                       AutomationException
The size.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getStatSize in interface IDatasetFileStat
Returns:
The pSize
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStatMode

public int getStatMode()
                throws IOException,
                       AutomationException
The access mode.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getStatMode in interface IDatasetFileStat
Returns:
A com.esri.arcgis.geodatabase.esriDatasetFileStatAccessMode constant
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.

write

public void write()
           throws IOException,
                  AutomationException
Creates a World File.

Remarks

For GRID format or datasets that get their georeference information from a world file, IWorldFileExport:Write method has no effect.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
write in interface IWorldFileExport
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canSaveAs

public boolean canSaveAs(String format)
                  throws IOException,
                         AutomationException
Checks if it's can be saved as a new persistent Dataset of a given format.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
canSaveAs in interface ISaveAs
Parameters:
format - The format (in)
Returns:
The canSaveAs
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

saveAsRasterDataset

public IRasterDataset saveAsRasterDataset(String name,
                                          IWorkspace workspace,
                                          String format,
                                          IRasterStorageDef storageDef)
                                   throws IOException,
                                          AutomationException
Creates a new persistent Raster Dataset of a given format and specified storage definition.

Description

The pStorageDef argument specified the storage parameters, compression type, compression quality, tile size, ect. The parameters apply to certain output raster format, if the output raster format doesn't support the storage parameter specified, the settings are ignored.

The format strings used for the supported formats are below, and they are case sensitive:

Format Name String Used
Imagine "IMAGINE Image"
TIFF "TIFF"
GRID "GRID"
JPEG "JPG"
JP2000 "JP2"
BMP "BMP"
PNG "PNG"
GIF "GIF"
PCI Raster "PIX"
X11 Pixmap "XPM"
PCRaster "MAP"
Memory Raster "MEM"
HDF4 "HDF4"
BIL "BIL"
BIP "BIP"
BSQ "BSQ"
Idrisi Raster Format "RST"
ENVI Raster Format "ENVI"
Geodatabase Raster "GDB"

Product Availability

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

Specified by:
saveAsRasterDataset in interface ISaveAs2
Parameters:
name - The name (in)
workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
format - The format (in)
storageDef - A reference to a com.esri.arcgis.geodatabase.IRasterStorageDef (in)
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.