Class CodeFileProcessor

java.lang.Object

CodeFileProcessor

public class CodeFileProcessor
extends java.lang.Object

Project 3, CS 2334, Section 010, March 8, 2017

This class provides helper methods to read a code file and turn it into a map from ints to Strings.

Note that the field codeMap and all methods in this class are static because we don't need to make several codeFileProcessor objects and have them maintain their own maps of codes. Instead, we simply need a collection of useful methods to create a map and return it to the calling method that will keep track of it.

Version:

1.0

Author:

Dean Hougen

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.Map<java.lang.String,java.lang.String>	codeMap

Constructor Summary

Constructors

Constructor and Description
CodeFileProcessor()

Method Summary

Modifier and Type	Method and Description
static java.util.Map<java.lang.String,java.lang.String>	readCodeFile(java.lang.String fileName) The method for reading code files.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

codeMap

private static java.util.Map<java.lang.String,java.lang.String> codeMap

Constructor Detail

CodeFileProcessor

public CodeFileProcessor()

Method Detail

readCodeFile

public static java.util.Map<java.lang.String,java.lang.String> readCodeFile(java.lang.String fileName)
                                                                     throws java.io.IOException

The method for reading code files.

Code files are auxiliary data files for Nooz data files. Code files are comma separated values files that associate code numbers with words. Each line of a code file should contain one numeral followed by one set of words.

Note that the field codeMap and all methods in this class are static because we don't need to make several CodeFileProcessor objects and have them maintain their own lists of codes. Instead, we simply need a collection of useful methods to create a code map and return it to the calling method that will keep track of it. However, this means that when readCodeFile is called, it needs to clear out its map, since the old map data will still be in it. Also, the method that calls readCodeFile will need to make its own copy of the map returned, not simply use a pointer to the returned map.

Note that this program doesn't attempt to deal with I/O errors. This is allowable at this point to keep this project relatively simple and because we haven't covered this topic yet. However, this is something to be refined in the future.

Parameters:

fileName - The name of the Nooz style data file to read.

Returns:

The list of news makers created.

Throws:

java.io.IOException - If there is an I/O problem reading the data file.