com.esri.arcgis.datasourcesraster
Interface IRasterTransaction

All Superinterfaces:
Serializable
All Known Implementing Classes:
IRasterTransactionProxy, RasterBand

public interface IRasterTransaction
extends Serializable

Provides access to members that provide undo support.

Remarks

This interface is supported on a file based RasterBand, not supported on a database RasterBand.

This interface allows you to setup and maintain a transaction stack that can revert from changes that have been made in memory before persisting these changes raster band. In this mechanism, a transaction is defined as either a write called on the dataset outside a double-buffered transaction or a set of writes contained within a single Start/End transaction block. The Start and End methods allow you to perform multiple writes that are managed by the undo stack as a single transaction.

To enable the transactioning mechanism, a band cache must first be created and then the undo level must be specified. To create the cache, call the AcquireCache method on the IRawPixels interface. After you are done editing, free the cache using the ReturnCache method.

This interface only works with raster in IMG, TIFF and GRID formats in ArcGIS 9.2

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void commit()
          Sends all pending changes to persistent storage.
 void end()
          Commits changes and stops double buffering.
 int getUndoLevels()
          Maximum number of reversible operations.
 void setUndoLevels(int num_undo)
          Maximum number of reversible operations.
 void start()
          Starts double buffering edits for undo support.
 int undo(int n)
          Reverses last N changes.
 

Method Detail

setUndoLevels

void setUndoLevels(int num_undo)
                   throws IOException,
                          AutomationException
Maximum number of reversible operations.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
num_undo - The num_undo (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

commit

void commit()
            throws IOException,
                   AutomationException
Sends all pending changes to persistent storage.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

start

void start()
           throws IOException,
                  AutomationException
Starts double buffering edits for undo support.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

end

void end()
         throws IOException,
                AutomationException
Commits changes and stops double buffering.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

undo

int undo(int n)
         throws IOException,
                AutomationException
Reverses last N changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
n - The n (in)
Returns:
The pending
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUndoLevels

int getUndoLevels()
                  throws IOException,
                         AutomationException
Maximum number of reversible operations.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The num_undo
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.