Numerology with Methods

From CompSciWiki
Revision as of 18:40, 3 April 2011 by EsmondP (Talk | contribs)

Jump to: navigation, search

Back to the Case Studies homepage

Problem

Write a complete Java program, similar to the problem Numerology in Case Studies Level Two. If you have not completed the previous problem click here to view problem details. Your goal is to rewrite the solution to use methods.


In particular, you should at least have methods with the following headers:

1. Calculate String Method

public static int calculateString (String name) 

This method will accept the name as a String and return the int which directly (i.e., without further collapsing)
corresponds to the name. So if name = “Alan Turing”, the method should return 45.


2. Collapse Integer Method

public static int collapseInt (int currentValue)

This method totally collapses the integer parameter currentValue to a single-digit number. So if currentValue = 88,
then the method should return 7 (and not 16).


3. Print Message Method

public static void printMessage (String name, int magicNumber)

This method should print the final message of the program. The magicNumber is between 1 and 9.


Remember to follow COMP 1010 coding standards.

 

Numerology with Methods

Wiki start01.jpg

Solution

I suggest you plan and create an outline on how to accomplish the solution before you code. An outline can benefit you in many ways. For example an outline can help you determine and layout the logic of your solution, variables, and methods. Additionally, you can find possible problems in the logic before writing the code. If an error exists or the code does not execute as expected, locating the problem in a few hundred lines of code is not always easy. If you know in advance what exactly you want to do, writing the code will be easier.


Here are steps you can follow:

  • Make sure you understand the problem
  • List exactly what the problem is asking you for
  • Determine the logic for each item
  • Organize the code
  • Type the rest of the code


Step 1: Make Sure You Understand the Problem

This step is important. You definitely want to avoid a situation where you have been working on an assignment for 3 days and suddenly find out you misinterpreted the question.


What is the Problem?

In this case, the problem is to re-write the Numerology solution to use methods. What is the actual problem? According to the Numerology problem your task is to convert a name into an integer using the pseudo-mathematics of numerology.


What is a Method?

A Method is a section of code, similar to a sub procedure, which can be referred by name from anywhere in your program. The structure of an method includes a name, signature, and sometimes a return value. Methods benefit the programmer because time is saved from repeating sections of code by simply calling the method's name. Methods can be saved and used in other programs as well.


Here are some general rules you can follow when using methods:

  • Method name should be meaningful, usually a verb describing the method's function.
  • Each method should have one purpose.
  • The length of the method is no longer than 100 lines or the size of your display.


Step 2: List Exactly What the Problem is Asking For.

Most COMP 1010 assignments layout the steps for the solution in the problem. Although, as you advance to 2nd or 3rd year, you need to determine the steps on your own. This list is a good place start when deciding what methods you need.


Here is an overview of what the problem is asking:

  • Prompt the user for a name.
  • Calculate a running sum based on the letters in the name and the values assigned to the letters.
  • Collapse the sum into a destiny number.
  • Assign and display characteristics to the name based on the destiny number


As you can see, I bolded certain words within the list. These words can be used to name the methods we need.


Step 3: Determine The Logic For Each Item

The goal in this step is to determine how each task or method will execute. We need to figure out what the logic, the inputs, the return values required for each method. A good way to layout the logic is to write pseudocode. Pseudocode a way to explain how an algorithm executes using plain English that is structured similar to code.

Prompt a User for a Name

Numerology Calc.png


Step 4: Organize The Code.

Step 5: Type The Rest Of The Code

Code

Solution Code

Back to the Case Studies homepage