com.esri.arcgis.geodatabasedistributed
Interface ISchemaChangesInit

All Superinterfaces:

Serializable

All Known Implementing Classes:

SchemaChanges

public interface ISchemaChangesInit
extends Serializable

Provides access to members that initialize schema changes of a replica.

Remarks

The ISchemaChangesInit interface provides access to methods for initializing a SchemaChanges object.

The SchemaChanges object can be used to inspect schema differences between replicas, and can be used to apply schema changes to a target replica. See the SchemaChanges coclass for more information.

Product Availability

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

Method Summary

void	init(IReplica replica, IWorkspaceName targetWorkspaceName) Initializes the object using the replica and the target replica workspace.
void	initFromSchemaDifferencesDocument(String xmlFile, IWorkspaceName targetWorkspaceName) Initializes the object using a schema differences document and a target replica workspace.
void	initFromSchemaDocument(String xmlFile, IWorkspaceName targetWorkspaceName) Initializes the object using a replica schema document and a target replica workspace.

Method Detail

init

void init(IReplica replica,
          IWorkspaceName targetWorkspaceName)
          throws IOException,
                 AutomationException

Initializes the object using the replica and the target replica workspace.

Remarks

The init method initializes the SchemaChanges object in a connected environment. Once the SchemaChanges object has been initialized, you can inspect schema differences between parent and child replicas.

The Replica parameter is the replica which is the source of the comparison. The targetWorkspaceName is the workspace name of the relative replica to which you would like to compare the Replica schema to.

For example, imagine you make a few schema changes to the child replica, such as dropping a table. and/or adding a field. Now you would like to inspect the schema differences between the child and parent replica. Pass in the Child replica for the Replica parameter and the parent replica workspace name as the targetWorkspaceName to initialize the schemaChanges object. You may now use method ISchemaChanges::GetChanges method to inspect the schema differences. See the SchemaChanges::ISchemaChanges interface for more information. You can apply any schema differences to the replica associated with the targetWorkspaceName by using methods on the ISchemaChangeInfo interface.

Product Availability

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

Parameters:

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

targetWorkspaceName - 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.

initFromSchemaDocument

void initFromSchemaDocument(String xmlFile,
                            IWorkspaceName targetWorkspaceName)
                            throws IOException,
                                   AutomationException

Initializes the object using a replica schema document and a target replica workspace.

Remarks

Initializes SchemaChanges object from a replica schema document. Once the SchemaChanges object has been initialized, you can inspect schema differences between replica schema defined in the xmlfile and it's relative replica.

The xmlfile is the replica schema document of one replica. The targetWorkspaceName is the workspace name of the relative replica.

Product Availability

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

Parameters:

xmlFile - The xmlFile (in)

targetWorkspaceName - 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.

initFromSchemaDifferencesDocument

void initFromSchemaDifferencesDocument(String xmlFile,
                                       IWorkspaceName targetWorkspaceName)
                                       throws IOException,
                                              AutomationException

Initializes the object using a schema differences document and a target replica workspace.

Remarks

This method initializes a SchemaChanges object from a schema differences document.

The xmlfile is the schema differences document. The targetWorkspaceName is the workspace name of the replica you are making the comparison to.

Product Availability

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

Parameters:

xmlFile - The xmlFile (in)

targetWorkspaceName - 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.