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

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

All Implemented Interfaces:

GPTool

public class Compress
extends AbstractGPTool

Compresses an ArcSDE geodatabase by removing states not referenced by a version and redundant rows. The Compress tool is contained in the Data Management Tools tool box.

Usage tips:

• When you delete a record from a database, it is only marked as deleted; it is not actually removed from the associated table. Therefore, the table will remain the same size after you delete records. To actually remove deleted records from the database, you must compress the database.
• To improve database performance, the database should be compressed periodically.
• A compressed database is more efficient. A database that is never compressed is more likely to develop errors.
• Once a database is compressed, deleted records cannot be recovered.
• Compression of databases not only reduces space requirements but can also reduce overall retrieval times.
• When the Compress tool is executed, the database is unavailable until compression is completed.
• Only the SDE administrator can perform compression.

Field Summary

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

vals

Constructor Summary

Compress()
Creates the Compress tool with defaults.

Compress(Object inWorkspace)
Creates the Compress tool with the required parameters.

Method Summary

Object	getInWorkspace() Returns the Input Workspace parameter of this tool .
Object	getOutWorkspace() Returns the Output Workspace 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	setInWorkspace(Object inWorkspace) Sets the Input Workspace 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

Compress

public Compress()

Creates the Compress tool with defaults.

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

Compress

public Compress(Object inWorkspace)

Creates the Compress 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:

inWorkspace - the ArcSDE database to be compressed.

Method Detail

getInWorkspace

public Object getInWorkspace()

Returns the Input Workspace parameter of this tool . This parameter is the ArcSDE database to be compressed. This is a required parameter.

Returns:

the Input Workspace

setInWorkspace

public void setInWorkspace(Object inWorkspace)

Sets the Input Workspace parameter of this tool . This parameter is the ArcSDE database to be compressed. This is a required parameter.

Parameters:

inWorkspace - the ArcSDE database to be compressed.

getOutWorkspace

public Object getOutWorkspace()

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

Returns:

the Output Workspace

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