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

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

All Implemented Interfaces:

GPTool

public class TableCompare
extends AbstractGPTool

Compares two tables or table views and returns the comparison results. This tool can report differences and similarities with tabular values and field definitions. The Table Compare tool is contained in the Data Management Tools tool box.

Usage tips:

• The tool returns messages showing the comparison result. By default, the tool will stop executing after encountering the first miscompare. To report all differences, set the continue compare option to true.
• Multiple sort fields may be specified. Both the Input Base Table and Input Test Table are sorted based on the fields you specify. The first field is sorted, then the second field, and so on, in ascending order. Sorting by a common field in both the base and test table ensures that you are comparing the same row from each input dataset.
• By default the compare type is set to ALL. This means all properties of the tables being compared will be checked, including such things as field properties and attributes. However, you may choose a different compare type to check only specific properties of the tables being compared.
• The Ignore Options provide the flexibility to omit properties from the comparison. These properties include extension properties, , and .
• When omitting fields that are not included in the field count comparison, and the field definitions and tabular values for those fields are ignored.
• Attribute tolerances can only be specified for numeric field types.
• The Output Compare File will contain all similarities and differences between the Input Base Table and the Input Test Table. This file is a comma-delimited text file which can be viewed and used as a table in ArcGIS. For example, this table can be queried to obtain all the ObjectID values for all the rows that are different.
• The comparison tools will be 'true' when no differences are found and 'false' when differences are detected.

Field Summary

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

vals

Constructor Summary

TableCompare()
Creates the Table Compare tool with defaults.

TableCompare(Object inBaseTable, Object inTestTable, Object sortField)
Creates the Table Compare tool with the required parameters.

Method Summary

Object	getAttributeTolerances() Returns the Attribute Tolerance parameter of this tool .
String	getCompareStatus() Returns the Compare Status parameter of this tool (Read only).
String	getCompareType() Returns the Compare Type parameter of this tool .
String	getContinueCompare() Returns the Continue Comparison parameter of this tool .
Object	getIgnoreOptions() Returns the Ignore Options parameter of this tool .
Object	getInBaseTable() Returns the Input Base Table parameter of this tool .
Object	getInTestTable() Returns the Input Test Table parameter of this tool .
Object	getOmitField() Returns the Omit Fields parameter of this tool .
Object	getOutCompareFile() Returns the Output Compare File parameter of this tool .
Object	getSortField() Returns the Sort Field 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	setAttributeTolerances(Object attributeTolerances) Sets the Attribute Tolerance parameter of this tool .
void	setCompareType(String compareType) Sets the Compare Type parameter of this tool .
void	setContinueCompare(String continueCompare) Sets the Continue Comparison parameter of this tool .
void	setIgnoreOptions(Object ignoreOptions) Sets the Ignore Options parameter of this tool .
void	setInBaseTable(Object inBaseTable) Sets the Input Base Table parameter of this tool .
void	setInTestTable(Object inTestTable) Sets the Input Test Table parameter of this tool .
void	setOmitField(Object omitField) Sets the Omit Fields parameter of this tool .
void	setOutCompareFile(Object outCompareFile) Sets the Output Compare File parameter of this tool .
void	setSortField(Object sortField) Sets the Sort Field 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

TableCompare

public TableCompare()

Creates the Table Compare tool with defaults.

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

TableCompare

public TableCompare(Object inBaseTable,
                    Object inTestTable,
                    Object sortField)

Creates the Table Compare 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:

inBaseTable - the Input Base Table is compared with the Input Test Table. The Input Base Table refers to tabular data that you have declared valid. This base data has the correct field definitions and attribute values.

inTestTable - the Input Test Table is compared against the Input Base Table. The Input Test Table refers to data that you have made changes to by editing or compiling new fields, new records, or new attribute values.

sortField - the field or fields used to sort records in the Input Base Table and the Input Test Table. The records are sorted in ascending order. Sorting by a common field in both the Input Base Table and the Input Test Table ensures that you are comparing the same row from each input dataset.

Method Detail

getInBaseTable

public Object getInBaseTable()

Returns the Input Base Table parameter of this tool . This parameter is the Input Base Table is compared with the Input Test Table. The Input Base Table refers to tabular data that you have declared valid. This base data has the correct field definitions and attribute values. This is a required parameter.

Returns:

the Input Base Table

setInBaseTable

public void setInBaseTable(Object inBaseTable)

Sets the Input Base Table parameter of this tool . This parameter is the Input Base Table is compared with the Input Test Table. The Input Base Table refers to tabular data that you have declared valid. This base data has the correct field definitions and attribute values. This is a required parameter.

Parameters:

inBaseTable - the Input Base Table is compared with the Input Test Table. The Input Base Table refers to tabular data that you have declared valid. This base data has the correct field definitions and attribute values.

getInTestTable

public Object getInTestTable()

Returns the Input Test Table parameter of this tool . This parameter is the Input Test Table is compared against the Input Base Table. The Input Test Table refers to data that you have made changes to by editing or compiling new fields, new records, or new attribute values. This is a required parameter.

Returns:

the Input Test Table

setInTestTable

public void setInTestTable(Object inTestTable)

Sets the Input Test Table parameter of this tool . This parameter is the Input Test Table is compared against the Input Base Table. The Input Test Table refers to data that you have made changes to by editing or compiling new fields, new records, or new attribute values. This is a required parameter.

Parameters:

inTestTable - the Input Test Table is compared against the Input Base Table. The Input Test Table refers to data that you have made changes to by editing or compiling new fields, new records, or new attribute values.

getSortField

public Object getSortField()

Returns the Sort Field parameter of this tool . This parameter is the field or fields used to sort records in the Input Base Table and the Input Test Table. The records are sorted in ascending order. Sorting by a common field in both the Input Base Table and the Input Test Table ensures that you are comparing the same row from each input dataset. This is a required parameter.

Returns:

the Sort Field

setSortField

public void setSortField(Object sortField)

Sets the Sort Field parameter of this tool . This parameter is the field or fields used to sort records in the Input Base Table and the Input Test Table. The records are sorted in ascending order. Sorting by a common field in both the Input Base Table and the Input Test Table ensures that you are comparing the same row from each input dataset. This is a required parameter.

Parameters:

sortField - the field or fields used to sort records in the Input Base Table and the Input Test Table. The records are sorted in ascending order. Sorting by a common field in both the Input Base Table and the Input Test Table ensures that you are comparing the same row from each input dataset.

getCompareType

public String getCompareType()

Returns the Compare Type parameter of this tool . This parameter is the comparison type. ALL is the default. The default will compare all properties of the tables being compared. This is an optional parameter.

Returns:

the Compare Type

setCompareType

public void setCompareType(String compareType)

Sets the Compare Type parameter of this tool . This parameter is the comparison type. ALL is the default. The default will compare all properties of the tables being compared. This is an optional parameter.

Parameters:

compareType - the comparison type. ALL is the default. The default will compare all properties of the tables being compared.

getIgnoreOptions

public Object getIgnoreOptions()

Returns the Ignore Options parameter of this tool . This parameter is these properties will not be compared during comparison. This is an optional parameter.

Returns:

the Ignore Options

setIgnoreOptions

public void setIgnoreOptions(Object ignoreOptions)

Sets the Ignore Options parameter of this tool . This parameter is these properties will not be compared during comparison. This is an optional parameter.

Parameters:

ignoreOptions - these properties will not be compared during comparison.

getAttributeTolerances

public Object getAttributeTolerances()

Returns the Attribute Tolerance parameter of this tool . This parameter is the numeric value that determines the range in which attribute values are considered equal. This only applies to numeric field types. This is an optional parameter.

Returns:

the Attribute Tolerance

setAttributeTolerances

public void setAttributeTolerances(Object attributeTolerances)

Sets the Attribute Tolerance parameter of this tool . This parameter is the numeric value that determines the range in which attribute values are considered equal. This only applies to numeric field types. This is an optional parameter.

Parameters:

attributeTolerances - the numeric value that determines the range in which attribute values are considered equal. This only applies to numeric field types.

getOmitField

public Object getOmitField()

Returns the Omit Fields parameter of this tool . This parameter is the field or fields that will be omitted during comparison. The field definitions and the tabular values for these fields will be ignored. This is an optional parameter.

Returns:

the Omit Fields

setOmitField

public void setOmitField(Object omitField)

Sets the Omit Fields parameter of this tool . This parameter is the field or fields that will be omitted during comparison. The field definitions and the tabular values for these fields will be ignored. This is an optional parameter.

Parameters:

omitField - the field or fields that will be omitted during comparison. The field definitions and the tabular values for these fields will be ignored.

getContinueCompare

public String getContinueCompare()

Returns the Continue Comparison parameter of this tool . This parameter is indicates whether to compare all properties after encountering the first mismatch. This is an optional parameter.

Returns:

the Continue Comparison

setContinueCompare

public void setContinueCompare(String continueCompare)

Sets the Continue Comparison parameter of this tool . This parameter is indicates whether to compare all properties after encountering the first mismatch. This is an optional parameter.

Parameters:

continueCompare - indicates whether to compare all properties after encountering the first mismatch.

getOutCompareFile

public Object getOutCompareFile()

Returns the Output Compare File parameter of this tool . This parameter is this file will contain all similarities and differences between the Input Base Table and the Input Test Table. This file is a comma-delimited text file which can be viewed and used as a table in ArcGIS. This is an optional parameter.

Returns:

the Output Compare File

setOutCompareFile

public void setOutCompareFile(Object outCompareFile)

Sets the Output Compare File parameter of this tool . This parameter is this file will contain all similarities and differences between the Input Base Table and the Input Test Table. This file is a comma-delimited text file which can be viewed and used as a table in ArcGIS. This is an optional parameter.

Parameters:

outCompareFile - this file will contain all similarities and differences between the Input Base Table and the Input Test Table. This file is a comma-delimited text file which can be viewed and used as a table in ArcGIS.

getCompareStatus

public String getCompareStatus()

Returns the Compare Status parameter of this tool (Read only). This is an derived parameter.

Returns:

the Compare Status

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