com.esri.arcgis.geodatabasedistributed
Class CheckOutDataChanges

java.lang.Object
  com.esri.arcgis.geodatabasedistributed.CheckOutDataChanges

All Implemented Interfaces:

IDataChanges, IDataChanges2, IReplicaDataChanges, IReplicaDataChangesInit, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class CheckOutDataChanges
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDataChanges, IDataChanges2, IReplicaDataChanges, IReplicaDataChangesInit

The information needed to perform a check in from a check-out database.

Remarks

This CheckoutDataChanges coClass is used during check in to get the changes that have been made to the check-out geodatabase. It is also used by the DataChangesExporter coClass to export edits to a delta file. This class can only be used on check-out geodatabases.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

ICheckOut, IReplicaValidation, DataChangesExporter, ICheckOut.checkOutData(com.esri.arcgis.geodatabase.IReplicaDescription, boolean, String), CheckOut, DataChanges, IExportDataChanges, Serialized Form

Constructor Summary

CheckOutDataChanges()
Constructs a CheckOutDataChanges using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
IDifferenceCursor	extract(String tableName, int changeType) Lists the edits in each feature class or table.
int	getChangesModelType() Geodabase model type, simple or full.
static String	getClsid() getClsid.
IEnumModifiedClassInfo	getModifiedClassesInfo() Returns an enumeration listing of the feature classes and tables with edits.
int	getParentReplicaID() ID for the replica in the parent geodatabase.
IWorkspaceName	getParentWorkspaceName() Workspace of the master geodatabase.
String	getReplicaGuid() GUID identifying the child/parent replica pair.
IWorkspace	getWorkspace() The workspace holding the replica from which the changes are being reported.
int	hashCode() the hashcode for this object
void	init(IReplica replica, IWorkspaceName checkoutWorkspace) Initializes the class by using the replica and the replica workspace.

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

CheckOutDataChanges

public CheckOutDataChanges()
                    throws IOException,
                           UnknownHostException

Constructs a CheckOutDataChanges using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

CheckOutDataChanges

public CheckOutDataChanges(Object obj)
                    throws IOException

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

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

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

getModifiedClassesInfo

public IEnumModifiedClassInfo getModifiedClassesInfo()
                                              throws IOException,
                                                     AutomationException

Returns an enumeration listing of the feature classes and tables with edits.

Remarks

The GetModifiedClassesInfo method returns an enumeration of the datasets that have been edited. For replicas (check-out replicas, two way and one way replicas), datasets that have been replicated but not edited are not included.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getModifiedClassesInfo in interface IDataChanges

Returns:

A reference to a com.esri.arcgis.geodatabasedistributed.IEnumModifiedClassInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

extract

public IDifferenceCursor extract(String tableName,
                                 int changeType)
                          throws IOException,
                                 AutomationException

Lists the edits in each feature class or table.

Remarks

The Extract method returns a difference cursor of the rows inserted, updated or deleted. The tablename can be any class that implements ITableName such as a feature class name, table name or attributed relationship class name. The changeType enumeration is used to specify the type of changes to return.

If using this interface with a DeltaDataChanges coclass, initializing the coclass with random access may be significant. See DeltaDataChanges::IDeltaDataChangesInit2 for more information.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

extract in interface IDataChanges

Parameters:

tableName - The tableName (in)

changeType - A com.esri.arcgis.geodatabasedistributed.esriDataChangeType constant (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParentWorkspaceName

public IWorkspaceName getParentWorkspaceName()
                                      throws IOException,
                                             AutomationException

Workspace of the master geodatabase.

Remarks

The ParentWorkspaceName property returns the workspace name of the parent geodatabase. This property is only valid for CheckoutDataChanges coclasses, DeltaDataChanges coclasses, and ReplicationDataChanges initialized using delta databases (mdb file) or delta file geodatabases (gdb file). A delta XML file does not store this information.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getParentWorkspaceName in interface IDataChanges

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParentReplicaID

public int getParentReplicaID()
                       throws IOException,
                              AutomationException

ID for the replica in the parent geodatabase.

Remarks

This property returns the parent replica ID.

The ParentReplicaID and ReplicaGUID properties identify the replica on the parent geodatabase. These properties are only valid for the CheckoutDataChanges coclass, DeltaDataChanges coclass, and the ReplicationDataChanges coclass when initialized for a replica. Both properties can be used to identify the replica, however, ReplicaGUID is unique across all databases.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getParentReplicaID in interface IDataChanges

Returns:

The parentReplicaID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReplicaGuid

public String getReplicaGuid()
                      throws IOException,
                             AutomationException

GUID identifying the child/parent replica pair.

Remarks

This property returns the replica's GUID.

The ParentReplicaID and ReplicaGUID properties identify the replica on the parent geodatabase. These properties are only valid for the CheckoutDataChanges coclass, DeltaDataChanges coclass, and the ReplicationDataChanges coclass when initialized for a replica. Both properties can be used to identify the replica, however, ReplicaGUID is unique across all databases.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getReplicaGuid in interface IDataChanges

Returns:

The replicaGuid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getChangesModelType

public int getChangesModelType()
                        throws IOException,
                               AutomationException

Geodabase model type, simple or full.

Remarks

Returns the model type of delta file or a replica.

A full model type delta file indicates that all reactive geodatabase behavior was executed at edit time.

A simple model type delta file assumes that the edits were not made by a reactive geodatabase editor.

See the DataChangesExporter coclass for more information on delta files. A check-out is always a full model type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getChangesModelType in interface IDataChanges2

Returns:

A com.esri.arcgis.geodatabase.esriReplicaModelType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWorkspace

public IWorkspace getWorkspace()
                        throws IOException,
                               AutomationException

The workspace holding the replica from which the changes are being reported.

Remarks

Returns a workspace object which references the replica geodatabase that is the source of the changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getWorkspace in interface IReplicaDataChanges

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.

init

public void init(IReplica replica,
                 IWorkspaceName checkoutWorkspace)
          throws IOException,
                 AutomationException

Initializes the class by using the replica and the replica workspace.

Remarks

The init method takes a checkoutWorkspace and a Replica. See IWorkspaceReplicas to see how to get a replica object.

This method is used to initialize replication data changes for check-out replicas. To initialize replication data changes for two way or one way replicas use the IReplicaDataChangesInit2::Init2 method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

init in interface IReplicaDataChangesInit

Parameters:

replica - A reference to a com.esri.arcgis.geodatabase.IReplica (in)

checkoutWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.