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 SDE geodatabase. The Create Replica tool is contained in the Data Management Tools tool box.

Software restrictions: none

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 one way replicas, all datasets must have a globalid column and have a high precision spatial reference.
• In ArcMap the definition query and selection properties set on a layer or table determine what data gets replicated.
• The spatial extent in the environment setting can be used to set the replica geometry. This can be set using another feature classes extent. Only features intersecting the extent will be replicated.
• If spatial extent is specified in the environment setting the full extent of the data is used.
• The default for feature classes is to replicate all features. If filters have been defined (i.e spatial, selection, or definition query), only features that satisfy these filters will be 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 Make Table View; tool for more information.
• For check-out replicas the child replica geodatabase can be an ArcSDE, file or personal geodatabase.
• For two-way and one-way replica the child replica geodatabase must be ArcSDE.
• The re-use schema option is only available for check-out replicas
• The following environment settings affect this tool: workspace; scratch workspace; extent; and Configuration keyword;

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)
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	getExpandFeatureClassesAndTables() Returns the Expand Feature Classes and Tables 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	setExpandFeatureClassesAndTables(java.lang.String expandFeatureClassesAndTables) Sets the Expand Feature Classes and Tables 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)

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 - Feature Layer | Table View | Feature Dataset, the data to be replicated. This list consists of layers and tables referencing versioned, editable data from an ArcSDE geodatabase.

inType - String, cHECK_OUT - data is replicated, edited and checked back in one time.

outGeodatabase - Workspace, the local or remote geodatabase 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 and one-way replicas the child geodatabase must be ArcSDE. For check-out replicas the geodatabase can be personal, file or ArcSDE. If it's a personal or file geodatabase that doesn't exist, it will be created.

outName - String, the name that identifies the replica

Method Detail

getInData

public java.lang.Object getInData()

Returns the Replica Datasets parameter of this tool . This parameter is Feature Layer | Table View | Feature Dataset, 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 Feature Layer | Table View | Feature Dataset, 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 - Feature Layer | Table View | Feature Dataset, 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 String, cHECK_OUT - data is replicated, edited and checked back in one time. 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 String, cHECK_OUT - data is replicated, edited and checked back in one time. This is a required parameter.

Parameters:

inType - String, cHECK_OUT - data is replicated, edited and checked back in one time.

getOutGeodatabase

public java.lang.Object getOutGeodatabase()

Returns the Geodatabase to replicate data to parameter of this tool . This parameter is Workspace, the local or remote geodatabase 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 and one-way replicas the child geodatabase must be ArcSDE. For check-out replicas the geodatabase can be personal, file or ArcSDE. If it's a personal or file geodatabase that doesn't exist, it will be created. 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 Workspace, the local or remote geodatabase 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 and one-way replicas the child geodatabase must be ArcSDE. For check-out replicas the geodatabase can be personal, file or ArcSDE. If it's a personal or file geodatabase that doesn't exist, it will be created. This is a required parameter.

Parameters:

outGeodatabase - Workspace, the local or remote geodatabase 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 and one-way replicas the child geodatabase must be ArcSDE. For check-out replicas the geodatabase can be personal, file or ArcSDE. If it's a personal or file geodatabase that doesn't exist, it will be created.

getOutName

public java.lang.String getOutName()

Returns the Replica Name parameter of this tool . This parameter is String, 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 String, the name that identifies the replica This is a required parameter.

Parameters:

outName - String, the name that identifies the replica

getAccessType

public java.lang.String getAccessType()

Returns the Replica Access Type parameter of this tool . This parameter is String, sIMPLE - the data on the child is not versioned and must be simple. This allows the replica to be interoperable. 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 String, sIMPLE - the data on the child is not versioned and must be simple. This allows the replica to be interoperable. This is an optional parameter.

Parameters:

accessType - String, sIMPLE - the data on the child is not versioned and must be simple. This allows the replica to be interoperable.

getInitialDataSender

public java.lang.String getInitialDataSender()

Returns the Initial Data Sender parameter of this tool . This parameter is String, 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 String, 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 - String, 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 String, dO_NOT_ADD - doesn't add expanded feature classes and tables 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 String, dO_NOT_ADD - doesn't add expanded feature classes and tables This is an optional parameter.

Parameters:

expandFeatureClassesAndTables - String, dO_NOT_ADD - doesn't add expanded feature classes and tables

getReuseSchema

public java.lang.String getReuseSchema()

Returns the Re-use Schema parameter of this tool . This parameter is String, 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 String, 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 - String, 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.

• DO_NOT_REUSE—Do not reuse schema. This is the default.
• REUSE—Reuse schema.

getGetRelatedData

public java.lang.String getGetRelatedData()

Returns the Replicate Related Data parameter of this tool . This parameter is String, 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 String, 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 - String, 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.

• DO_NOT_GET_RELATED—Do not replicate related rows.
• GET_RELATED—Replicate related data. This is the default.

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