com.esri.arcgis.geodatabasedistributed
Class DeltaDataChanges

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

All Implemented Interfaces:

IDataChanges, IDataChanges2, IDeltaDataChanges, IDeltaDataChanges2, IDeltaDataChangesInit, IDeltaDataChangesInit2, IDeltaDataChangesRelease, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class DeltaDataChanges
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDataChanges, IDataChanges2, IDeltaDataChanges, IDeltaDataChanges2, IDeltaDataChangesInit, IDeltaDataChangesInit2, IDeltaDataChangesRelease

The information needed to check in from a delta file or import edits from a delta file.

Remarks

The DeltaDataChanges coclass is used to get the edits stored in a delta file. The delta files can be simple or full types.

See DataChangesExporter for information on delta files.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

DeltaDataChanges()
Constructs a DeltaDataChanges using ArcGIS Engine.

DeltaDataChanges(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DeltaDataChanges theDeltaDataChanges = (DeltaDataChanges) 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	getBugfixVersion() Bugfix version level of the source geodatabase.
int	getChangesModelType() Geodabase model type, simple or full.
static String	getClsid() getClsid.
Object	getContainer() The container, which can be a workspace or an XML document, in which the delta changes are stored.
int	getMajorVersion() Major version level of the source geodatabase.
int	getMinorVersion() Minor version level of the source geodatabase.
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.
int	getReplicaMessageType() Identifies the replica message type of the data changes object.
int	hashCode() the hashcode for this object
void	init(String changesFileName, int exportOption) Initializes the class by setting delta database file name and export option.
void	init2(String changesFileName, int exportOption, boolean randomAccess) Initializes the class by setting delta database file name, export option, and the ability to access the file content randomly.

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

DeltaDataChanges

public DeltaDataChanges()
                 throws IOException,
                        UnknownHostException

Constructs a DeltaDataChanges using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

DeltaDataChanges

public DeltaDataChanges(Object obj)
                 throws IOException

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

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

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.

getContainer

public Object getContainer()
                    throws IOException,
                           AutomationException

The container, which can be a workspace or an XML document, in which the delta changes are stored.

Remarks

This interface has a single property called container. It returns a personal geodatabase workspace for delta databases, a file geodatabase workspace for delta file geodatabases, or a reference to the XML file for XML delta files.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getContainer in interface IDeltaDataChanges

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReplicaMessageType

public int getReplicaMessageType()
                          throws IOException,
                                 AutomationException

Identifies the replica message type of the data changes object.

Remarks

This property identifies the replica message type of the data changes object and returns a value of the esriReplicaMessageType enumeration.

A data change message that includes instructions to switch roles returns esriReplicaMessageTypeDCWFD. A data changes message that doesn't include instructions to switch roles returns esriReplicaMessageTypeDC. An acknowledgement message returns esriReplicaTypeAck. See the esriReplicaMessageType enumeration for more information.

Product Availability

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

Specified by:

getReplicaMessageType in interface IDeltaDataChanges2

Returns:

A com.esri.arcgis.geodatabasedistributed.esriReplicaMessageType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

init

public void init(String changesFileName,
                 int exportOption)
          throws IOException,
                 AutomationException

Initializes the class by setting delta database file name and export option.

Remarks

This interface provides an init method which allows you to initialize the DeltaDataChanges coclass. The class can be initialized from either a delta database, a delta file geodatabase or a delta XML file. The changesFileName parameter is the path of the delta file and the exportOption parameter is the type of delta file.

See the DataChangesExporter coclass for more information on delta files.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

init in interface IDeltaDataChangesInit

Parameters:

changesFileName - The changesFileName (in)

exportOption - A com.esri.arcgis.geodatabasedistributed.esriExportDataChangesOption constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

init2

public void init2(String changesFileName,
                  int exportOption,
                  boolean randomAccess)
           throws IOException,
                  AutomationException

Initializes the class by setting delta database file name, export option, and the ability to access the file content randomly.

Remarks

The init method initializes the DeltaDataChanges coclass. The RandomAccess parameter allows you to initialize the coclass with random access.

If the RandomAccess parameter is set to False, this interface performs the same function as IDeltaDataChangesInit::Init.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

init2 in interface IDeltaDataChangesInit2

Parameters:

changesFileName - The changesFileName (in)

exportOption - A com.esri.arcgis.geodatabasedistributed.esriExportDataChangesOption constant (in)

randomAccess - The randomAccess (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMajorVersion

public int getMajorVersion()
                    throws IOException,
                           AutomationException

Major version level of the source geodatabase.

Remarks

This major release of the geodatabase from which the delta file was generated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMajorVersion in interface IDeltaDataChangesRelease

Returns:

The versionNumber

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinorVersion

public int getMinorVersion()
                    throws IOException,
                           AutomationException

Minor version level of the source geodatabase.

Remarks

This minor release of the geodatabase from which the delta file was generated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMinorVersion in interface IDeltaDataChangesRelease

Returns:

The versionNumber

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBugfixVersion

public int getBugfixVersion()
                     throws IOException,
                            AutomationException

Bugfix version level of the source geodatabase.

Remarks

This bug fix release of the geodatabase from which the delta file was generated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBugfixVersion in interface IDeltaDataChangesRelease

Returns:

The versionNumber

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.