Skip to content

Project 3 Plan

Objective

Continue to build on the plan we developed in units 1 and 2 for the Analyzer application.

  1. Determine the logic for the TokenLengthsAnalyzer processToken() method.
  2. Determine the logic for using the search_tokens.txt file in TokenSearchAnalyzer .
  3. Determine the logic for the TokenSearchAnalyzer processToken() method.
  4. Optional: Add the new analyzer classes to the class diagram.

Instructions

Class Diagram (optional)

  • Update your class diagram to reflect the new classes, instance variables, and methods for the Analyzer application.

TokenLengthsAnalyzer

Pseudocode

  • Spend some time thinking through what the processToken() method needs to do in the TokenLengthsAnalyzer class.
  • Document the logic in pseudocode.
  • Label the pseudocode as "TokenLengthsAnalyzer - processToken"
  • Save the document as plan-pseudocode and save it to the projects/screenshots/project-3/plan directory.

Pseudocode Tests

  • Provide at least one "test" of each processToken pseudocode to check your logic.
  • Suggestions for testing your TokenLengthsAnalyzer pseudocode: 
    Send in the following tokens, one at a time:
-----
quirk
zany
a
zap
fizz
i
  • Document what the processToken method will do with each token and what the tokenLengths map will contain during each step.

search_tokens.txt

Pseudocode

  • Spend some time thinking through what the TokenLocationSearchAnalyzer will need to do with the search-tokens.txt file
  • Document the logic in pseudocode in the plan-pseudocode document already created.
  • Label the pseudocode as "TokenLocationSearchAnalyzer - search-tokens.txt"

Pseudocode Tests

  • Provide at least one "test" of this logic.

  • Suggestions for testing your pseudocode:

    Send in this "file":
-----
the

hello
quirky

  • Document what the pseudocode will do with this file. Be sure to show what the foundLocations map will contain during each step.

TokenLocationSearchAnalyzer

Pseudocode

  • Spend some time thinking through what the processToken() method needs to do in the TokenLocationSearchAnalyzer class.
  • Document the logic in pseudocode in the plan-pseudocode document already created.
  • Label the pseudocode as "TokenLocationSearchAnalyzer - processToken"

Pseudocode Tests

  • Provide at least one "test" of each processToken pseudocode to check your logic.

  • Suggestions for testing your TokenLocationSearchAnalyzer pseudocode:

    Send in the following tokens, one at a time:
----
the
quirky
zany
cat
ate
the 
cat
food
quickly

  • Document what the processToken method will do with each token. Be sure to show what the foundLocations map will contain during each step.

Screenshots

If you updated your class diagram, save a screenshot in the projects/screenshots/project-3/plan directory as plan-classDiagram.png.

Submit Project Plan

  1. Add, commit, and push!
  2. Verify the screenshot (if provided) and your pseudocode are visible in GitHub.
  3. Create a new issue in GitHub: "Project 3 plan ready for review".
  4. Click "Submit new issue"

Rubric

All of the following must be satisfied to achieve a "Met" status

  • Demonstrates a thorough understanding of the Project 3 requirements.
  • Plan is shared in a such a way that instructor can understand the design and provide feedback.
  • Pseudocode for the TokenLengthsAnalyzer processTokens method accurately describes the logic step-by-step.
  • At least one test is provided for the TokenLengthsAnalyzer processTokens pseudocode.
  • Pseudocode for the using the search_tokens.txt file accurately describes the logic step-by-step.
  • At least one test is provided for the search_tokens.txt file pseudocode.
  • Pseudocode for the TokenLocationSearchAnalyzer processTokens method accurately describes the logic step-by-step.
  • At least one test is provided for the TokenLocationSearchAnalyzer processTokens pseudocode.
  • Pseudocode is written in plain English, avoiding specific programming language syntax or code snippets.
  • The plan is visible in GitHub with an issue.

Making Corrections

I will provide feedback in the GitHub issue on your project plan. If you received a "not yet", simply make the necessary corrections and reply to the GitHub issue when you are ready for me to reassess your work.