Class IndexMaker

java.lang.Object

IndexMaker

public class IndexMaker
extends java.lang.Object

This class reads an input file and writes to an output file an index of that input file using the IndexEntry and DocumentIndex classes. If the class is provided both the input and output file as arguments, it will utilize them as given. However, if the class is provided only the input file as an argument, it will generate an output file with a name that takes the input file's name and adds Index before the extension e.g. input file "hello.txt" would generate an output file named "helloIndex.txt" if an output file name was not provided. If neither file is provided through run arguments, the program asks the user to input them through the console. The main method mainly takes in the files and checks that they exist before utilizing the two other methods of the class: createIndex and writeIndexToFile. The method createIndex takes in an input file name, checks if it exists and, if not, asks the user to either exit or give an existing file, and then generates and returns a DocumentIndex that serves as the index referenced in the main method. The method writeIndexToFile takes in an output file name and a DocumentIndex and writes the index to that output file. If the output file does not exist, the method creates one.

Author:

AnneMarie Caballero

Constructor Summary

Constructors

Constructor	Description
IndexMaker()

Method Summary

Modifier and Type	Method	Description
static DocumentIndex	createIndex(java.lang.String inputName)	The createIndex method checks if the file given by inputName exists, and, if it does, uses that file to generate a DocumentIndex that it then returns.
static void	main(java.lang.String[] args)	The main method takes in the run arguments, and accounts for if some are missing.
static void	writeIndexToFile(java.lang.String outputName, DocumentIndex index)	The writeIndexToFile method will write the index provided to the file with name outputName or will generate that file with name outputName and then write the index to it.

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexMaker

public IndexMaker()

Method Detail

main

public static void main(java.lang.String[] args)

The main method takes in the run arguments, and accounts for if some are missing. If there are two run arguments, the first is the input file and the second is the output file. If there is one run argument, the input file name will be used to generate the output file name. If there are no arguments, the user will be asked to provide both the input and output file name. The main method then calls the createIndex and writeIndexToFile methods.

Parameters:

args - run arguments provided in a String[]

createIndex

public static DocumentIndex createIndex(java.lang.String inputName)

The createIndex method checks if the file given by inputName exists, and, if it does, uses that file to generate a DocumentIndex that it then returns. If the file does not exist, the program will ask the user to provide a file that does work until either the file provided exists or the user exits the program.

Parameters:

inputName - the name of the input file used to generate the DocumentIndex

Returns:

DocumentIndex that is created using the file with name inputName

writeIndexToFile

public static void writeIndexToFile(java.lang.String outputName,
                                    DocumentIndex index)
                             throws java.io.IOException

The writeIndexToFile method will write the index provided to the file with name outputName or will generate that file with name outputName and then write the index to it.

Parameters:

outputName - the String value representing the name of the output file to be written to or created then written to

index - the DocumentIndex that holds the index to be written to the output file

Throws:

java.io.IOException - if an error occurs with the PrintWriter