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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by 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: ArcInfo and ArcEditor only

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
CreateReplica()
          Creates the Create Replica tool with defaults.
CreateReplica(Object inData, String inType, Object outGeodatabase, String outName)
          Creates the Create Replica tool with the required parameters.
 
Method Summary
 String getAccessType()
          Returns the Replica Access Type parameter of this tool .
 String getExpandFeatureClassesAndTables()
          Returns the Expand Feature Classes and Tables parameter of this tool .
 String getGetRelatedData()
          Returns the Replicate Related Data parameter of this tool .
 Object getInData()
          Returns the Replica Datasets parameter of this tool .
 String getInitialDataSender()
          Returns the Initial Data Sender parameter of this tool .
 String getInType()
          Returns the Replica Type parameter of this tool .
 Object getOutChildGeodatabase()
          Returns the Output Child Workspace parameter of this tool (Read only).
 Object getOutGeodatabase()
          Returns the Geodatabase to replicate data to parameter of this tool .
 String getOutName()
          Returns the Replica Name parameter of this tool .
 String getOutputReplicaName()
          Returns the Output Replica Name parameter of this tool (Read only).
 String getReuseSchema()
          Returns the Re-use Schema 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 setAccessType(String accessType)
          Sets the Replica Access Type parameter of this tool .
 void setExpandFeatureClassesAndTables(String expandFeatureClassesAndTables)
          Sets the Expand Feature Classes and Tables parameter of this tool .
 void setGetRelatedData(String getRelatedData)
          Sets the Replicate Related Data parameter of this tool .
 void setInData(Object inData)
          Sets the Replica Datasets parameter of this tool .
 void setInitialDataSender(String initialDataSender)
          Sets the Initial Data Sender parameter of this tool .
 void setInType(String inType)
          Sets the Replica Type parameter of this tool .
 void setOutGeodatabase(Object outGeodatabase)
          Sets the Geodatabase to replicate data to parameter of this tool .
 void setOutName(String outName)
          Sets the Replica Name parameter of this tool .
 void setReuseSchema(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(Object inData,
                     String inType,
                     Object outGeodatabase,
                     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 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(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 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(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 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(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 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(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 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(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 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(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 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(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 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(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.

getGetRelatedData

public 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(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.

getOutChildGeodatabase

public 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 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 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