Lecture 5 Text File I/O; Parsing

File I/O Databases are the most efficient way to store large amounts of structured data, and accordingly, most live applications use databases for permanent data storage Right now, we are mostly interested in the exceptions to this rule: Applications such as word processors and spreadsheets, whose purpose is to generate specially-formatted documents using data that is not easily converted to database records. Data that must be exchanged easily among many users who don’t necessarily have access to the same DBMS, e.g. information publicly available on the internet 2

The File Class The File class provides an abstraction that deals with most of the machine-dependent complexities of files and path names in a machine-independent fashion. The filename is a string. The File class is a wrapper class for the file name and its directory path. 3

Obtaining file properties and manipulating files 4

File I/O Two types of files are used for I/O Binary Files: to be covered later in CS202 or in CS203 Text Files Data can be read from text files that are rigorously structured. Two common cases: XML (various forms of eXtensible Markup Language) CSV (Comma-Separated Values) 5

Text File I/O Data is stored as text, but we need objects and/or primitive data types Read in strings Parse to the data types you need Use logic to translate the parsed data to the data fields you need Labor-intensive and error prone, yet necessary where data must be widely available for different applications 6

Reading Data Using Scanner 7

Writing Data Using PrintWriter 8

Writing Data Using PrintWriter Get fields called CIN and grade from a list of Student objects and write them to a csv file using a PrintWriter for (Student s: students){ writer.println(s.getCIN() + "," + s.getGrade()); } 9

BufferedWriter A type of PrintWriter that writes data in chunks, rather than one character at a time Set aside a memory buffer, fill it with data, then write it all out, and repeat until finished. This uses system resources more efficiently because writing to the file involves overhead that is not proportional to the amount of data written. Reducing the number of writes makes the process less expensive. 10

Throws/Catch Declaring an exception type with the throws keyword in a method header throws the exception to the calling method, where it must be caught You can also set custom circumstances for an exception using throw(), usually in an if block: throw new NullPointerException( "This will be caught below" ); 12

File Copy 13 import java.io.*; import java.util.*; public class TextFileCopier { public static void main(String args[]) { //... Get two file names from user. System.out.println("Enter a filepath to copy from, and one to copy to."); Scanner in = new Scanner(System.in); //... Create File objects. File inFile = new File(in.next()); // File to read from. File outFile = new File(in.next()); // File to write to //... Enclose in try..catch because of possible io exceptions. try { copyFile(inFile, outFile); } catch (IOException e) { System.err.println(e); System.exit(1); } public static void copyFile(File fromFile, File toFile) throws IOException { Scanner freader = new Scanner(fromFile); BufferedWriter writer = new BufferedWriter(new FileWriter(toFile)); //... Loop as long as there are input lines. String line = null; while (freader.hasNextLine()) { line = freader.nextLine(); writer.write(line); writer.newLine(); //... Close reader and writer. freader.close(); writer.close(); 13

Parsing Parse Definitions From Wiktionary: 1. (linguistics) To resolve into its elements, as a sentence, pointing out the several parts of speech, and their relation to each other by government or agreement; to analyze and describe grammatically. 2. (computing) To split a file or other input into pieces of data that can be easily stored or manipulated. 14

Parsing Parsing input is a common problem in programming. In Object-Oriented Programming, parsing usually involves converting input into individual values which are then used to supply data for variables in objects. This is the first way we will use file storage in our programs. 15

Parse a CSV file package demos; public class Lect4Student{ private String name; private double grade; public Lect4Student(String nameIn, double gradeIn){ name = nameIn; grade = gradeIn; } public String getName(){ return name; public double getGrade(){ return grade; public String toString(){ return(name + " received grade: " + grade); 17

Parse a CSV file package demos; import java.io.File; import java.io.IOException; import java.util.ArrayList; import java.util.List; import java.util.Scanner; public class StudentParser { private List<Lect4Student> students = new ArrayList<Lect4Student>(); public void showGrades() { for (Lect4Student s : students) { System.out.println(s.toString()); } showAverage(); public int findByName(String name) { for (int counter = 0; counter < students.size(); counter++) { if (students.get(counter).getName().equals(name)) return counter; return -1; public void showAverage() { double total = 0; for (Lect4Student stu : students) total += stu.getGrade(); System.out.println("Class Average: " + total / students.size()); public void readFile() throws IOException { try { System.out.println("Enter a filepath to read from "); Scanner in = new Scanner(System.in); File inFile = new File(in.next()); // File to read from. Scanner freader = new Scanner(inFile); freader.nextLine(); // skip the header String line; String[] fields; String name; double grade; while (freader.hasNextLine()) { line = freader.nextLine(); fields = line.split(","); name = fields[0]; grade = Double.parseDouble(fields[1]); students.add(new Lect4Student(name, grade)); freader.close(); // Close to unlock. in.close(); } catch (IOException e) { System.err.println(e); System.exit(1); 18

Parse a CSV file public void showAverage() { double total = 0; for (Lect4Student stu : students) total += stu.getGrade(); System.out.println("Class Average: " + total / students.size()); } public void readFile() { try { System.out.println("Enter a filepath to read from "); Scanner in = new Scanner(System.in); File inFile = new File(in.next()); // File to read from. Scanner freader = new Scanner(inFile); freader.nextLine(); // skip the header String line; String[] fields; String name; double grade; while (freader.hasNextLine()) { line = freader.nextLine(); fields = line.split(","); name = fields[0]; grade = Double.parseDouble(fields[1]); students.add(new Lect4Student(name, grade)); freader.close(); // Close to unlock. in.close(); } catch (IOException e) { System.err.println(e); System.exit(1); 19

Parse a CSV file while (freader.hasNextLine()) { line = freader.nextLine(); fields = line.split(","); name = fields[0]; grade = Double.parseDouble(fields[1]); students.add(new Lect4Student(name, grade)); } freader.close(); // Close to unlock. in.close(); } catch (IOException e) { System.err.println(e); System.exit(1); 20

Parse a CSV file package demos; public class ParseDemo { public static void main(String args[]) { StudentParser parser = new StudentParser(); parser.readFile(); parser.showGrades(); System.out.println(); String name = "Dennis"; int location = parser.findByName(name); if (location == -1) System.out.println(name + " not found"); else System.out.println(name + " found at index " + location); } 21

Parse a CSV file This technique is not very robust, and it requires tedious coding to write and maintain. Any change in the file format or the type of data we need to parse requires recoding our classes. Solutions: Take everything but the basic parsing functions out of parser. Use parser with other classes that can be supplied arbitrarily and provide the file format info and the type of class to parse to. Adjusting the parser to work with different file formats only involves writing new classes that contain only format-specific information. 2) Binary File I/O Java has built in methods to save entire objects to file and read them back into your application when needed Structure of object is maintained No need to do any parsing or mapping of data fields Taught later in CS 202 22

Composition Compose: to create something by combining other things In programming, Composition occurs when a class includes variables of other classes We have been doing this all along whenever we write classes that contain Strings or Scanners. Several of the lecture examples have contained variables that referred to objects of classes defined in the examples. GradeBook contains an array list of Students Driver from lecture 5 contained a College, which contained a list of Departments, and each department contained an array list of Courses Hierarchies like this can be of any depth.

Desk Check Desk checking or desk tracing is the technique of executing code manually, with paper and pencil. Trace table: a table used to keep track of data values during a desk check (example from Wikipedia) int i, x = 0; for (i = 1; i <= 10; i++) { x = i * 2; }