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

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

All Implemented Interfaces:

GPTool

public class UnregisterAsVersioned
extends AbstractGPTool

Unregisters an ArcSDE dataset as versioned. The Unregister As Versioned tool is contained in the Data Management Tools tool box.

Usage tips:

• Versioning tools only work with ArcSDE data. File and personal geodatabases do not support versioning.
• Unregistering a dataset as versioned without first compressing the geodatabase could lead to loss of edited data.
  • To improve database performance, the database should be compressed periodically. Compressing the database removes all unreferenced database states and redundant rows. Only the SDE administrator can perform this task.
  • After compressing the database or editing the data, the tool should be executed to update the database statistics for each dataset or feature class. This will improve display and query performance.
• Versions are not affected by changes occurring in other versions of the database.

Field Summary

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

vals

Constructor Summary

UnregisterAsVersioned()
Creates the Unregister As Versioned tool with defaults.

UnregisterAsVersioned(Object inDataset)
Creates the Unregister As Versioned tool with the required parameters.

Method Summary

String	getCompressDefault() Returns the Compress all edits in the Default version into the base table parameter of this tool .
Object	getInDataset() Returns the Input Dataset parameter of this tool .
String	getKeepEdit() Returns the Keep any edits parameter of this tool .
Object	getOutDataset() Returns the Output Dataset parameter of this tool (Read only).
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	setCompressDefault(String compressDefault) Sets the Compress all edits in the Default version into the base table parameter of this tool .
void	setInDataset(Object inDataset) Sets the Input Dataset parameter of this tool .
void	setKeepEdit(String keepEdit) Sets the Keep any edits 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

UnregisterAsVersioned

public UnregisterAsVersioned()

Creates the Unregister As Versioned tool with defaults.

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

UnregisterAsVersioned

public UnregisterAsVersioned(Object inDataset)

Creates the Unregister As Versioned 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:

inDataset - name of the ArcSDE dataset to be unregistered as versioned.

Method Detail

getInDataset

public Object getInDataset()

Returns the Input Dataset parameter of this tool . This parameter is name of the ArcSDE dataset to be unregistered as versioned. This is a required parameter.

Returns:

the Input Dataset

setInDataset

public void setInDataset(Object inDataset)

Sets the Input Dataset parameter of this tool . This parameter is name of the ArcSDE dataset to be unregistered as versioned. This is a required parameter.

Parameters:

inDataset - name of the ArcSDE dataset to be unregistered as versioned.

getKeepEdit

public String getKeepEdit()

Returns the Keep any edits parameter of this tool . This parameter is specifies whether edits made of the version should be maintained. This is an optional parameter.

Returns:

the Keep any edits

setKeepEdit

public void setKeepEdit(String keepEdit)

Sets the Keep any edits parameter of this tool . This parameter is specifies whether edits made of the version should be maintained. This is an optional parameter.

Parameters:

keepEdit - specifies whether edits made of the version should be maintained.

getCompressDefault

public String getCompressDefault()

Returns the Compress all edits in the Default version into the base table parameter of this tool . This parameter is determines whether edits will be compressed and unused data will be removed. This is an optional parameter.

Returns:

the Compress all edits in the Default version into the base table

setCompressDefault

public void setCompressDefault(String compressDefault)

Sets the Compress all edits in the Default version into the base table parameter of this tool . This parameter is determines whether edits will be compressed and unused data will be removed. This is an optional parameter.

Parameters:

compressDefault - determines whether edits will be compressed and unused data will be removed.

getOutDataset

public Object getOutDataset()

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

Returns:

the Output Dataset

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