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

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

All Implemented Interfaces:

GPTool

public class CompressFileGeodatabaseData
extends AbstractGPTool

Compresses all the contents in a geodatabase, all the contents in a feature dataset, or an individual stand-alone feature class or table. The Compress File Geodatabase Data tool is contained in the Data Management Tools tool box.

Usage tips:

• Once compressed, a feature class or table is read-only and cannot be edited. Compression is ideally suited to mature datasets that do not require further editing. However, if required, a compressed dataset can always be uncompressed to return it to its original, read-write format.
• When you compress a geodatabase, all feature classes and tables within it compress.
• When you compress a feature dataset, all its feature classes compress.
• When you specify a geodatabase as input, this tool compresses all vector feature classes and tables in the geodatabase. It does not compress raster catalogs or raster datasets. If it encounters these in the specified geodatabase, it skips over them. You can individually compress a raster catalog or raster dataset with this tool; however, it makes little sense since the data does not reduce in size. This support is provided strictly as a means to allow ArcPublisher to package to compressed and locked file geodatabase raster catalogs and datasets.
• You cannot individually compress or uncompress a feature class in a feature dataset to produce a mixed state where some feature classes are compressed and others are not. Compressed feature datasets allow you to add an uncompressed feature class through operations such as creating a new, empty feature class, copying and pasting, and importing. However, you cannot edit the uncompressed feature class if there are compressed feature classes in the same feature dataset. Once you've finished adding one or more uncompressed feature classes, you can recompress or uncompress the feature dataset so all its feature classes are either compressed or uncompressed.
• When you display compressed feature class records in ArcCatalog or ArcMap, they may not display in the same order as they did before you compressed the data. The records display in the order in which they are compressed and stored.

Field Summary

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

vals

Constructor Summary

CompressFileGeodatabaseData()
Creates the Compress File Geodatabase Data tool with defaults.

CompressFileGeodatabaseData(Object inData)
Creates the Compress File Geodatabase Data tool with the required parameters.

Method Summary

Object	getInData() Returns the Input file geodatabase data parameter of this tool .
Object	getOutData() Returns the Compressed data 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	setInData(Object inData) Sets the Input file geodatabase data 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

CompressFileGeodatabaseData

public CompressFileGeodatabaseData()

Creates the Compress File Geodatabase Data tool with defaults.

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

CompressFileGeodatabaseData

public CompressFileGeodatabaseData(Object inData)

Creates the Compress File Geodatabase Data 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 - the geodatabase, feature dataset, feature class, or table to compress.

Method Detail

getInData

public Object getInData()

Returns the Input file geodatabase data parameter of this tool . This parameter is the geodatabase, feature dataset, feature class, or table to compress. This is a required parameter.

Returns:

the Input file geodatabase data

setInData

public void setInData(Object inData)

Sets the Input file geodatabase data parameter of this tool . This parameter is the geodatabase, feature dataset, feature class, or table to compress. This is a required parameter.

Parameters:

inData - the geodatabase, feature dataset, feature class, or table to compress.

getOutData

public Object getOutData()

Returns the Compressed data parameter of this tool (Read only). This is an derived parameter.

Returns:

the Compressed data

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