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

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

All Implemented Interfaces:

GPTool

public class CreateReplica
extends AbstractGPTool

Creates a replica to a personal, file, or SDE geodatabase from a specified list of feature classes, layers, datasets, and/or tables in an ArcSDE geodatabase. The Create Replica tool is contained in the Data Management Tools tool box.

Usage tips:

• All datasets must be from the same ArcSDE database.
• The data that you wish to replicate must be versioned, but not with the option to move edits to base. The database user that is connected must also have write permissions to the data. For two way and both types of one way replicas, all datasets must have a globalid column and have a high precision spatial reference.
• For check-out and one-way replicas the child replica geodatabase can be an ArcSDE, file or personal geodatabase.
• For two-way and one-way child to parent replicas the child geodatabase must be ArcSDE.
• To use archiving for one-way replicas the parent workspace must be connected to the Default version. For one-way child to parent replicas the child workspace must be connected to the Default version.
• In ArcMap the definition query and selection properties set on a layer or table determine what data gets replicated.
• For tables the default filter is Schema Only; only the schema for the table will be replicated. To apply a filter to a table you must first create a table view setting desired filters. You can then use this as input into the Create Replica tool. See the for more information.
• Replica Geometry Features can be used to define the replica geometry. You can also use the environment setting to define the replica geometry.
  • If only the Replica Geometry Features are set, only data intersecting the Replica Geometry Features will be replicated.
  • If only the environment setting is set, only data intersecting the extent will be replicated.
  • If both Replica Geometry Features and the environement are set, the Replica Geometry Features will be used.
  • If neither Replica Geometry Features nor the environment is specified, the full extent of the data is used.
• The replica geometry features can be points, lines or polygons.
• A feature layer used for the replica geometry features can contain one or more features. If there are more than one, the geometries are merged and only data that intersect the merged geometries will be replicated.
• If filters (i.e. spatial, selection, or definition query) have been defined on the replica geometry features, only features that satisfy these filters will be used to define the replica geometry.
• The Re-use Schema parameter options are only available for check-out replicas

Field Summary

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

vals

Constructor Summary

CreateReplica()
Creates the Create Replica tool with defaults.

CreateReplica(java.lang.Object inData, java.lang.String inType, java.lang.Object outGeodatabase, java.lang.String outName, java.lang.String archiving)
Creates the Create Replica tool with the required parameters.

Method Summary

java.lang.String	getAccessType() Returns the Replica Access Type parameter of this tool .
java.lang.String	getArchiving() Returns the Use archiving to track changes for 1 way replication parameter of this tool .
java.lang.String	getExpandFeatureClassesAndTables() Returns the Expand Feature Classes and Tables parameter of this tool .
java.lang.Object	getGeometryFeatures() Returns the Replica Geometry Features parameter of this tool .
java.lang.String	getGetRelatedData() Returns the Replicate Related Data parameter of this tool .
java.lang.Object	getInData() Returns the Replica Datasets parameter of this tool .
java.lang.String	getInitialDataSender() Returns the Initial Data Sender parameter of this tool .
java.lang.String	getInType() Returns the Replica Type parameter of this tool .
java.lang.Object	getOutChildGeodatabase() Returns the Output Child Workspace parameter of this tool (Read only).
java.lang.Object	getOutGeodatabase() Returns the Geodatabase to replicate data to parameter of this tool .
java.lang.String	getOutName() Returns the Replica Name parameter of this tool .
java.lang.String	getOutputReplicaName() Returns the Output Replica Name parameter of this tool (Read only).
java.lang.String	getReuseSchema() Returns the Re-use Schema parameter of this tool .
java.lang.String	getToolboxAlias() Returns the alias of the tool box containing this tool.
java.lang.String	getToolboxName() Returns the name of the tool box containing this tool.
java.lang.String	getToolName() Returns the name of this tool.
void	setAccessType(java.lang.String accessType) Sets the Replica Access Type parameter of this tool .
void	setArchiving(java.lang.String archiving) Sets the Use archiving to track changes for 1 way replication parameter of this tool .
void	setExpandFeatureClassesAndTables(java.lang.String expandFeatureClassesAndTables) Sets the Expand Feature Classes and Tables parameter of this tool .
void	setGeometryFeatures(java.lang.Object geometryFeatures) Sets the Replica Geometry Features parameter of this tool .
void	setGetRelatedData(java.lang.String getRelatedData) Sets the Replicate Related Data parameter of this tool .
void	setInData(java.lang.Object inData) Sets the Replica Datasets parameter of this tool .
void	setInitialDataSender(java.lang.String initialDataSender) Sets the Initial Data Sender parameter of this tool .
void	setInType(java.lang.String inType) Sets the Replica Type parameter of this tool .
void	setOutGeodatabase(java.lang.Object outGeodatabase) Sets the Geodatabase to replicate data to parameter of this tool .
void	setOutName(java.lang.String outName) Sets the Replica Name parameter of this tool .
void	setReuseSchema(java.lang.String reuseSchema) Sets the Re-use Schema 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

CreateReplica

public CreateReplica()

Creates the Create Replica tool with defaults.

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

CreateReplica

public CreateReplica(java.lang.Object inData,
                     java.lang.String inType,
                     java.lang.Object outGeodatabase,
                     java.lang.String outName,
                     java.lang.String archiving)

Creates the Create Replica 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:

inData - the data to be replicated. This list consists of layers and tables referencing versioned, editable data from an ArcSDE geodatabase.

inType - the kind of replica to create.

outGeodatabase - the local geodatabase or geodata service that will host the child replica. Geodata services are used to represent remote geodatabases. The geodatabase can be an ArcSDE, file, or personal geodatabase. For two-way replicas the child geodatabase must be ArcSDE. For one-way and check-out replicas the geodatabase can be personal, file, or ArcSDE. Personal or file geodatabases must already exist before running this tool.

outName - the name that identifies the replica.

archiving - specifies whether to use the archive class to track changes instead of using the versioning delta tables. This is only available for one-way replicas.

Method Detail

getInData

public java.lang.Object getInData()

Returns the Replica Datasets parameter of this tool . This parameter is the data to be replicated. This list consists of layers and tables referencing versioned, editable data from an ArcSDE geodatabase. This is a required parameter.

Returns:

the Replica Datasets

setInData

public void setInData(java.lang.Object inData)

Sets the Replica Datasets parameter of this tool . This parameter is the data to be replicated. This list consists of layers and tables referencing versioned, editable data from an ArcSDE geodatabase. This is a required parameter.

Parameters:

inData - the data to be replicated. This list consists of layers and tables referencing versioned, editable data from an ArcSDE geodatabase.

getInType

public java.lang.String getInType()

Returns the Replica Type parameter of this tool . This parameter is the kind of replica to create. This is a required parameter.

Returns:

the Replica Type

setInType

public void setInType(java.lang.String inType)

Sets the Replica Type parameter of this tool . This parameter is the kind of replica to create. This is a required parameter.

Parameters:

inType - the kind of replica to create.

getOutGeodatabase

public java.lang.Object getOutGeodatabase()

Returns the Geodatabase to replicate data to parameter of this tool . This parameter is the local geodatabase or geodata service that will host the child replica. Geodata services are used to represent remote geodatabases. The geodatabase can be an ArcSDE, file, or personal geodatabase. For two-way replicas the child geodatabase must be ArcSDE. For one-way and check-out replicas the geodatabase can be personal, file, or ArcSDE. Personal or file geodatabases must already exist before running this tool. This is a required parameter.

Returns:

the Geodatabase to replicate data to

setOutGeodatabase

public void setOutGeodatabase(java.lang.Object outGeodatabase)

Sets the Geodatabase to replicate data to parameter of this tool . This parameter is the local geodatabase or geodata service that will host the child replica. Geodata services are used to represent remote geodatabases. The geodatabase can be an ArcSDE, file, or personal geodatabase. For two-way replicas the child geodatabase must be ArcSDE. For one-way and check-out replicas the geodatabase can be personal, file, or ArcSDE. Personal or file geodatabases must already exist before running this tool. This is a required parameter.

Parameters:

outGeodatabase - the local geodatabase or geodata service that will host the child replica. Geodata services are used to represent remote geodatabases. The geodatabase can be an ArcSDE, file, or personal geodatabase. For two-way replicas the child geodatabase must be ArcSDE. For one-way and check-out replicas the geodatabase can be personal, file, or ArcSDE. Personal or file geodatabases must already exist before running this tool.

getOutName

public java.lang.String getOutName()

Returns the Replica Name parameter of this tool . This parameter is the name that identifies the replica. This is a required parameter.

Returns:

the Replica Name

setOutName

public void setOutName(java.lang.String outName)

Sets the Replica Name parameter of this tool . This parameter is the name that identifies the replica. This is a required parameter.

Parameters:

outName - the name that identifies the replica.

getAccessType

public java.lang.String getAccessType()

Returns the Replica Access Type parameter of this tool . This parameter is the type of access you want: This is an optional parameter.

Returns:

the Replica Access Type

setAccessType

public void setAccessType(java.lang.String accessType)

Sets the Replica Access Type parameter of this tool . This parameter is the type of access you want: This is an optional parameter.

Parameters:

accessType - the type of access you want:

getInitialDataSender

public java.lang.String getInitialDataSender()

Returns the Initial Data Sender parameter of this tool . This parameter is used by replication to determine which replica can send changes when in disconnected mode. If you are working in a connected mode, this parameter is inconsequential. This ensures that the relative replica doesn't send updates until the changes are first received from the initial data sender. This is an optional parameter.

Returns:

the Initial Data Sender

setInitialDataSender

public void setInitialDataSender(java.lang.String initialDataSender)

Sets the Initial Data Sender parameter of this tool . This parameter is used by replication to determine which replica can send changes when in disconnected mode. If you are working in a connected mode, this parameter is inconsequential. This ensures that the relative replica doesn't send updates until the changes are first received from the initial data sender. This is an optional parameter.

Parameters:

initialDataSender - used by replication to determine which replica can send changes when in disconnected mode. If you are working in a connected mode, this parameter is inconsequential. This ensures that the relative replica doesn't send updates until the changes are first received from the initial data sender.

getExpandFeatureClassesAndTables

public java.lang.String getExpandFeatureClassesAndTables()

Returns the Expand Feature Classes and Tables parameter of this tool . This parameter is specifies whether you will include expanded feature classes and tables, such as those found in geometric networks, topologies, or relationship classes. This is an optional parameter.

Returns:

the Expand Feature Classes and Tables

setExpandFeatureClassesAndTables

public void setExpandFeatureClassesAndTables(java.lang.String expandFeatureClassesAndTables)

Sets the Expand Feature Classes and Tables parameter of this tool . This parameter is specifies whether you will include expanded feature classes and tables, such as those found in geometric networks, topologies, or relationship classes. This is an optional parameter.

Parameters:

expandFeatureClassesAndTables - specifies whether you will include expanded feature classes and tables, such as those found in geometric networks, topologies, or relationship classes.

getReuseSchema

public java.lang.String getReuseSchema()

Returns the Re-use Schema parameter of this tool . This parameter is indicates whether to reuse a geodatabase that contains the schema of the data you want to replicate. This reduces the amount of time required to replicate the data. This option is only available for check-out replicas. This is an optional parameter.

Returns:

the Re-use Schema

setReuseSchema

public void setReuseSchema(java.lang.String reuseSchema)

Sets the Re-use Schema parameter of this tool . This parameter is indicates whether to reuse a geodatabase that contains the schema of the data you want to replicate. This reduces the amount of time required to replicate the data. This option is only available for check-out replicas. This is an optional parameter.

Parameters:

reuseSchema - indicates whether to reuse a geodatabase that contains the schema of the data you want to replicate. This reduces the amount of time required to replicate the data. This option is only available for check-out replicas.

getGetRelatedData

public java.lang.String getGetRelatedData()

Returns the Replicate Related Data parameter of this tool . This parameter is specifies whether to replicate rows related to rows already in the replica. For example, consider a feature (f1) inside the replication filter and a related feature (f2) from another class outside the filter. Feature f2 is included in the replica if you choose to get related data. This is an optional parameter.

Returns:

the Replicate Related Data

setGetRelatedData

public void setGetRelatedData(java.lang.String getRelatedData)

Sets the Replicate Related Data parameter of this tool . This parameter is specifies whether to replicate rows related to rows already in the replica. For example, consider a feature (f1) inside the replication filter and a related feature (f2) from another class outside the filter. Feature f2 is included in the replica if you choose to get related data. This is an optional parameter.

Parameters:

getRelatedData - specifies whether to replicate rows related to rows already in the replica. For example, consider a feature (f1) inside the replication filter and a related feature (f2) from another class outside the filter. Feature f2 is included in the replica if you choose to get related data.

getGeometryFeatures

public java.lang.Object getGeometryFeatures()

Returns the Replica Geometry Features parameter of this tool . This parameter is the features used to define the area to replicate. This is an optional parameter.

Returns:

the Replica Geometry Features

setGeometryFeatures

public void setGeometryFeatures(java.lang.Object geometryFeatures)

Sets the Replica Geometry Features parameter of this tool . This parameter is the features used to define the area to replicate. This is an optional parameter.

Parameters:

geometryFeatures - the features used to define the area to replicate.

getArchiving

public java.lang.String getArchiving()

Returns the Use archiving to track changes for 1 way replication parameter of this tool . This parameter is specifies whether to use the archive class to track changes instead of using the versioning delta tables. This is only available for one-way replicas. This is a required parameter.

Returns:

the Use archiving to track changes for 1 way replication

setArchiving

public void setArchiving(java.lang.String archiving)

Sets the Use archiving to track changes for 1 way replication parameter of this tool . This parameter is specifies whether to use the archive class to track changes instead of using the versioning delta tables. This is only available for one-way replicas. This is a required parameter.

Parameters:

archiving - specifies whether to use the archive class to track changes instead of using the versioning delta tables. This is only available for one-way replicas.

getOutChildGeodatabase

public java.lang.Object getOutChildGeodatabase()

Returns the Output Child Workspace parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Child Workspace

getOutputReplicaName

public java.lang.String getOutputReplicaName()

Returns the Output Replica Name parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Replica Name

getToolName

public java.lang.String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public java.lang.String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias