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

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

All Implemented Interfaces:

GPTool

public class FileCompare
extends AbstractGPTool

Compares two files and returns the comparison results. File Compare can report differences between two ASCII files or two binary files. The File 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.
• This tool supports masking out of characters, words, and lines of text in an ASCII file. For example, files may be identical except they may contain text representing date and time of creation. Thus, the files would miscompare. In addition, small variations occur in the way that each platform stores or manipulates numbers. This leads to differences in numeric precision among platforms. The SunOS platform may report a value of 415.999999999, while the Windows XP platform reports 416.000000000. To handle false character comparisons, File Compare provides several masking capabilities. Before comparing new text files with existing base files, edit the base files to include these special masking symbols.
• ASCII is the default file type. If entering BINARY files, change the file type to BINARY.
• When ASCII files miscompare, it will report differences, such as the total number of characters are different and report the differences for each line.
• When BINARY files miscompare, it will report that the file sizes are different and report the differences for each byte.
• The Output Compare File will contain all similarities and differences between the Input Base File and the Input Test File. This file is a comma-delimited text file which can be viewed and used as a table in ArcGIS.
• 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

FileCompare()
Creates the File Compare tool with defaults.

FileCompare(Object inBaseFile, Object inTestFile)
Creates the File Compare tool with the required parameters.

Method Summary

String	getCompareStatus() Returns the Compare Status parameter of this tool (Read only).
String	getContinueCompare() Returns the Continue Comparison parameter of this tool .
String	getFileType() Returns the File Type parameter of this tool .
Object	getInBaseFile() Returns the Input Base File parameter of this tool .
Object	getInTestFile() Returns the Input Test File parameter of this tool .
Object	getOutCompareFile() Returns the Output Compare File 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	setContinueCompare(String continueCompare) Sets the Continue Comparison parameter of this tool .
void	setFileType(String fileType) Sets the File Type parameter of this tool .
void	setInBaseFile(Object inBaseFile) Sets the Input Base File parameter of this tool .
void	setInTestFile(Object inTestFile) Sets the Input Test File parameter of this tool .
void	setOutCompareFile(Object outCompareFile) Sets the Output Compare File 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

FileCompare

public FileCompare()

Creates the File Compare tool with defaults.

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

FileCompare

public FileCompare(Object inBaseFile,
                   Object inTestFile)

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

inBaseFile - the Input Base File is compared with the Input Test File. The Input Base File refers to afile that you have declared valid. This base file has the correct content and information.

inTestFile - the Input Test File is compared against the Input Base File. The Input Test File refers to afile that you have made changes to by editing or compiling new information.

Method Detail

getInBaseFile

public Object getInBaseFile()

Returns the Input Base File parameter of this tool . This parameter is the Input Base File is compared with the Input Test File. The Input Base File refers to afile that you have declared valid. This base file has the correct content and information. This is a required parameter.

Returns:

the Input Base File

setInBaseFile

public void setInBaseFile(Object inBaseFile)

Sets the Input Base File parameter of this tool . This parameter is the Input Base File is compared with the Input Test File. The Input Base File refers to afile that you have declared valid. This base file has the correct content and information. This is a required parameter.

Parameters:

inBaseFile - the Input Base File is compared with the Input Test File. The Input Base File refers to afile that you have declared valid. This base file has the correct content and information.

getInTestFile

public Object getInTestFile()

Returns the Input Test File parameter of this tool . This parameter is the Input Test File is compared against the Input Base File. The Input Test File refers to afile that you have made changes to by editing or compiling new information. This is a required parameter.

Returns:

the Input Test File

setInTestFile

public void setInTestFile(Object inTestFile)

Sets the Input Test File parameter of this tool . This parameter is the Input Test File is compared against the Input Base File. The Input Test File refers to afile that you have made changes to by editing or compiling new information. This is a required parameter.

Parameters:

inTestFile - the Input Test File is compared against the Input Base File. The Input Test File refers to afile that you have made changes to by editing or compiling new information.

getFileType

public String getFileType()

Returns the File Type parameter of this tool . This parameter is the type of files being compared. This is an optional parameter.

Returns:

the File Type

setFileType

public void setFileType(String fileType)

Sets the File Type parameter of this tool . This parameter is the type of files being compared. This is an optional parameter.

Parameters:

fileType - the type of files being compared.

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 File and the Input Test File. 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 File and the Input Test File. 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 File and the Input Test File. 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