Class UserInterface

java.lang.Object

UserInterface

class UserInterface
extends java.lang.Object

Project #2 CS 2334, Section 010 February 22, 2017

This class provides helper methods to interact with the user.

Note that all methods in this class are static because we don't need to make several UserInterface objects and have them maintain their own data. Instead, we simply need a collection of useful methods to create windows that pop up one at a time, are used, and then are discarded.

Version:

2.0

Author:

Dean Hougen

Constructor Summary

Constructors

Constructor and Description
UserInterface()

Method Summary

Modifier and Type	Method and Description
private static java.lang.String	convertToOutputFormat(NewsStory newsStory, java.lang.String mediaType) This method converts an individual story to the desired display format.
static java.lang.String	createListOfNewsStoriesForNewsmaker(NewsMaker newsMaker, java.lang.String mediaType, java.lang.String[] sortCriteria) This method takes a news maker and turns its list of news stories into a String formated for display to the user.
static void	presentNewspaperStories(java.lang.String listOfStories, java.lang.String newsMakerName) This method displays the list of news stories to the user at the console.
static boolean	queryBoolean(java.lang.String message) This method prompts the user (at the console) with whatever message is passed in through the parameter message, followed by the String " (y/n)?".
static java.lang.String	queryFileName(java.lang.String message) This method prompts the user (at the console) with whatever message is passed in through the parameter message.
static java.lang.String	queryMatchType() This method asks the user (at the console): "Search news makers by exact or partial matches (e or p)? " The method loops until a valid answer in given.
static java.lang.String	queryMediaType() This method asks the user (at the console): "Search newspapers, TV news, or both (n, t, or b)? " The method loops until a valid answer in given.
static java.lang.String	queryNewsMakerName(java.lang.String matchType) This method asks the user for the name of a news maker using console input and returns it.
static java.lang.String	querySortCriterion(java.lang.String sortCriterion) This method asks the user (at the console) for a sort criterion.
static void	reportNewsmakerNotFound(NewsMaker queriedNewsMaker) This method reports at the console that there were no relevant stories found.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserInterface

UserInterface()

Method Detail

queryMediaType

public static java.lang.String queryMediaType()
                                       throws java.io.IOException

This method asks the user (at the console):
"Search newspapers, TV news, or both (n, t, or b)? "
The method loops until a valid answer in given.

Returns:

The media type as a String.

Throws:

java.io.IOException - If something goes wrong reading a line from the console.

queryMatchType

public static java.lang.String queryMatchType()
                                       throws java.io.IOException

This method asks the user (at the console):
"Search news makers by exact or partial matches (e or p)? "
The method loops until a valid answer in given.

Returns:

The match type as a String.

Throws:

java.io.IOException - If something goes wrong reading a line from the console.

queryNewsMakerName

public static java.lang.String queryNewsMakerName(java.lang.String matchType)
                                           throws java.io.IOException

This method asks the user for the name of a news maker using console input and returns it. It will ask for an exact or partial match, depending on the parameter matchType, which has "e" and "p" as its two valid options.

Parameters:

matchType - Whether the name match will be exact (e) or partial (p).

Returns:

The name provided by the user (or "None" if none provided).

Throws:

java.io.IOException - If something goes wrong reading a line from the console.

querySortCriterion

public static java.lang.String querySortCriterion(java.lang.String sortCriterion)
                                           throws java.io.IOException

This method asks the user (at the console) for a sort criterion. If called with an empty String (""), it will ask about the primary sort criterion. If called with a non-empty String, it will ask for a secondary sort criterion that isn't the sort criterion passed in as a parameter. The method loops until a valid answer in given.

Parameters:

sortCriterion - The primary sort criterion already specified by the user (if any).

Returns:

The sort criterion specified by the user.

Throws:

java.io.IOException - If something goes wrong reading a line from the console.

queryFileName

public static java.lang.String queryFileName(java.lang.String message)
                                      throws java.io.IOException

This method prompts the user (at the console) with whatever message is passed in through the parameter message. This message is intended to ask for filenames but does no checks on the String returned so it could be used to ask any question that takes a String as a response.

Parameters:

message - The message with which to prompt the user.

Returns:

The filename as a String.

Throws:

java.io.IOException - If something goes wrong reading a line from the console.

queryBoolean

public static boolean queryBoolean(java.lang.String message)
                            throws java.io.IOException

This method prompts the user (at the console) with whatever message is passed in through the parameter message, followed by the String " (y/n)?". This message is intended to ask questions to which the answer should be yes (y) or no (n) and it returns a boolean value of true or false, respectively. The method loops until a valid answer in given.

Parameters:

message - The message with which to prompt the user.

Returns:

A boolean value of true for yes or false for no.

Throws:

java.io.IOException - If something goes wrong reading a line from the console.

createListOfNewsStoriesForNewsmaker

public static java.lang.String createListOfNewsStoriesForNewsmaker(NewsMaker newsMaker,
                                                                   java.lang.String mediaType,
                                                                   java.lang.String[] sortCriteria)

This method takes a news maker and turns its list of news stories into a String formated for display to the user. At the end it includes a line summarizing the number of stories found, the number of different news sources in which these stories were published, the total length of these stories, and the number of different topics found.

The summary line will have a slightly different format depending on media type specified.

Newspapers:

Number of Stories: n1; Number of Sources: n2; Number of Words: n3; Number of Topics: n4

TV News:

Number of Stories: n1; Number of Sources: n2; Seconds: n3; Number of Topics: n4

Both:

Number of Stories: n1; Number of Sources: n2; Number of Word Equivalents: n3; Number of Topics: n4

Parameters:

newsMaker - The news maker for which to create the story list as a string.

mediaType - The type of media (newspaper, TV news, or both, given as n, t, or b) that should be included in the list.

sortCriteria - The primary, secondary, and tertiary sort criteria to use (source, topic or length, given as s, t, or l), in an array where element 0 corresponds to primary, 1 to secondary, and 2 to tertiary.

Returns:

The list of stories as one (potentially very large) string

convertToOutputFormat

private static java.lang.String convertToOutputFormat(NewsStory newsStory,
                                                      java.lang.String mediaType)

This method converts an individual story to the desired display format.

The returned line will have a slightly different format depending on media type specified.

Newspapers:

date; source; number words; topic

TV News:

date; source; number seconds; topic

Both:

date; source; number word equivalents; topic

Parameters:

newsStory - The story to convert to the display format.

mediaType - The type of media (newspaper, TV news, or both, given as n, t, or b) that will be included in the list.

Returns:

The story in the display format.

presentNewspaperStories

public static void presentNewspaperStories(java.lang.String listOfStories,
                                           java.lang.String newsMakerName)

This method displays the list of news stories to the user at the console.

Parameters:

listOfStories - The list of stories to display, all as one (potentially very large) String.

newsMakerName - The name of the news maker (which is put into the title of the JOptionPane).

reportNewsmakerNotFound

public static void reportNewsmakerNotFound(NewsMaker queriedNewsMaker)

This method reports at the console that there were no relevant stories found.

"There are no relevant stories about news maker in this database."

Parameters:

queriedNewsMaker - The news maker the user searched for.