Project Description

The classes

Some notes on class design and implementation

• All page numbers, line numbers and word numbers start from one.
• Do not store data in your class that is dynamic and can be determined at run time. Doing so duplicates the information and risks getting "out of sync". For example, DO NOT store the number of pages in the Document class.
• Accessors don't print error messages.
• Use default parameter values to reduce the number of functions. This is particularly helpful for constructors.
• The Document class gets access to the Dictionary class by storing a pointer to the Dictionary.
• A document may have an unlimited number of pages. A page may have an unlimited number of lines of text. A line of text may have an unlimited number of words. A dictionary may have an unlimitd number of words.
• Creating a Line of text is a two-step process. To get all the words that are on the same line, you must use getline( ) to read a line from the file. To implement most of the operations, you need access to each word in the line of text individually which means that the Line of text wants to store the words in a vector. Both goals are accomplished by using getline( ) and then parsing the line read into separate words which are then placed in a vector. "Parsing" means examining the line word by word. Sample parsing code that you can model can be found in /afs/umbc.edu/users/d/e/dennis/pub/CMSC202/p3/parsing.cpp.

The Document class

1. The title of the document
2. The author of the document
3. Zero or more pages of text
4. A pointer to a Dictionary

   and supports the following operations

5. A default constructor
6. Other constructors that you deem necessary
7. A mutator to store the Dictionary pointer
8. Accessors for
   1. title
   2. author
   3. number of pages in the document
   4. the I-th page of the document
9. The overloaded operator+= that appends a new page to the document.
10. The ability to print the page numbers and line numbers on which a given word occurs.
    Word searching is case-sensitive -- "For" and "for" are different for this function.
11. The ability to print the I-th word on the J-th line of the K-th page.
12. The ability to print all misspelled words indicating each word and where it occurs (page and line number). If the same misspelled word appears multiple times, each occurrence is listed separately. Spellchecking is not case senstive. "For" and "for" are the same for this function.
13. The ability to print itself to the standard output stream.

The Page class

1. the lines of text

   and supports the following operations

2. A default constructor
3. Other constructors that you deem necessary
4. Accessors for
   1. number of lines on the page
   2. number of words on the page
   3. the I-th line on the page
5. The overloaded operator+= that appends a line of text to the page.
6. The ability to print itself to the standard output stream.

The Line-of-Text class

1. Zero or more words that make up the line of text

   and supports the following operations

2. A default constructor
3. Other constructors which you deem necessary
4. Accessors for
   1. The number of words on the line
   2. The K-th word on the line
5. The ability to print itself to the standard output stream.
6. The overloaded operator+= that appends a word to the line of text.

The Dictionary class

1. A list of properly spelled words (which may be empty)

   and supports the following operations

2. A default constructor
3. Other constructors which you deem necessary
4. The ability to determine if a given word is misspelled.

Sample Output

1. Commands and their parameters must be displayed as they are being processed.
2. See the command file description for required output for each command.

The Files

The text file

• The text file used to create the Document contains no punctuation.
• The first line of the file is the title of the Document.
• The second line of the file is the name of the author.
• The end of a page of text is indicated by a blank line or by reaching the end of the text file (EOF).
• Words in the text file may be capitalized.
• The text file may contain an unlimted number of words, or no words at all.

The dictionary file

• The dictionary is a text file which is a list of words in alphabetical order. The words may contain apostrophes (e.g. as in don't) which should require no special coding. Words in the file are separated by whitespace.
• Words in the dictionary may be capitalized.
• The dictionary file may contain an unlimited number of words or no words at all.
• A sample dictionary file named /usr/share/dict/words can be found on the GL Linux system

The command file

• PRINT
  Prints the entire document clearly indicating title and author and number of pages. Each page must be numbered and indicate the number of lines on the page.

• FIND word
  This command prints the page number and line number of all occurrences of the specified word, one per line. If the word is not found, an appropriate error message is displayed.

• SPELLCHECK
  This command runs the spell-checker for the entire document. Each occurrence of a misspelled word is shown including the page number and line number on which the misspelled word occurred. If a misspelled word occurs more than once, each ocurrence is shown on a separate line. A word is considered misspelled if it is not found in the dictionary. Spell checking is not case sensitive. For example, the word "for" in the dictionary matches any combination of upper- and lower-case letters ("For", "FOR", "FoR", "foR", etc).
  If no spelling errors are detected, an appropriate message is displayed.

• PAGE page-number
  Prints the contents of the specified page number. If the specified page does not exist, an appropriate error message is displayed.

• LINE page-number line-number
  Prints the specified line of the specified page. If the specified line or page does not exist, an appropriate error message is displayed.

• WORD page-number line-number word-number
  Prints the word found at the specified location in the document. If the word-, page- or line-number is invalid for the document, an appropriate error message is displayed.

Free Advice and Information

1. Be sure to check that all files are opened properly.
2. Be sure to correctly check for EOF when reading the text file so that blank lines at the end do not cause you to reprocess the last real data line.
3. It's easiest if operator+= is overloaded as member function for the Document, Page and Line classes.
4. If you pass a stream to a function, it must be passed by reference.
5. Copy the makefile from project 2 and modify it for project 3.
6. Develop your classes one at a time and test them. Then try to put them together.
7. After all your classes are done, implement and test the commands one at a time.
8. Don't forget that from the user's point of view (in the command file and in the output), page numbers, line numbers and word numbers are 1-based. That means that some loops in your code may run from 1 to N rather than the usual 0 to N-1.
9. Code for some commands (PAGE, LINE, WORD) is very similar. Get one working, then use it as a model for the others.
10. Code for some methods (Document::Find and Document::SpellCheck) are also similar.
11. Don't forget that variables can be declared locally inside of loops and "if" statements with braces. That will make your code cleaner and even allows you to reuse the same variable name with a different type. Self-sufficient "if" statements are easily converted to functions by cutting and pasting the code.
12. Since the document and the dictionary have capitalized words, spellchecking is NOT case sensitive as described above. Basically this means that if you find a misspelled word, covert all its characters to lowercase and check again. Only if this check also fails is the word truly misspelled. Use the tolower() function to change the case of a character (there is no function to change an entire word all at once.) To use tolower(), #include <cctype>
13. Well structured code and classes will handle empty lines, pages, documents and dictionaries with little or no extra coding.

Project Design Assignment

Project Makefile

For this project, you will be responsible for providing your own makefile. Typing "make" should compile and link all files for your project. Your makefile should also support the commands "make clean" and "make cleanest". If you start with the makefile for project 2, the changes for project 3 are straightforward.

Grading

The grade for this project will be broken down as follows. A more detailed breakdown will be provided in the grade form you recieve with your project grade.

85% - Correctness

• All required output present for each command
• All required output correct for various test files
  Part of the design assignment is to consider what the various test files may contain.
• Incorrect command line (ie wrong number of arguments) handled
• Unopened file detected and handled
• No arrays, vectors only
• Case insensitive spellchecking
• Case sensitive word find
• Proper handling of invalid data in the command file
• Proper OO design and implementation
• Empty document, page, dictionary

15% - Coding Standards