com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class CompareReplicaSchema

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.CompareReplicaSchema

All Implemented Interfaces:

GPTool

public class CompareReplicaSchema
extends AbstractGPTool

Generates an XML that describes schema differences between a replica geodatabase and the relative replica geodatabase. The Compare Replica Schema tool is contained in the Data Management Tools tool box.

Usage tips:

• The output replica schema changes file must be XML.
• This tool is used when synchronizing replica schema. To synchronize replica schema, first run on the relative replica. The output from export replica schema contains information about the schema of the replica datasets in the relative replica geodatabase. This output is then used with the to find differences between the replica geodatabases. The output from the tool can then be used to apply schema differences to the replica geodatabase using the .

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

CompareReplicaSchema()
Creates the Compare Replica Schema tool with defaults.

CompareReplicaSchema(Object inGeodatabase, Object inSourceFile, Object outputReplicaSchemaChangesFile)
Creates the Compare Replica Schema tool with the required parameters.

Method Summary

Object	getInGeodatabase() Returns the Compare to Replica Geodatabase parameter of this tool .
Object	getInSourceFile() Returns the Relative Replica Schema File parameter of this tool .
Object	getOutputReplicaSchemaChangesFile() Returns the Output Replica Schema Changes File parameter of this tool .
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
void	setInGeodatabase(Object inGeodatabase) Sets the Compare to Replica Geodatabase parameter of this tool .
void	setInSourceFile(Object inSourceFile) Sets the Relative Replica Schema File parameter of this tool .
void	setOutputReplicaSchemaChangesFile(Object outputReplicaSchemaChangesFile) Sets the Output Replica Schema Changes File parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CompareReplicaSchema

public CompareReplicaSchema()

Creates the Compare Replica Schema tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

CompareReplicaSchema

public CompareReplicaSchema(Object inGeodatabase,
                            Object inSourceFile,
                            Object outputReplicaSchemaChangesFile)

Creates the Compare Replica Schema tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

inGeodatabase - specifies the replica geodatabase to which the replica schema will be compared. The geodatabase may be a local geodatabase or a geodata service.

inSourceFile - specifies the file which contains the relative replica schema to use for the comparison.

outputReplicaSchemaChangesFile - specifies the file to contain a description of the schema differences.

Method Detail

getInGeodatabase

public Object getInGeodatabase()

Returns the Compare to Replica Geodatabase parameter of this tool . This parameter is specifies the replica geodatabase to which the replica schema will be compared. The geodatabase may be a local geodatabase or a geodata service. This is a required parameter.

Returns:

the Compare to Replica Geodatabase

setInGeodatabase

public void setInGeodatabase(Object inGeodatabase)

Sets the Compare to Replica Geodatabase parameter of this tool . This parameter is specifies the replica geodatabase to which the replica schema will be compared. The geodatabase may be a local geodatabase or a geodata service. This is a required parameter.

Parameters:

inGeodatabase - specifies the replica geodatabase to which the replica schema will be compared. The geodatabase may be a local geodatabase or a geodata service.

getInSourceFile

public Object getInSourceFile()

Returns the Relative Replica Schema File parameter of this tool . This parameter is specifies the file which contains the relative replica schema to use for the comparison. This is a required parameter.

Returns:

the Relative Replica Schema File

setInSourceFile

public void setInSourceFile(Object inSourceFile)

Sets the Relative Replica Schema File parameter of this tool . This parameter is specifies the file which contains the relative replica schema to use for the comparison. This is a required parameter.

Parameters:

inSourceFile - specifies the file which contains the relative replica schema to use for the comparison.

getOutputReplicaSchemaChangesFile

public Object getOutputReplicaSchemaChangesFile()

Returns the Output Replica Schema Changes File parameter of this tool . This parameter is specifies the file to contain a description of the schema differences. This is a required parameter.

Returns:

the Output Replica Schema Changes File

setOutputReplicaSchemaChangesFile

public void setOutputReplicaSchemaChangesFile(Object outputReplicaSchemaChangesFile)

Sets the Output Replica Schema Changes File parameter of this tool . This parameter is specifies the file to contain a description of the schema differences. This is a required parameter.

Parameters:

outputReplicaSchemaChangesFile - specifies the file to contain a description of the schema differences.

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias