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

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

All Implemented Interfaces:

GPTool

public class ExportDataChangeMessage
extends AbstractGPTool

Creates an output delta file containing updates from an input replica. The Export Data Change Message tool is contained in the Data Management Tools tool box.

Usage tips:

• The geodatabase may be a local geodatabase or a geodata service.
• The output delta file can be a delta file geodatabase (.gdb), delta personal geodatabase (.mdb) or a delta XML file (.xml). When specifying the output delta file, you must inlclude the appropriate suffix (.gdb, .mdb or .xml)
• This tool is used when synchronizing replica while disconnected. This is done by first running the tool which creates a delta file with changes to synchronize. The delta file is then copied to the relative replica and imported using the tool. If a delta file gets lost and you want to resend, you can use the tool to regenerate the delta file. After the changes are imported, the relative replica can export an acknowledgement file using the tool. The acknowledgment file is copied to the replica and imported using the tool. If an acknowledgement is not received, the next time changes are sent they will include the new changes plus the previously sent changes.
• To synchronize replicas in a connected mode see the tool.

Field Summary

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

vals

Constructor Summary

ExportDataChangeMessage()
Creates the Export Data Change Message tool with defaults.

ExportDataChangeMessage(Object inGeodatabase, Object outDataChangesFile, String inReplica, String switchToReceiver, String includeUnacknowledgedChanges, String includeNewChanges)
Creates the Export Data Change Message tool with the required parameters.

Method Summary

String	getIncludeNewChanges() Returns the Include new data changes since last export parameter of this tool .
String	getIncludeUnacknowledgedChanges() Returns the Include unacknowledged data changes parameter of this tool .
Object	getInGeodatabase() Returns the Export from Replica Geodatabase parameter of this tool .
String	getInReplica() Returns the Replica parameter of this tool .
Object	getOutDataChangesFile() Returns the Output Data Changes File parameter of this tool .
String	getSwitchToReceiver() Returns the Switch to Receiver once the message has been exported 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	setIncludeNewChanges(String includeNewChanges) Sets the Include new data changes since last export parameter of this tool .
void	setIncludeUnacknowledgedChanges(String includeUnacknowledgedChanges) Sets the Include unacknowledged data changes parameter of this tool .
void	setInGeodatabase(Object inGeodatabase) Sets the Export from Replica Geodatabase parameter of this tool .
void	setInReplica(String inReplica) Sets the Replica parameter of this tool .
void	setOutDataChangesFile(Object outDataChangesFile) Sets the Output Data Changes File parameter of this tool .
void	setSwitchToReceiver(String switchToReceiver) Sets the Switch to Receiver once the message has been exported 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

ExportDataChangeMessage

public ExportDataChangeMessage()

Creates the Export Data Change Message tool with defaults.

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

ExportDataChangeMessage

public ExportDataChangeMessage(Object inGeodatabase,
                               Object outDataChangesFile,
                               String inReplica,
                               String switchToReceiver,
                               String includeUnacknowledgedChanges,
                               String includeNewChanges)

Creates the Export Data Change Message 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 from which to export the data change message. The geodatabase may be local or remote.

outDataChangesFile - specifies the delta file to export to.

inReplica - the replica containing updates to be exported.

switchToReceiver - indicates whether to change the role of the replica to that of a receiver. The receiver may not send replica updates until updates from the relative replica sender arrive.

includeUnacknowledgedChanges - indicates whether to include data changes that have been previously exported for which no acknowledgement message has been received.

includeNewChanges - indicates whether to include all data changes created since the last exported data change message.

Method Detail

getInGeodatabase

public Object getInGeodatabase()

Returns the Export from Replica Geodatabase parameter of this tool . This parameter is specifies the replica geodatabase from which to export the data change message. The geodatabase may be local or remote. This is a required parameter.

Returns:

the Export from Replica Geodatabase

setInGeodatabase

public void setInGeodatabase(Object inGeodatabase)

Sets the Export from Replica Geodatabase parameter of this tool . This parameter is specifies the replica geodatabase from which to export the data change message. The geodatabase may be local or remote. This is a required parameter.

Parameters:

inGeodatabase - specifies the replica geodatabase from which to export the data change message. The geodatabase may be local or remote.

getOutDataChangesFile

public Object getOutDataChangesFile()

Returns the Output Data Changes File parameter of this tool . This parameter is specifies the delta file to export to. This is a required parameter.

Returns:

the Output Data Changes File

setOutDataChangesFile

public void setOutDataChangesFile(Object outDataChangesFile)

Sets the Output Data Changes File parameter of this tool . This parameter is specifies the delta file to export to. This is a required parameter.

Parameters:

outDataChangesFile - specifies the delta file to export to.

getInReplica

public String getInReplica()

Returns the Replica parameter of this tool . This parameter is the replica containing updates to be exported. This is a required parameter.

Returns:

the Replica

setInReplica

public void setInReplica(String inReplica)

Sets the Replica parameter of this tool . This parameter is the replica containing updates to be exported. This is a required parameter.

Parameters:

inReplica - the replica containing updates to be exported.

getSwitchToReceiver

public String getSwitchToReceiver()

Returns the Switch to Receiver once the message has been exported parameter of this tool . This parameter is indicates whether to change the role of the replica to that of a receiver. The receiver may not send replica updates until updates from the relative replica sender arrive. This is a required parameter.

Returns:

the Switch to Receiver once the message has been exported

setSwitchToReceiver

public void setSwitchToReceiver(String switchToReceiver)

Sets the Switch to Receiver once the message has been exported parameter of this tool . This parameter is indicates whether to change the role of the replica to that of a receiver. The receiver may not send replica updates until updates from the relative replica sender arrive. This is a required parameter.

Parameters:

switchToReceiver - indicates whether to change the role of the replica to that of a receiver. The receiver may not send replica updates until updates from the relative replica sender arrive.

getIncludeUnacknowledgedChanges

public String getIncludeUnacknowledgedChanges()

Returns the Include unacknowledged data changes parameter of this tool . This parameter is indicates whether to include data changes that have been previously exported for which no acknowledgement message has been received. This is a required parameter.

Returns:

the Include unacknowledged data changes

setIncludeUnacknowledgedChanges

public void setIncludeUnacknowledgedChanges(String includeUnacknowledgedChanges)

Sets the Include unacknowledged data changes parameter of this tool . This parameter is indicates whether to include data changes that have been previously exported for which no acknowledgement message has been received. This is a required parameter.

Parameters:

includeUnacknowledgedChanges - indicates whether to include data changes that have been previously exported for which no acknowledgement message has been received.

getIncludeNewChanges

public String getIncludeNewChanges()

Returns the Include new data changes since last export parameter of this tool . This parameter is indicates whether to include all data changes created since the last exported data change message. This is a required parameter.

Returns:

the Include new data changes since last export

setIncludeNewChanges

public void setIncludeNewChanges(String includeNewChanges)

Sets the Include new data changes since last export parameter of this tool . This parameter is indicates whether to include all data changes created since the last exported data change message. This is a required parameter.

Parameters:

includeNewChanges - indicates whether to include all data changes created since the last exported data change message.

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