HW08: Palindromes! due Mon 18 Mar 10:00

Allowed and Disallowed Resources

• The Java Command Sheets handed out in class (and also available here: https://josephus.hsutx.edu/classes/all/commandsheets/).
• Examples and sample code found here: https://josephus.hsutx.edu/classes/p2/source/. NOTE: The same examples can be cloned from this repository: https://tsergeant@bitbucket.org/tsergeant/p2_examples.git
• A Java compiler with or without an IDE. The text editor you use can provide syntax highlighting, but must not generate code.
• Video instructions provided in Canvas as part of this course. You MAY NOT USE any other video resources.
• The course notes that accompany the video instructions which can be found here: https://josephus.hsutx.edu/classes/p2/coursenotes.php
• The official Java Documentation found here: https://docs.oracle.com/en/java/javase/21/
• Any handouts provided by the instructor as part of this course.
• Your own course notes
• Your instructor
• Discussions about the assignment with other students as long as you never look at the code produced by another student and you never receive instructions about solving the homework. That is, discussions need to be about concepts and understanding the technologies and not about how to solve the particular problem posed in this assignment.

You may NOT use/access:

• Resources not expressly listed above, including, but not limited to, the following ...
• Source code not provided as part of this assignment. (Obviously, this includes, but is not limited to, source code written by other students whether current or in the past).
• Code-generating tools (of which ChatGPT is one example).
• Any web sites not directly linked to from the homework assignment.

Failure to abide by these guidelines will result in a zero for the assignment and the incident will be reported to the university provost as a violation of the university academic integrity policy. A second incident of academic dishonesty (whether from this course or another computer science course) will result in an F in the course.

Instructions

Do all of your work in the provided hw08 directory in your homework respository.

Your final program should:

• Accept the name of a file as a command-line parameter. The input file should be assumed to have a series of individual words with one word per line.
• If there is no command-line parameter (or more than one) the program should exit with an appropriate error message.
• For each word determine whether or not the word is a palindrome and display these statistics when complete: total number of words read, total number of palindromes, percentage of words that palindromes compose, the amount of time elapsed to read the file and determine the required values.

Additional requirements:

• The timing of code should make use of a CodeTimer class. You can write your own or use the one that appears in various examples.

• The reading of the data file should use a BufferedReader rather than Scanner.

• Your solution should attempt an object-oriented design. NOTE: My design used a single class in addition to main() and I passed the data file name to the constructor as a parameter. I kept the method from the in-lab assignment as a static method in my class.

• The code that houses main() should be in a file named Driver.java.

• As always use JavaDoc notation for commenting classes and methods and follow Java programming conventions.

For fun you might try to find a large text file that contains a bunch of words (one per line) and see what the statistics look like.

As you work, document your code and commit at appropriate times. When you complete your work be sure to push all committed changes to bitbucket.

Sample Output

+--------------------------------------------+
Input File     : ../data/smallwords.txt
Words Processed: 13
# Palindromes  : 4
% Palindromes  : 30.769%
Time Elapsed   : 0.000
+--------------------------------------------+

NOTE: When grading I will test your program using a different, much larger data file. For this reason you should not use an array to store all the words.

Grading

Your program should be completely working and should follow all of the programming conventions named in class and explained in http://josephus.hsutx.edu/classes/all/javaconventions/ (including the use of comments that conform to the JavaDoc guidelines).

The instructor will grade your work based on what you have pushed to the hosted homework repository you have shared. For all assignments the program is due before the beginning of class on the due date. Repositories that show a commit time after that time will be graded as late.