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

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

All Implemented Interfaces:

GPTool

public class Compact
extends AbstractGPTool

Compacts a personal or file geodatabase. Compacting rearranges how the geodatabase is stored on disk, often reducing its size and improving performance. The Compact tool is contained in the Data Management Tools tool box.

Usage tips:

• It is recommended to compact personal geodatabases when they become larger than 250 MB.
• If data entry, deletion, or general editing is frequently performed on a database, the database should be regularly compacted to ensure optimal performance.
• If a database is open in ArcMap for editing, it cannot be compacted. To compact the database, remove any layers with a source table or feature class in that database from the Table of Contents.
• Personal and file geodatabases are stored as binary files on a disk drive. As data is added, removed, or edited, these files become fragmented, decreasing overall database performance. The Compact tool is used to rearrange how the database is stored on disk by defragmenting these binary files, reducing the database's size on disk and improving database performance.

Field Summary

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

vals

Constructor Summary

Compact()
Creates the Compact tool with defaults.

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

Method Summary

Object	getInWorkspace() Returns the Input File or Personal Geodatabase 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 File or Personal Geodatabase 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

Compact

public Compact()

Creates the Compact tool with defaults.

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

Compact

public Compact(Object inWorkspace)

Creates the Compact 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 personal or file geodatabase to be compacted.

Method Detail

getInWorkspace

public Object getInWorkspace()

Returns the Input File or Personal Geodatabase parameter of this tool . This parameter is the personal or file geodatabase to be compacted. This is a required parameter.

Returns:

the Input File or Personal Geodatabase

setInWorkspace

public void setInWorkspace(Object inWorkspace)

Sets the Input File or Personal Geodatabase parameter of this tool . This parameter is the personal or file geodatabase to be compacted. This is a required parameter.

Parameters:

inWorkspace - the personal or file geodatabase to be compacted.

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