Class QueryResults

java.lang.Object

QueryResults

public class QueryResults
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
QueryResults(java.lang.String filename)	Constructor for the QueryResults class.

Method Summary

Modifier and Type	Method	Description
int	getCount()	Get number of recursive calls.
java.util.List<java.lang.String>	getDictionary()	Getter method for the dictionary object.
java.util.List<java.lang.String>	getList()	Getter method for the list object.
java.lang.String	getWord()	Getter method for the current string being queried.
static void	main(java.lang.String[] args)
java.util.List<java.lang.String>	readDictionary(java.lang.String filename)	Create a new List and then read each token from the file called filename and add it into the List.
void	searchDictionary(java.lang.String word)	Recursively search substrings of the parameter word and store uniquely in the List list.
java.util.List<java.lang.String>	searchDictionaryHelper(java.util.List<java.lang.String> wordList, java.lang.String word)	Helper method for searchDictionary.
java.lang.String	toString()	toString for you QueryResults class.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryResults

public QueryResults(java.lang.String filename)
             throws java.io.FileNotFoundException

Constructor for the QueryResults class.
Initialize the dictionary and list objects

Parameters:

filename - name of the dictionary file

Throws:

java.io.FileNotFoundException - exception is thrown to the calling method if unable to open file

Method Detail

getDictionary

public java.util.List<java.lang.String> getDictionary()

Getter method for the dictionary object.

Returns:

List dictionary object

getList

public java.util.List<java.lang.String> getList()

Getter method for the list object.

Returns:

List of words found in searchDictionary(java.lang.String) method.

getCount

public int getCount()

Get number of recursive calls.

Returns:

the number of recursive calls used in searchDictionary.

getWord

public java.lang.String getWord()

Getter method for the current string being queried.

Returns:

the word being queried

readDictionary

public java.util.List<java.lang.String> readDictionary(java.lang.String filename)
                                                throws java.io.FileNotFoundException

Create a new List and then read each token from the file called filename and add it into the List.

Parameters:

filename - name of file

Returns:

A list of legal words to use for this recitation

Throws:

java.io.FileNotFoundException - exception is thrown to the calling method if unable to open file.

See Also:

Scanner.hasNext(), Scanner.next()

searchDictionary

public void searchDictionary(java.lang.String word)

Recursively search substrings of the parameter word and store uniquely in the List list.

1. Assign word into the corresponding member variable
2. Set the member variable for count back to 0
3. Assign list to the return value for searchDictionaryHelper(List, String) method. Pass in a new ArrayList and the word as parameters.

Parameters:

word - the word to query.

searchDictionaryHelper

public java.util.List<java.lang.String> searchDictionaryHelper(java.util.List<java.lang.String> wordList,
                                                               java.lang.String word)

Helper method for searchDictionary.
Your recursive logic goes here:

1. If the word is less than or equal to two characters, return wordList.
2. Increment the counter.
3. Add the word if it is in the dictionary but not already in the list.
4. Recursively call the method twice: Once with the first character removed and once with the last character removed.

Use ArrayList.contains(Object).

Parameters:

wordList - A List of unique legal substrings from the parameter, word

word - The word being queried

Returns:

A List of unique legal substrings from the parameter, word

See Also:

ArrayList.contains(Object)

toString

public java.lang.String toString()

toString for you QueryResults class.

Overrides:

toString in class java.lang.Object

Returns:

String that prints information about the class

main

public static void main(java.lang.String[] args)
                 throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException