Difference between revisions of "SE2006:group bar:March Deliverables"

From Earlham CS Department
Jump to navigation Jump to search
(link to todo)
(March Deliverables: fix link)
Line 6: Line 6:
 
1) API Documentation
 
1) API Documentation
 
*Developer documentation on usage
 
*Developer documentation on usage
**At this point we do not have API to the data store. We could write a quick hack in PHP but would rather spend the time to do it well in Java.  See our complete [[http://wiki/index.php/SE2006:group_bar:todo|TODO list]] for more details on where we stand.
+
**At this point we do not have API to the data store. We could write a quick hack in PHP but would rather spend the time to do it well in Java.  See our complete [[SE2006:group_bar:todo|TODO list]] for more details on where we stand.
 
**We have an API for actually scraping Data written in java.  See http://cs.earlham.edu/~bar/doc/ for the documentation
 
**We have an API for actually scraping Data written in java.  See http://cs.earlham.edu/~bar/doc/ for the documentation
 
*How to add data new sources
 
*How to add data new sources

Revision as of 11:43, 31 March 2006

"Over-ambitious projects: the theme of this semester!"

March Deliverables

As requested from Chris' email:

1) API Documentation

2) Test harness (with instructions) for the API

  • We use JUnit, and it must run from Eclipse (for now). Other hooks (to use it) coming soon. (Alex & Colin?)

3) Data store information

  • The data dictionary itself
    • Postgres database 'tobias' on millie; user 'tobias' password 'tobias' (will replace this with a bar database once that's setup)
  • Scripts/instructions for creating the schema in the database instance
    • There are none because this is done dynamically by our code. (Based on SourceDefinition, see above URL.)
  • Scripts/instructions to populate the database with your data sources and their source information
    • See above pointer. Just run the java program, and the Scheduler will take care of all the nitty/gritty details.