CISC 475
Object-Oriented Software Engineering

Spring 2004
102 Gore Hall, MW 1730–1845

This is the Web page for CISC475, “Object-Oriented Software Engineering”. It will contain announcements, policies, and other pertinent material for the course. The page will be updated frequently—plan on checking for new or updated material at least once a week.

About the course
Textbooks
Schedule
Semester project
Final presentation
Final submission
Grading
Policies
Resources
Lecture materials

CISC475 presents an introduction to object-oriented software engineering concepts, methodologies and tools. It covers the analysis, specification, design, and implementation of software systems using object-oriented development processes including the Unified Process and UML. The course includes a semester-long team development project using the techniques discussed in class.

Prerequisites: A minimum grade of C− in CISC280 (Program Development Techniques) and Senior status. CISC361 (Operating Systems) is recommended.

Applying UML and Patterns: An Introduction to Object-Oriented Analysis and Design and the Unified Process 2nd Edition Craig Larman ISBN: 0130925691	Software Engineering 6th Edition Ian Sommerville ISBN: 020139815X

A major part of the course consists of a semester-long team project. Each team will analyze, design, and build a significant software system using the Unified Process, and will deliver a complete set of UP artifacts (use cases, domain model, sequence diagrams, operation contracts, and so forth) along with the operating software. Projects will be implemented in Java (preferably) or C++.

Project topic: The project can be a productivity application, simulation, programming utility, game, or whatever, as long as it is:

• Interesting
• Not something any team member has already developed
• Complicated enough to demonstrate the team's engineering skills
• Not too complicated to finish within one semester
• Not a Web application, chat server, or Blackjack game
• Approved by the instructor

In general, an acceptable project is one that supports multiple business functions, ideally for multiple types or classes of users. Requirements analysis and design for such a project will be more challenging than for a single-user, single function application (like a Solitaire game or an MP3 player).

Some possible project ideas are:

• Project management application
• Customer relationship management (CRM) system
• Class scheduling system
• High-volume data historian
• CASE tool for CISC475 semester projects :-)

To prevent “scope creep”, projects should be held to the following limits:

1. Approximately 7 (±2, max 10) use cases.
2. A maximum of 20 concepts in the concept diagram.
3. A maximum of two or three design patterns.

Team member roles: Each team will consist of five students, and each student must have at least one well-defined role on the team. Each team must have a team leader, but the other roles will depend on the project topic selected. Some typical roles might be:

• Team leader—coordinates activities, leads design and implementation efforts, interfaces with the customer
• Test engineer—Designs, codes, and runs unit tests and integration tests.
• Configuration manager—documents the development process, develops deliverables with a consistent look and feel
• Lead developer—develops core classes, oversees work of other coders
• Coder—the "ground state" for team members; everybody should be doing some coding
• Database developer

Project tools: You must follow the Unified Process for this project, and deliver a number of UP artifacts. Your grade also will be influenced by how well you adopt and use real software engineering tools, such as:

• Ant to automate building, testing and deployment.
• JUnit to unit test your code.
• CVS or some other version control package for both source code and artifacts.
• Javadoc to document your classes.
• A punchlist database (like Bugzilla, but simpler) to track bugs, missing features, potential refactorings, and other issues.
• A Wiki or some other tool for collaborative document editing.

Presentations: Each team will present its progress to the class at four points through the semester. At the third presentation, you will be expected to demonstrate major parts of your application. At the fourth presentation, you will demonstrate your complete application, and allow the instructor to “test drive” its functionality.

Milestones and submissions: At all four milestones, you will submit UML artifacts on paper. This will allow the TA and instructor to mark up the submissions when grading. At the third milestone, you will also submit all UML artifacts via e-mail as a ZIP file. At the fourth milestone, you will submit all UML artifacts, source code, build/test/install scripts, README files, installation instructions, and other documents on CD-ROM. The organization and professionalism of these submissions, and the ease with which the instructor can get your code running, will affect your grade.

The following Unified Process artifacts must be submitted at each presentation:

1. Requirements and Use Cases documents, Vision, and Glossary
2. Specification documents (domain model, system sequence diagrams, operation contracts, collaboration diagrams)
3. Design documents (design class diagrams, package diagram, deployment diagram)
4. Project source code, .class files, javadoc files, installation scripts, installation instructions, help files, test scaffolding, etc.

Because the Unified Process is an iterative development process, artifacts will evolve throughout the project. Therefore, each submission must also include revised, updated versions of artifacts from all previous submissions.

3rd-party components: With the approval of the instructor, teams may use third-party libraries (e.g., the Tomcat servlet container) as discrete components in their projects. Except for such approved components, the code and documentation developed in this course must be the original work of the project team members.

Teams: I've put up a page containing everything I know about the project teams. Team leaders should review this page for accuracy and send me any corrections.

Final project presentations will be held on Monday, May 17th from 1715 to 1930 and on Wednesday, May 19th from 1715 to 1930. Three teams will present on Monday; the other three will present on Wednesday. Both sessions will be in 331 Purnell Hall rather than in 102 Gore. The room will be open starting at 1700 to allow you to set up for the presentation. Attendance at both presentations is mandatory for all students in all teams.

There may be NO Internet connection available in 331 Purnell, so bring all of the hardware you need for your presentation (except that the instructor will provide a power strip, a network hub, and several network cables). If your project is a networked application, the instructor may connect a laptop to your server and test-drive your system, so make sure that your network drivers are up and that any firewall permissions are set to permit this.

Each member of each team must introduce himself (not just be introduced by the team leader), and should make some part of the presentation. The instructor may take a picture of each team.

Each presentation should take about 35–40 minutes, including setup/teardown and question/answer. Do at least one dress rehearsal of your presentation to make sure that everyone knows his part and that it will take about that amount of time.

Here are some examples of the things a good presentation might cover:

• System overview: Describe what the system is, and why you think it's a good idea.
• System functionality: Demonstrate all of the main Use Cases for your system.
• Pattern usage: Describe which design patterns you used in your code.
• Error handling: Describe how you handle common errors.
• Infrastructure: Show off your source code, build scripts, and CVS.
• Automated testing: This will be especially impressive.
• Lessons learned: What went wrong during the project, and how would you prevent it next time?

You can't cover all of these areas thoroughly in 40 minutes, so you'll have to choose the areas to emphasize that are most likely to impress the instructor and TA.

Final project submissions are due at the beginning of class (5:15PM) on May 19th for ALL teams. The submission will consist of both printed and machine-readable versions.

The printed submission must contain all project artifacts plus a table of contents. Do not include source or Javadoc printouts; there's no need to kill more trees. The submission should be bound (no loose pages) and should not contain any hand-drawn pictures.

The printed submission should include at least the following UP artifacts:

• Vision Statement
• Use Cases
• Supplementary Specification
• Glossary
• Domain Model
• Sequence Diagram (at least one)
• Operation Contract (at least one)
• Collaboration Diagram (at least one)
• Design Class Diagram(s)
• Package Diagram
• Deployment Diagram

The machine-readable version should be submitted on CD (preferred) or floppy. It must contain electronic versions of all of the printed documents, plus source code, Javadocs, and build and test scripts. Include a README.TXT file at the top level of the hierarchy. README.TXT should describe the organization of the submission, and should contain instructions for building and running your system, including detailed instructions for downloading and installing any 3rd-party components necessary.

Organize the files into a reasonable and functional directory hierarchy; I should be able simply to copy the CD contents to hard disk, update my CLASSPATH, and run Ant to rebuild your application.

If the submission includes any Microsoft Office documents, they must be in Office 97 format.

Grades for the semester will be based on:

Each student's project grade will be a combination of the group grade and an individual grade. Team members will be asked to review each other's contributions to their projects.

The semester grade is computed according to the following table:

Exams: The course will include two exams (but no final). The lectures will introduce material not covered in either textbook, and this additional material will be on the exams. Exams will be closed-book.

Late assignments: There are no homework assignments (other than the project) in this course. There are four delivery milestones for components of the project, which must be met. No credit will be given for project materials turned in late.

Academic integrity: You will be expected to conform to the University's policy on academic integrity.

• Violet, a simple open-source UML drawing tool
• ArgoUML, a free UML-based CASE tool
• UMLet, another UML drawing tool (closed-source, but free for educational use)
• UseModWiki, a simple, flexible Wiki implementation
• Visual Paradigm offers a community edition of their UML modelling tool.
• The periodic table of design patterns.
• Visio templates for drawing UML diagrams.
• The UML Specification is available on the Object Management Group's Web site.
• TortoiseCVS is a great CVS client for Windows.
• Alistair Cockburn's usecases.org site.
• Teach Yourself Programming in Ten Years!

Here are some recommended reference books:

Effective Java Programming Language Guide Joshua Bloch ISBN: 0201310058

Unit Testing In Java: How Tests Drive the Code Johannes Link ISBN: 1558608680

The PC is Not a Typewriter Robin Williams ISBN: 0938151495

Here are the PowerPoint slides and other materials from the lectures. Note that many topics covered in the lectures are not on the slides but will be on the exams. Also, any material in the textbook (at least in the chapters we're covering in lectures) can potentially be on the exams. And, finally, remember that lecture slides are not a substitute for either attending the lectures or reading the textbook—see this version of the Gettysburg Address, this Wired article by Edward Tufte, and this Robert Cringely article for some reasons why.

Last modified: Tuesday, 25 May 2004