CS 272 Software Development

Table of Contents Project Release v5.0
Core Functionality
Additional Functionality
Design Deductions

For this project, you will extend your previous project to create a fully functional multithreaded search engine with a web interface that allows users to enter multi-word search queries into an HTML form and get back sorted partial search results as a dynamically generated web page using embedded Jetty and servlets.

This project will be graded and reviewed during finals week only. If you do not attend a final code review, you will earn a 0 on these assignments regardless of what you implemented.

Project Release v5.0

This project release must support building an inverted index from a single web page as follows:

• Your main method must process the command-line arguments -server [port] where the flag -server indicates to launch a multithreaded search engine web server, and the next optional argument [port] is the port the web server should use to accept socket connections. Use 8080 as the default value if it is not provided.

• If the -server command-line argument is provided, your code should enable multithreading with the default number of worker threads even if the -threads flag is not provided.

• Your web server must provide a web interface that allows users to enter multi-word search queries into an HTML form and get back sorted partial search results as a dynamically generated web page using embedded Jetty and servlets. This core functionality is worth 50 points. See the Core Functionality section for details.

• After implementing core functionality, your web server should provide up to 50 points of additional functionality of your choosing. See the Additional Functionality section for details.

Your code should support all of the functionality from the previous project as well.

Project v5.0 Tests

This grade is earned by meeting the following requirements:

1. You must already have a passing grade for the Project v3.x Design and Project v4.1 Tests assignments.

2. You must create a release that continues to pass the Project v4.1 Tests and earlier tests.

3. You must attend a final code review with the instructor where your core and additional functionality will be manually user tested. Core functionality must be fully functional before additional functionality will be graded and tested.

This project is manually graded and reviewed during your finals review only. You can earn a partial grade for this assignment (unlike other test assignments).

There are no automated tests for this release. Do NOT use the “Request Project Tests Grade” issue template to request a grade.

Project v5.0 Design

This grade is earned by meeting the following requirements:

1. You fully complete the core functionality of the Project v5.0 Tests assignment during your final review.

2. You have well-designed project code, including all code created for previous projects. See the Design Deductions section for details.

This project will be graded and reviewed during finals week only. You can earn a partial grade for this assignment (unlike other design assignments).

Run Examples

The following are a few examples (non-comprehensive) to illustrate the usage of the command-line arguments that can be passed to your Driver class via a “Run Configuration” in Eclipse, assuming you set the working directory to the project-tests directory.

Consider the following example:

-html "/project-web/input/simple/" -crawl 15 -threads 3 -server 8080

The above arguments behave the same as project 4, except it will also start up a web server on port 8080 for the user to interface with the search engine. No file output will be generated in this example.

Core Functionality

The functionality for this project is broken into 2 parts: core functionality (50 points) and additional functionality (50 points). Together, these make up the grade. You must complete the core functionality before additional functionality.

The core functionality includes, in addition to maintaining the functionality of the previous project, the following for a total of 50 points:

You cannot earn credit for additional functionality until the core functionality is fully functional.

Additional Functionality

Once the core functionality is fully functional, you may implement up to 50 points of additional functionality. You are welcome to complete more functionality than that, but you may not earn over a 100% on this assignment.

These features are broken into several categories. You may choose any combination of features from these categories.

Have a feature idea? You can propose a new feature in a public post on the course forums. If approved, the instructor will post the number of points that feature will be worth on the final project.

User Tracking Features

The following features requires your search engine to track user data. There are two implementation options (choose one):

1. Base Functionality: Implemented by storing data in memory; only supports a single user.

2. Extra Functionality: Implemented by storing data using session tracking or cookies; supports multiple users. Recommended

You should use the same implementation option for all features in this subcategory. For example, if you implement search history using sessions, you should also implement visited results using sessions.

The possible features are:

There are 50 to 70 points possible in this category depending if you choose to implement base or extra functionality.

Metadata Features

The following features requires your search engine to track search metadata (not specific to users). There are two implementation options:

1. Base Functionality: Track metadata in memory (non-persistent).

2. Extra Functionality: Track metadata in the on-campus SQL database (persistent). Recommended

You should use the same implementation option for all features in this subcategory. For example, if you implement page snippets using a database, you should also implement popular queries using a database too.

The possible features are:

Some features require others to be implemented first. For example, Reset Metadata cannot be implemented until at least one of the other features that stores metadata is implemented.

There are 50 to 90 points possible in this category depending if you choose to implement base or extra functionality.

Extendable Features

The following features have base functionality that can be extended. The base functionality must be implemented first.

For example, if you implement base functionality for New Seed, you will earn 10 points. If you implement both base and extra functionality for New Seed (including Max Crawl Support), you will earn 20 points instead.

There are 40 to 80 points possible in this category depending if you choose to implement base or extra functionality.

Miscellaneous Features

The following miscellaneous features may also be implemented:

There are 60 points possible in this category.

Design Deductions

If you complete the core functionality for the Project v5.0 Tests assignment during your final review, then your code will be evaluated for its design. The following design considerations will be evaluated:

All of your code will be reviewed, but the focus will be on your web crawler and search engine code. Minor issues will result in fewer deductions than major issues. For example, a small number of formatting issues will result in a smaller point deduction than pervasive formatting issues throughout the code.