nile.Librarian Interface Reference

List of all members.

Public Member Functions
List< BookPair >	getPairs (String directory)
Collection< BookPair >	getRecommendations (String directory, String book)
void	validateDirectory (String directory) throws IllegalArgumentException

---

Detailed Description

This is the primary interface to implement to provide nile functionality. It should take in lists of books and provide a recommendations according to the specs below.

Author:

alucido, nford

---

Member Function Documentation

List<BookPair> nile.Librarian.getPairs

(

String

directory

)

This method returns a list of pairs of books, such that each pair represents two books that appear in the same list. The return list should contain a subset of all possible BookPairs in the given directory. That subset should be only the most popular books, based on the frequency the pair appeared.

Parameters:

directory

- the directory to look for lists of books in.

Returns:

a sorted List of BookPair objects.

Collection<BookPair> nile.Librarian.getRecommendations	(	String	directory,
		String	book
	)

This method should returns a collection of books already sorted by how much each is recommended first, and alphabet second, and containing only the most recommended books. Each time a candidate book appears in the same list as the passed book, the pair with the candidate should have its recommendation (popularity) value increased.

Parameters:

	directory	- the directory to look for lists of books in.
	book	- the book whose presence in a list increases the recommendation value of other books in that list.

Returns:

a collection of BookPair objects

void nile.Librarian.validateDirectory

(

String

directory

)

throws IllegalArgumentException

Implement this method to check to see if a directory passed to the Librarian is valid. A directory is valid if it exists and if there is some accessible file within it.

Parameters:

directory

---

The documentation for this interface was generated from the following file:

• src/nile/Librarian.java