com.esri.arcgis.datasourcesraster
Class IRasterTransactionProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.datasourcesraster.IRasterTransactionProxy

All Implemented Interfaces:

IRasterTransaction, Externalizable, Serializable

public class IRasterTransactionProxy
extends com.esri.arcgis.interop.Dispatch
implements IRasterTransaction, 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.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IRasterTransactionProxy()
	IRasterTransactionProxy(Object obj)
protected	IRasterTransactionProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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	removeListener(String iidStr, Object theListener)
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.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IRasterTransactionProxy

public IRasterTransactionProxy()

IRasterTransactionProxy

public IRasterTransactionProxy(Object obj)
                        throws IOException

Throws:

IOException

IRasterTransactionProxy

protected IRasterTransactionProxy(Object obj,
                                  String iid)
                           throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

setUndoLevels

public 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

Specified by:

setUndoLevels in interface IRasterTransaction

Parameters:

num_undo - The num_undo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

commit

public 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

Specified by:

commit in interface IRasterTransaction

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

start

public 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

Specified by:

start in interface IRasterTransaction

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

end

public 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

Specified by:

end in interface IRasterTransaction

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

undo

public 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

Specified by:

undo in interface IRasterTransaction

Parameters:

n - The n (in)

Returns:

The pending

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUndoLevels

public 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

Specified by:

getUndoLevels in interface IRasterTransaction

Returns:

The num_undo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.