Technical Info

Required Software
Installation Instructions
Test Cases
Running
Release Notes
Beta Information
License Agreement

Required Software

JFileChecker v0.2 requires the Sun Microsystems Java 2 SDK Version 1.4.1 or higher and a relational database that supports connectivity with Java applications.

Installation Instructions

Ensure the Sun Microsystems Java 2 SDK is installed and properly configured and licensed on the machine you plan on running JFileChecker. See http://java.sun.com/j2se/1.4.1/docs/index.html for more information on the Sun Microsystems Java 2 SDK Version 1.4.1.
Ensure the relational database you plan to use is accessible from where JFileChecker is to be loaded and that this database supports connectivity with Java applications.
Extract the JFileChecker application from the tarball.
Edit the DbObj.java file in the extract directory to use java connectivity supported by your database. By default DbObj.java forms a JDBC:ODBC connection to an ODBC datasource named "JFileCheckerDB" with no username or password. A file named DbObj.java.MySQL is included in the JFileChecker installation that gives an example of how the DbObj.java file can be edited to form a straight JDBC connection.
Compile the Java files by running the following command line in the folder where the extracted Java files reside:
```
          javac -classpath . *.java
        
```
If applicable, copy the following Java class files from the extract directory into the directory where JFileChecker will run
- JFileChecker.class
- CheckField.class
- CheckProject.class
- CheckUtils.class
- DbObj.class
- Logger.class
Create the tables outlined in databaseSchema.html in your database. For your convenience, the sql folder of the JFileChecker installation contains the following eight table creation scripts that can be used to create these tables:
- create_check_field.sql
- create_check_project.sql
- create_constraint_type.sql
- create_field_constraint.sql
- create_field_dt_format.sql
- create_field_list.sql
- create_field_type.sql
- create_project_constraint
Populate the field_type table. For your convenience, the sql folder contains the following database script files that can be used to do this for you:
- field_type_1.sql
- field_type_2.sql
- field_type_3.sql
- field_type_4.sql
Populate the constraint_type table. For your convenience, the sql folder contains the following database script files that can be used to do this for you:
- constraint_type_1.sql
- constraint_type_2.sql
Add data file profile information to your database for the type of file(s) JFileChecker will be checking. A functional description of each database field and is outlined in databaseFields.html. For now, you can use some test profile data provided with the JFileChecker installation. See the Testing section below for how to set up two test projects included with the installation.

Test Cases

JFileChecker comes with two default test cases that can be used to ensure everything is installed correctly as well as help you understand more about the JFileChecker database structure. The first test project handles a simple comma delimited file structure and is discussed here. The second test project handles a fixed width file structure and is discussed here.

Running JFileChecker

The command line syntax to run JFileChecker is

      java JFileChecker <project id> <data filename> <log level>

where

project id is the integer id corresponding to the project_id field of the check_project table.
data filename is the name of the file to check. The path should not be specified here since it is specified in the data_path field of the check_project table.
log level is optional, and can be 0,1,2,3, or 4. 0 implies no logging, 4 implies debug/extreme logging. 3 is the default (info logging).

For example, the command lines for running JFileChecker against the test data files in debug mode would be

      java JFileChecker 1 test_1_data_file.csv 4
      java JFileChecker 2 test_2_data_file.dat 4

Be sure the data, log, and result directories for the project at hand (per the check_project table) exist and can have data written to them before running JFileChecker.

Release Notes

For a list of what is new in this release as well as plans for future enhancements, see the Release Notes

Beta Information

JFileChecker has been "alpha" tested on Red Hat Linux 7.2 running MySQL 4.0 and Microsoft Windows XP running Access 2002, but should be able to run on other operating systems connecting to other databases as well. For the duration of the beta releases, feel free to email the author if you have any questions, comments, suggestions, or concerns regarding JFileChecker. After the author deems enough versions have been implemented and tested on a fairly wide range of operating systems and databases, and any major bugs found are fixed, a "production" (non-beta) version will be released.

GNU General Public License

JFileChecker is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

A copy of the GNU General Public License is included with the JFileChecker tarball.

Java is a trademark of Sun Microsystems, Inc. in the United States and other countries.