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

From Earlham CS Department
Jump to navigation Jump to search
(A submission of the March Deliverables)
 
(update deliverables)
Line 1: Line 1:
 +
"Over-ambitious projects: the theme of this semester!"
 +
 
=March Deliverables=
 
=March Deliverables=
 
As requested from Chris' email:
 
As requested from Chris' email:
Line 4: 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.
+
**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.
**We have an API for actually scraping Data.  See http://cs.earlham.edu/~bar/doc/
+
**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
**Check out this url (linked to from above url) http://cs.earlham.edu/~bar/doc/edu/earlham/cs/scrapi/SourceDefinition.html
+
**Implement the SourceDefinition class according to the instructions on this page: http://cs.earlham.edu/~bar/doc/edu/earlham/cs/scrapi/SourceDefinition.html
  
 
2) Test harness (with instructions) for the API
 
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.
+
*We use JUnit, and it must run from Eclipse (for now).  Other hooks (to use it) coming soon. (Alex & Colin?)
  
 
3) Data store information
 
3) Data store information
 
*The data dictionary itself
 
*The data dictionary itself
**Postgres Tobias on Millie.
+
**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
 
*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.)
 
**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
 
*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.
 
**See above pointer.  Just run the java program, and the Scheduler will take care of all the nitty/gritty details.

Revision as of 12:16, 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.