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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by 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.

Software restrictions: none

Usage tips:


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 - File, the Input Base File is compared with the Input Test File. The Input Base File refers to your file that you have declared valid. This base file has the correct content and information.
inTestFile - File, the Input Test File is compared against the Input Base File. The Input Test File refers to your file that you have made changes by editing or compiling new information.
Method Detail

getInBaseFile

public Object getInBaseFile()
Returns the Input Base File parameter of this tool . This parameter is File, the Input Base File is compared with the Input Test File. The Input Base File refers to your file 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 File, the Input Base File is compared with the Input Test File. The Input Base File refers to your file that you have declared valid. This base file has the correct content and information. This is a required parameter.

Parameters:
inBaseFile - File, the Input Base File is compared with the Input Test File. The Input Base File refers to your file 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 File, the Input Test File is compared against the Input Base File. The Input Test File refers to your file that you have made changes 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 File, the Input Test File is compared against the Input Base File. The Input Test File refers to your file that you have made changes by editing or compiling new information. This is a required parameter.

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

getFileType

public String getFileType()
Returns the File Type parameter of this tool . This parameter is String, the type of files being compared. The file types are ASCII and BINARY. ASCII is the default. 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 String, the type of files being compared. The file types are ASCII and BINARY. ASCII is the default. This is an optional parameter.

Parameters:
fileType - String, the type of files being compared. The file types are ASCII and BINARY. ASCII is the default.

getContinueCompare

public String getContinueCompare()
Returns the Continue Comparison parameter of this tool . This parameter is String, 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 String, indicates whether to compare all properties after encountering the first mismatch. This is an optional parameter.

Parameters:
continueCompare - String, 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 File, 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 File, 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 - File, 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