com.esri.arcgis.geodatabasedistributed
Class TablesDataChanges

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

All Implemented Interfaces:

IDataChanges, IDataChanges2, IEnumTableDataChanges, ITablesDataChanges, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class TablesDataChanges
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDataChanges, IDataChanges2, ITablesDataChanges, IEnumTableDataChanges

The information needed to export changes.

Remarks

The TablesDataChanges coclass can be used to define an updategram based on edits stored in feature classes and tables. Records to be deleted may also be defined by supplying arrays of IDs or GlobalIDs. These edits are defined using the TableDataChangesInfo coclass and are added to the TablesDataChanges coclass with the Add method.

Updategrams contain edits that can be imported into a geodatabase using the DataChangesImporter coclass. 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.

See Also:

Serialized Form

Constructor Summary

TablesDataChanges()
Constructs a TablesDataChanges using ArcGIS Engine.

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

Method Summary

void	add(ITableDataChangesInfo tableDataChanges) Add table data changes.
boolean	equals(Object o) Compare this object with another
IDifferenceCursor	extract(String tableName, int changeType) Lists the edits in each feature class or table.
ITableDataChangesInfo	findTableChangesInfo(String targetName) A TableDataChangesInfo object for the target feature class.
int	getChangesModelType() Geodabase model type, simple or full.
static String	getClsid() getClsid.
int	getCount() The number of TableDataChangesInfo objects that have been added.
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	hashCode() the hashcode for this object
void	init(int modelType) The changes model type.
ITableDataChangesInfo	next() The next table data changes in the enumeration.
void	remove(String targetName) Remove table data changes.
void	reset() Reset the enumeration.

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

TablesDataChanges

public TablesDataChanges()
                  throws IOException,
                         UnknownHostException

Constructs a TablesDataChanges using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

TablesDataChanges

public TablesDataChanges(Object obj)
                  throws IOException

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

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

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.

init

public void init(int modelType)
          throws IOException,
                 AutomationException

The changes model type.

Remarks

Initializes the class by setting the model type.

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.

Product Availability

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

Specified by:

init in interface ITablesDataChanges

Parameters:

modelType - A com.esri.arcgis.geodatabase.esriReplicaModelType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

add

public void add(ITableDataChangesInfo tableDataChanges)
         throws IOException,
                AutomationException

Add table data changes.

Remarks

This method adds a reference a TableDataChangesInfo object to the TablesDataChanges object.

Product Availability

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

Specified by:

add in interface ITablesDataChanges

Parameters:

tableDataChanges - A reference to a com.esri.arcgis.geodatabasedistributed.ITableDataChangesInfo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(String targetName)
            throws IOException,
                   AutomationException

Remove table data changes.

Product Availability

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

Specified by:

remove in interface ITablesDataChanges

Parameters:

targetName - The targetName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findTableChangesInfo

public ITableDataChangesInfo findTableChangesInfo(String targetName)
                                           throws IOException,
                                                  AutomationException

A TableDataChangesInfo object for the target feature class.

Product Availability

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

Specified by:

findTableChangesInfo in interface ITablesDataChanges

Parameters:

targetName - The targetName (in)

Returns:

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

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 TableDataChangesInfo objects that have been added.

Product Availability

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

Specified by:

getCount in interface ITablesDataChanges

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

next

public ITableDataChangesInfo next()
                           throws IOException,
                                  AutomationException

The next table data changes in the enumeration.

Product Availability

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

Specified by:

next in interface IEnumTableDataChanges

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws IOException,
                  AutomationException

Reset the enumeration.

Product Availability

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

Specified by:

reset in interface IEnumTableDataChanges

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.