SwingPix Photo Organizer

Requirements Specification Document

 

 

 

By:

            Justin Berstler

            Aju Mathew

            Yinka Ogungbemi

            Yinka Olabinjo

            John Rountree

            Mathew Schaffer

 

Submitted for Drexel University’s Software Engineering Workshop 2

Monday June 2, 2003

 

This document is also available at

http://swingpix.sourceforge.net/docs/requirements/


Document Revision History

 

Date

Revision

Description

2/21/2003

0.01

Initial document framework creation and front-matter creation

2/22/2003

0.02

Incorporation of non-functional requirements

2/22/2003

0.03

Added licensing and copyright section

2/23/2003

0.1

Incorporation of Functional Requirements section

2/24/2003

0.5

Incorporation of screenshots section.  Editing functional reqs.

2/24/2003

0.6

Glossary added.  Additional editing.

2/24/2003

1.0

Completion of editing for release.

5/29/2003

1.1

Front-matter revisions.  Added open source appendix section.

5/30/2003

1.2

Revised text in sections 3, 4, 5 and Appendices.

5/31/2003

1.3

Revised functional specification (section 2)

 

 

Incorporated new screen shots taken from developed program

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 


Table of Contents

1      Introduction.. 1

1.1        Executive Summary. 1

1.2        Purpose. 1

1.3        Scope. 1

1.3.1     A Brief functional description of SwingPix. 1

1.3.2     User Market and product justification. 2

1.4        Component Requirements. 2

1.4.1     Software Requirements. 2

1.4.2     Hardware Requirements. 2

2      Functional Specifications.. 3

2.1        Album and Image Management 3

2.1.1     Create New Album.. 3

2.1.2     Import Images. 3

2.1.3     Delete Pictures / Album.. 4

2.1.4     Rename images / album.. 5

2.1.5     View Thumbnails. 5

2.1.6     Move Picture(s) 6

2.1.7     Copy Picture(s) 6

2.1.8     Store meta-data. 7

2.1.9     Search image meta-data. 7

2.1.10       Locking an album.. 8

2.2        Printing and Email operations. 9

2.2.1     Print picture(s) 9

2.2.2     Printing Thumbnails. 9

2.2.3     Save pictures for email 10

2.3        Image Handling Operations. 10

2.3.1     View Images. 11

2.3.2     Save images operations. 11

2.3.3     Reverting to Original 12

2.3.4     Color adjustment 12

2.3.5     Image cropping. 13

2.3.6     Resize operation. 14

2.3.7     Rotation operation. 14

2.3.8     Image Flip operation. 15

3      Screenshots.. 17

3.1        Import Wizard Walkthrough. 17

3.1.1     Step one – Starting the import 17

3.1.2     Step two – Album selection. 18

3.1.3     Step three – Image Selection. 19

3.1.4     Step four - Conformation. 20

3.2        Management View.. 21

3.2.1     Management View. 21

3.2.2     Edit View. 22

3.2.3     Viewing an image in Edit Mode. 22

3.2.4     Adjust Color tab. 23

3.2.5     Crop/Resize tab. 24

3.2.6     Rotation/Flipping tab. 26

4      Non-Functional Requirements.. 28

4.1        Development Requirements. 28

4.2        Deliverable Deadlines. 28

4.3        Hardware Requirements. 28

4.4        Software Requirements. 28

4.5        Performance. 29

4.6        Reliability. 29

4.7        Survivability. 29

4.8        Usability. 29

4.9        Compatibility. 29

4.10      Ethical Requirements. 30

5      Licensing and Copyright.. 31

5.1        Release License. 31

5.2        Release Fees. 31

5.3        Copyright Plan. 31

5.3.1     Current project team.. 31

Appendices.. 1

A.         Glossary. 1

B.         Open source software references. 2

C.         The GNU General Public License. 3

 


Figures and Screenshots Index

Screen 1 – The Import Wizard. 17

Screen 2 – Naming the album.. 18

Screen 3 – Importing pictures via Wizard. 19

Screen 4 – Finalizing the album contents. 20

Screen 5 – Managing Albums. 21

Screen 6 – Viewing in edit mode. 22

Screen 7 – Color Adjustment 23

Screen 8 – Using visual crop. 24

Screen 9 – Resizing. 25

Screen 10 – Horizontal Flip. 26

Screen 11 – Choosing Rotations. 27

Screen 12 – Free Rotation. 27

 


1         Introduction

1.1      Executive Summary

SwingPix is an elegant and intuitive photograph organization system.  The program allows a user to easily import digital photographs into albums.  These albums can be modified to taste, and archived to a mass-storage device.  The images in the albums can be altered and enhanced using the simple photo editing functions.  The images can also be printed with particular aspect ratios.  In addition, text can be associated with an image beyond the image title, allowing for later keyword searching.

 

1.2      Purpose

This document is intended to be a full requirements specification for the SwingPix Photo Organization system.  This document will describe the various features of the program and how the program is to operate in a user environment.  This document is intended to be read by the developers of the program, potential distributors of the program, and users of the program looking for more in-depth information.  However, this document is not intended for the average SwingPix user.  This document contains details about each function of the program, many of which will go unnoticed by the end user.

 

 

1.3      Scope

1.3.1      A Brief functional description of SwingPix

SwingPix is a comprehensive and intuitive system that will allow a user to tag[1], organize and modify images and photographs.  With minimal training, a user of SwingPix will be able to pool photographs or other images into “albums” which will serve as a container for these images.  The images can then be adjusted[2] to enhance picture quality, resized for viewing and printing at particular aspect ratios, tagged with searchable textual data and recalled for later review.  Albums of photographs can also be exported for viewing using other software packages, and archived to mass storage devices.

 

1.3.2      User Market and product justification

The base of available photo management and editing applications is quite large.  As such, some would argue what the purpose for an application such as SwingPix is.  The rationale is that many of the current programs accomplishing this task are usually much too complicated to use, or lack a robust feature set.  Also, there are commercial packages available which serve the need well, but they are much more expensive than SwingPix.  SwingPix will be a freely available, easy-to-use solution to the problem of complicated photo organization software. 

In addition, much of the software available under a comparable license to SwingPix is too complicated for the average user as well.  As such, SwingPix will help add to the growing pool of simple and elegant open source software solutions.  More information on open source software is provided in Appendix B.

 

1.4      Component Requirements

1.4.1      Software Requirements

SwingPix will require the presence of either Microsoft Windows or a Linux operating system.  In addition, the program will require a Java runtime environment, preferably the Sun JRE 1.4.1 or later.

 

1.4.2      Hardware Requirements

SwingPix will run on any computer that meets or exceeds the fulling hardware requirements, and runs one of the above mentioned operating systems. 

·         200MHz Pentium Processor

·         64MB of RAM

·         20 MB of free hard disk space

·         A 256 color or higher display

 

Full use of the HTML exporting features of the software will require the user to have internet access and access to hosted web space of some kind.  Full use of archiving features will require the user to have some kind of CD recording hardware.


2         Functional Specifications

2.1      Album and Image Management

This section contains all the functions the program will provide for the management (import, rename, delete, view) of images and albums stored in the program. 

2.1.1      Create New Album

Description

Allows the user to create a new, empty album with a specified name that can be used to store images.

Input

Album name

Source

Album name is taken from user keyboard input.

Output

A new icon for the album is created in the album tree with the specified name.

Pre-condition

User has clicked the “Create Album” button.

Post-condition

An album with the specified name has been created in the program’s data space, along with storage space for the images that will be placed into the album.

Side Effect

None

 

2.1.2      Import Images

Description

Allows the user to select images to be imported (copied) into a selected album.

Input

Selected images to be imported, and the destination album.

Source

The user selects the album and images using the mouse through use of the Import Wizard (Screen 1).  The album will be one of the albums already created in the system.  The images will be taken from sources on the computer (hard disk, camera, etc).

Output

The selected images are displayed as the contents of the selected album.

Requires

The importing wizard has been opened by clicking the “Import” icon.

Pre-condition

The importing wizard is open, and at least one album exists in the system.

Post-condition

The import wizard closes and the images are inserted into the new album. The album display is refreshed to display the new images.

Side Effect

Three copies of the image are stored in the programs picture cache.  One is the original.  Another is the working copy to be viewed and modified by editing operations.  The third is a continually updated thumbnail of the working copy of the image.  Storage of the original image separate from the working copy allows for function 2.3.3.

 

2.1.3      Delete Images

Description

The user can delete any unwanted images(s) from the album. The user selects the image(s), and then clicks the delete button. The operation will remove the image from the album.

Input

The user’s selection (by clicking) of single or multiple images.

Source

Selected image or images.

Output

The album is redisplayed with the selected images no longer present.

Requires

The album from which the images are to be deleted is open.

Pre-condition

The album window is opened and displayed on the main window.

Post-condition

The images are removed from the album, and the total album size is decreased.

Side Effect

All copies of the selected image are removed from the program’s image cache.

 

2.1.4      Delete Album

Description

The user can delete any unwanted albums from the system.  This operation also deletes all images contained in the album.

Input

The user’s selection (by clicking) of a single album.

Source

The selected album.

Output

The album tree is redisplayed with the selected album no longer present.

Requires

An album exists to be deleted.

Pre-condition

The album to be deleted is shown and highlighted in the album tree view.

Post-condition

The album is removed from the system, and the tree view is updated to reflect the change.

Side Effect

The directories set up to store the album’s images, and their contents are removed from the program’s data space.

 

2.1.5      Rename images

Description

The user can rename the images to another name by invoking the rename procedure (either by right clicking an image, or selecting “Rename image” form the Edit menu). 

Input

User entered name, and selected image.

Source

Image is selected and the user enters the new name for the image.

Output

The image is updated to reflect the name change.

Requires

The album window is opened for the operation. 

Pre-condition

The album window is opened and displayed on the main window. The user has selected the image by clicking on it.

Post-condition

The title under the image thumbnail changes to reflect the renaming of the image.

Side Effect

None.

 

2.1.6      Rename album

Description

The user can rename the albums to another name by highlighting the album and selecting “Rename album” from the Edit menu.

Input

User entered name, and selected album.

Source

Album is selected and the user enters the new name.

Output

The album is updated to reflect the name change.

Requires

The album window is opened for the operation. 

Pre-condition

The album window is opened and displayed on the main window. The user has selected the album by clicking on it.

Post-condition

All references to the album name are changed to reflect the renaming of the album.

Side Effect

None.

 

2.1.7      View Thumbnails

Description

Users can view the thumbnails in the album-viewing screen. The view thumbnail operation allows users to view all the images in the album quickly.

Input

The user’s selection of an album.

Source

The selected album

Output

The contents of the album are displayed on the thumbnail panel.

Requires

Album view is opened by the user at least one album exists to be viewed.

Pre-condition

An album exists in the system and has been selected.

Post-condition

Thumbnails are displayed on the thumbnail panel.

Side Effect

None.

 

2.1.8      Move Image(s)

Description

Image(s) can be moved from one album to another. The move operation the user flexibility to rearrange image(s) in different albums.

Input

User’s selection and dragging of single or multiple images to their new destination.

Source

Selected images from a photo album.

Output

Selected pictures are removed from the album and the album is updated accordingly.

Requires

The source album window is opened for move operation.

Pre-condition

The source images are present in the album, and destination album has been created and named.

Post-condition

The source images are removed from the album, and the destination album is updated with the new images.

Side Effect

Image files move to new location in the image cache.

 

2.1.9      Copy Image(s)

Description

Image(s) can be copied from one album to another. The copy operation allows the user to duplicate image(s) for storage different albums.

Input

User selection of the “copy” option, after selection and dragging of multiple images to their new destination.

Source

Selected images from a photo album.

Output

Selected images are duplicated and the duplicate copies are moved to a new album.

Requires

The source album window is opened for copy operation.  And “copy” operation has been selected.

Pre-condition

The source image is present in the album, and destination album has been created and named.

Post-condition

The duplicate source is moved from the source album to the destination album, the album sizes are adjusted and the destination album is updated with the new picture

Side Effect

Extra copies of image files are created in the image cache for the destination album.

 

2.1.10       Store meta-data

Description

This operation allows the user to store meta-data[3] along with images.

Input

Text meta-data information, entered by the user.

Source

Selected image(s) and data entered by user.

Output

Entered data is stored in conjunction with the selected picture(s) for later searching.

Requires

Created album and imported pictures to work on.

Pre-condition

Album and pictures being operated on have been created.

Post-condition

Textual meta-data is stored in the image data structure.

Side Effect

None.

 

2.1.11       Search image data

Description

A user can use a keyword search to recall images/albums that contain particular pieces text, either as part of the name or part of the stored meta-data.

Input

The user’s entered keywords.

Source

All textual data associated with the images/albums stored in the system.

Output

Images/albums with matching data are presented in a new window.

Requires

This function will operate on whatever data exists in the system, or return no results if there is no data in the system.

Pre-condition

None.

Post-condition

All images/albums in the system with matching textual data are presented to the user.

Side Effect

None.

 

2.1.12       Locking an album

Description

This feature will allow users to protect and hide their personal albums.  Selecting the “Lock Album” option from the Edit menu will cause any subsequent viewing of the album to require a password.   If the user has not defined a password for the system, they will be prompted on their first locking attempt.

Input

Locking password provided by the user.

Source

Selected album and provided password.

Output

The album contents are hidden until the password is provided in the appropriate dialog.

Requires

The album window is opened for the operation.

Pre-condition

The user selects the target album to lock.

Post-condition

The images in the locked album cannot be viewed from within the program unless a password is provided.

Side Effect

Stored images in the programs data space are encrypted to prevent viewing with external programs.

 

2.2      Image exporting operations

This section contains all the functions in the program that will allow the user transfer their images in some form to a location external to the program.  These functions include printing images, saving images in reduced sizes for sending them via email, and archiving images to a CD-R mass storage device.

 

2.2.1      Print image(s)

Description

This feature allows the user to print either individual images, sheets of multiple images, or sheets of image thumbnails.

Input

Images to be printed.

Source

Images are selected by the user and retrieved from the program’s data space.

Output

The selected image(s) are sent to the printer.

Requires

User approves the print process in the print dialog.

Pre-condition

The images are selected from the album opened by the user.

Post-condition

The hard copies of the images are printed out.

Side Effect

None.

 

2.2.2      Save images for email

Description

Images can be saved in smaller sizes for email to friends or relatives. The user opens the album and selects the target images that will be saved in smaller sizes.

Input

Selected images.

Source

The images to be saved are selected by the user and pulled from the program’s data space.

Output

The images are saved in the new location for email.  This location is shown to the user in a confirmation dialog.

Requires

The user selects the location to save the images.

Pre-condition

The album containing the image is opened and displayed in the album view section of the program.

Post-condition

Images are saved to a new location in a smaller format for email to recipient.

Side Effect

None.

 

2.3      Image Handling Operations

This section covers all the functions contained in the program for the purposes of viewing, editing and saving individual images stored in the system.  Editing operations include color adjustments, cropping and resize operations, and rotation operations.

 

2.3.1      View Images

Description

User can view individual images by selecting an album and double clicking on a thumbnail. This will bring up a full sized view of the individual image. The user can then view the other images in the album one by one as by clicking the Next Image and Previous Image buttons.

Input

Photo album is opened and the image is selected by the user.

Source

Selected image is obtained from the opened album.

Output

The individual image is opened in a new window.

Requires

The photo album is opened for image selection.

Pre-condition

User selects the individual image for viewing

Post-condition

Individual image is opened in a new window.  Next Image and Previous Image buttons become available for browsing.  Editing operations are displayed in the bottom part of the window.

Side Effect

None.

 

2.3.2      Save image

Description

This feature allows the user to save changes made to the working copy of an image. 

Input

The image viewing window is opened and the user invokes the save operation.

Source

The working copy of the user selected image is taken from the program’s data space.

Output

The old working copy of the image is overwritten with the modified copy of the image.

Requires

Image editing window is open and the image has been modified.

Pre-condition

Changes are made to an image by the user.

Post-condition

A working copy of the image is overwritten with the modified image. 

Side Effect

New working copy image is saved to disk.

 

2.3.3      Reverting to the originally imported image

Description

In the event of an undesired image change and save, this function will return the working copy of the image to its original form (at the time of importing).

Input

User activation, by clicking the “Revert to Original” button.

Source

The image currently opened for editing.

Output

The originally imported image is displayed.

Requires

The user confirms the action via the provided dialog.

Pre-condition

The image in question was imported correctly.

Post-condition

The image will be reverted to its original form. 

Side Effect

Working copy of the image is permanently removed and replaced with the originally imported image.

 

2.3.4      Color adjustment

Description

The user can change the color's brightness, contrast and saturation of the image by adjusting the color sliders found in the Adjust Color tab. The user can also convert the image to black and white using the “Black and White” button.

Input

Slider locations selected by the user.

Source

The image operated on is taken from the working copy stored in the program’s data space.

Output

The adjusted image is displayed on the image viewing window.

Requires

The image viewing window is opened.

Pre-condition

The user selects the image to be adjusted.

Post-condition

The new color-adjusted image is displayed on the window.

Side Effect

None.

 

2.3.5      Image cropping

Description

User can perform cropping on a selected image. Crop functionality can be found on the Crop/Resize tab. The user can perform free cropping or specify a specific photo sizes. The user can select from standard photo sizes 3x5, 4x6, 5x9, or 8x10. This operation allows the user to select a portion of the image.  The selection portion will become the working copy and the unselected area will be discarded.

Input

The user-selected image from photo album.

Source

The image is obtained from the working copy in the program’s data space.

Output

New cropped image is displayed on the image viewing window.

Requires

The image selected is the image stored in the photo album.

Pre-condition

The image is selected from the photo album by the user.

Post-condition

The cropped image is displayed on the image viewing window in place of the old one.

Side Effect

None.

 

2.3.6      Resize operation

Description

This function allows the user to resize images Resizing tools can be found on the Crop/Resize tab. The user can make the image larger or smaller.  The resizing factor can be specified in pixels or by a percentage.

Input

The user opens a photo album and selects an image to resize.

Source

The image is obtained from working copy of the image in the program’s data space.

Output

The resized image is displayed.

Requires

The image is selected by the user from the photo album.

Pre-condition

The user has selected an image to be edited.

Post-condition

The newly resized image is displayed on the image viewing window.

Side Effect

None.

 

2.3.7      Rotation operation

Description

This feature allows the user to rotate the image to any desired angle. The rotation tools can be found on the Rotation/Flipping tab.  Free rotation and square rotations (90/180 degrees) can be performed on the images.

Input

The user selects an image from the photo album and selects the degree of rotation using the tools given on the Rotation/Flipping tab.

Source

User-selected image from the album.

Output

The selected image is rotated and redisplayed in the image viewing screen.

Requires

The image is selected by the user, a rotation amount is selected and the Rotate button is clicked.

Pre-condition

The image is selected from the photo album.

Post-condition

The rotated image is displayed on the picture window.

Side Effect

None.

 

2.3.8      Image Flip operation

Description

The user can also perform a flip operation on the image. Flip buttons are found in the Rotation/Flipping tab. The user selects an image from photo album and invokes this operation by clicking the “Horizontal” or “Vertical” button to flip the image horizontally or vertically.

Input

Selected image from the photo album, and desired flip is specified by clicking the corresponding button.

Source

The image is obtained from the photo album

Outputs

The mirrored image displayed on the image viewing window.

Requires

The user selects the image for editing.

Pre-condition

The user is in the image editing view for the program.

Post-condition

The flipped image is displayed on the image viewing window.

Side Effect

None.

 


3         Screenshots

3.1      Import Wizard Walkthrough

3.1.1      Step one – Starting the import

Description:  This screen gives an overview of the import wizard.

Functions:      This screen contains online help information.

 

Screen 1 – The Import Wizard


3.1.2      Step two – Album selection

Description:  Lets the user type in the name of a new photo album or choose an existing photo album to add pictures to. 

Functions:      2.1.1

 

Screen 2 – Naming the album


3.1.3      Step three – Image Selection

Description:  Lets user select one or more pictures to add to the album.  At the left is the tree where you can navigate existing albums as well as the system’s directory structure.  The contents of the selected tree item are displayed in the top list box.  The selections that will be imported are displayed in the bottom list box.  The user can either use the add all images option to move all images from the top box to the bottom list box, or drag images back and forth individually.

Functions:      2.1.2

 

Screen 3 – Importing pictures via Wizard

 


3.1.4      Step four - Conformation

Description:  Displays the contents of the album.  The user can click the Finish button to complete the import process.

Functions:      This screen gives the user the option to go back and change their choices.

 

Screen 4 – Finalizing the album contents

 


3.2      Management View

3.2.1      Management View

Description:  This is where the user can view the contents of albums as thumbnails and also rename, delete, move, and copy photos.  The tree on the left contains the list of albums.  Albums in this list can be single clicked, and the thumbnail panel will refresh to show the contents of the newly selected album.

Functions:      2.1.3, 2.1.4, 2.1.5, 2.1.6, 2.1.10, 2.2.1, 2.2.2, 2.2.3

 

Screen 5 – Managing Albums

 


3.2.2      Edit View

3.2.3      Viewing an image in Edit Mode

Description:  The Edit view displays one image at a time for editing.  The “Previous image” and “Next Image” buttons are used to move through the album contents one image at a time.  The zoom in (+) and zoom out (-) buttons are always displayed in edit mode.  There are tabs for specific types of editing operations and a set of Save/Undo/Revert buttons provided for handling changes to the image.  The close button provided will return the user to the album viewing portion of the program (and prompt to save in the event changes have been made).

Functions:      2.3.1, 2.3.2, 2.3.4

 

Screen 6 – Viewing in edit mode


3.2.4      Adjust Color tab

Description:  The Adjust Color tab contains several sliders that adjust color settings for brightness, contrast, and saturation.  The “Black and White” button will convert a color image to black and white.  Literally it will set the saturation value to the minimum (left), which an equivalent operation.  If you look at Screen 7 you can see that the sliders have been adjusted in comparison to Screen 6 and the image has been altered accordingly.

Functions:      2.3.1, 2.3.2, 2.3.4

 

Screen 7 – Color Adjustment

 


3.2.5      Crop/Resize tab

Description:  A cropping size can be chosen from the dropdown box located next to the “Crop” button.  The portion of the image that is currently cropped will be outlined with a black line and everything outside the crop will be shaded as seen in Screen 8.  Clicking the crop button will apply the crop.  Resizing is done using the Height and Width dropdowns and edit boxes.  The dropdowns contain options for Percent and Inches as seen in Screen 9.  A value can be entered into each edit box and the resize is applied by clicking the “Resize” button.

Functions:      2.3.1, 2.3.2, 2.3.5

 

(this function has not yet been implemented, so the screenshot below is taken from a prototype)

Screen 8 – Using visual crop

Screen 9 – Resizing

 


3.2.6      Rotation/Flipping tab

Description:  The “Horizontally” and “Vertically” buttons will perform a horizontal or vertical flip on the image.  Screen 10 shows a Vertical Flip.  When the “Common Rotations” radio button is selected, the top drop down is enabled and the user can choose among common rotations of 90 and 180 degrees as shown in Screen 11.  When the “Free Rotate” radio button is selected, the user can choose a more specific degree of rotation as seen in Screen 12.

Functions:      2.3.1, 2.3.2, 2.3.7, 2.3.8

 

Screen 10Vertical Flip

 

Screen 11 – Choosing Rotations

Screen 12 – Free Rotation


4         Non-Functional Requirements

4.1      Development Requirements

  • The project will be developed using the Java language.  This will allow the development process to take place on nearly any computer, and guarantees development can take place on both of the target platforms.
  • Operating Systems: Both Linux and Windows will be used as the development platforms for this project.  The Java IDEs used will vary depending on the preference of each individual member.
  • Project Hosting:  Swingpix is a registered project at SourceForge.net.  SourceForge.net will provide disk space for the project’s data files and tools to assist the development teams.
  • CVS: Included in the project hosting, SourceForge.net provides a project CVS repository that will be used for concurrent versioning of the project.  Anonymous access to the repository will be provided.

 

4.2      Deliverable Deadlines

  • Requirements Document (initial) by Monday, February 24, 2003
  • Design Document (initial) by Monday, March 10, 2003
  • Beta version for testing by Monday, May 12, 2003
  • Finished product, Test documentation, User documentation and revised Requirements and Design documents by Monday, June 2, 2003

 

4.3      Hardware Requirements

  • A machine used to run the application should have at least a 200MHz Pentium Processor, 64MB of RAM and 20 MB of free hard disk space.
  • A 256 color or higher display adapter is required.
  • Supported operating systems will include Windows 98, ME, NT4, 2000, XP, and Linux.

 

4.4      Software Requirements

The finished product will be a standalone application able to run on a single machine.  In order to run the application, the system must have version 1.4.1 (or higher) of the Java Runtime Environment installed.  Other than the JRE, the finished product will not require any other software that is not included in the deliverable.

 

4.5      Performance

Events should take no longer than 1 second to begin processing when triggered by a mouse click or a keystroke. 

Any event that will take a noticeable amount of time to complete will result in the display of a wait cursor or some visual notification that the program is busy processing information.

 

4.6      Reliability

  • The average time between failures should be greater than or equal to 20 hours of operation.
  • The application should not corrupt or interfere with any existing programs already installed on the machine.
  • Probability of data corruption upon failure: There should be no corruption of the data stored by the user’s most recent save.  Any changes made after the last save will be lost upon failure.

 

4.7      Survivability

Up to date source code will be stored on the six member’s personal systems as well as a centralized location on the SourceForge.net server.  Storage at multiple locations will eliminate the possibility of losing all progress in the case of a catastrophic failure involving one of the systems.  Release versions will also be periodically backed up to permanent optical media (CD-R or comparable medium).

 

4.8      Usability

The product is aimed at the novice computer user and digital picture taker.  The basic functions that this application provides will not require any prior digital imaging experience or advanced computer knowledge of the user.  A new user should be able to use the application after minimal training.

 

4.9     Compatibility

Because this program’s intended purpose is the organization and manipulation of images obtained from digital photography, it will support the image formats commonly used in digital photography.  As such the primary image format for the program will be JPEG (a format provided by the Joint Photographic Experts Group), but will be built so that new image formats can be supported easily.

 

4.10     Ethical Requirements

Since this is an academic project, the development team must abide by the official academic honesty policy of their educational institution.  Also the project will give credit to any projects or service groups that were utilized in the creation of the program.

 


5         Licensing and Copyright

5.1      Release License

In the interest of making this program as available as possible to the general public, SwingPix will be released, upon completion of the functional aspect of the program, under the GNU General Public License.  This license will ensure that SwingPix and all works derived from SwingPix be made readily available to our target audience, the general public.  See Appendix C for the full text of the GNU General Public License.

 

5.2      Release Fees

It is not required under the terms of the GNU General Public License that SwingPix be distributed free of charge.  But in keeping with the spirit of the Open Source Initiative[4], SwingPix will be released free of charge via the project’s website, hosted by SourceForge.net[5].

 

5.3      Copyright Plan

SwingPix will be copyrighted to the SwingPix project team upon first release.  The development team at present is listed below, but is subject to future change should the team later decide to employ further resources.  Consult the project page (http://sourceforge.net/projects/swingpix) for an up-to-date list of the project team.

 

5.3.1      Current project team

Justin Berstler                         Aju Mathew                              Yinka Ogungbemi

Yinka Olabinjo                         John Rountree                        Mathew Schaffer


Appendices

A.   Glossary

Album:                        An electronic container used for storing or for collecting pictures.

Cropping:                   To cut off or trim a photograph neatly. To trim the edges of an images

CVS:                            (Concurrent Versions System) A system which lets a team of developers share control of different versions of files in a common repository of files.

GUI:                            (Graphical User Interface) The graphical representation of the system for easier interaction between users and computer.

IDE:                             (Integrated Development Environment) A programming environment that has been packaged as an application program.

Image Flip:                 A process of producing a mirror image to a source image, either horizontally or vertically.

Importing Images:     The process of extracting images from external source (such as a disk drive) and inserting them into a photo album in the system.

Input:                          The necessary data that must be entered for a function to be used

Meta-data:                  Extra textual data that can be attached to an object in order to further describe the object’s contents.

Operation:                 Any logical processes of deriving one entity from others according to a rule; a method of functioning. Series of steps performed by the system in the execution of the program.

Output:                       The end result of the input after processing by an operation.

Platform:                    An underlying system which allows programs or applications to be run, also known as an operating system.  Examples include Linux and Windows 2000.

Post-condition:         The end state of a system after it has performed an operation.

Pre-condition:           Some operations that are necessary to initiate an execution of an action.

Source:                      The data on which a function acts.

Thumbnail:                 A smaller representation of a larger image.

 


B.   Open source software references

-          The GNU Project / The Free Software Foundation (http://www.gnu.org/)
Makers of many popular Unix tools, and promoters of free software.

-          SourceForge.net (http://www.sourceforge.net/)
Project hosting and development tool provider for open source projects.

-          Open Source Initiative [OSI] (http://www.opensource.org/)
Open source promotion community and information portal.

-          Linux Online (http://www.linux.org/)
Information portal for Linux, an open source operating system.

 

 


C.   The GNU General Public License

GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
 
 Copyright (C) 1989, 1991 Free Software Foundation, Inc.
              59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
 
Preamble
 
  The licenses for most software are designed to take away your freedom to share and change it.  By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users.  This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it.  (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.)  You can apply it to your programs, too.
 
  When we speak of free software, we are referring to freedom, not price.  Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things.
 
  To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights.  These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it.
 
  For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have.  You must make sure that they, too, receive or can get the source code.  And you must show them these terms so they know their rights.
 
  We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software.
 
  Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software.  If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations.
 
  Finally, any free program is threatened constantly by software patents.  We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary.  To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all.
 
  The precise terms and conditions for copying, distribution and modification follow.
 
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
 
  0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License.  The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law:  that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language.  (Hereinafter, translation is included without limitation in the term "modification".)  Each licensee is addressed as "you".
 
Activities other than copying, distribution and modification are not covered by this License; they are outside its scope.  The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
 
  1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program.
 
You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee.
 
  2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions:
 
    a) You must cause the modified files to carry prominent notices stating that you
       changed the files and the date of any change.
 
    b) You must cause any work that you distribute or publish, that in whole or in
       part contains or is derived from the Program or any part thereof, to be
       licensed as a whole at no charge to all third parties under the terms of this
       License.
 
    c) If the modified program normally reads commands interactively when run, you
       must cause it, when started running for such interactive use in the most
       ordinary way, to print or display an announcement including an appropriate
       copyright notice and a notice that there is no warranty (or else, saying that
       you provide a warranty) and that users may redistribute the program under these
       conditions, and telling the user how to view a copy of this License. 
       (Exception: if the Program itself is interactive but does not normally print
       such an announcement, your work based on the Program is not required to print
       an announcement.)
 
These requirements apply to the modified work as a whole.  If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works.  But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.
 
Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program.
 
In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.
 
  3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following:  
 
    a) Accompany it with the complete corresponding machine-readable source code,
       which must be distributed under the terms of Sections 1 and 2 above on a medium
       customarily used for software interchange; or,
 
    b) Accompany it with a written offer, valid for at least three years, to give any
       third party, for a charge no more than your cost of physically performing
       source distribution, a complete machine-readable copy of the corresponding
       source code, to be distributed under the terms of Sections 1 and 2 above on a
       medium customarily used for software interchange; or,
 
    c) Accompany it with the information you received as to the offer to distribute
       corresponding source code.  (This alternative is allowed only for noncommercial
       distribution and only if you received the program in object code or executable
       form with such an offer, in accord with Subsection b above.)
 
The source code for a work means the preferred form of the work for making modifications to it.  For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable.  However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.
 
If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code.
 
  4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License.  Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License.  However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.
 
  5. You are not required to accept this License, since you have not signed it.  However, nothing else grants you permission to modify or distribute the Program or its derivative works.  These actions are prohibited by law if you do not accept this License.  Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it.
 
  6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions.  You may not impose any further restrictions on the recipients' exercise of the rights granted herein.  You are not responsible for enforcing compliance by third parties to
this License.
 
  7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License.  If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all.  For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program.
 
If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances.
 
It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices.  Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.
 
This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.
 
  8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded.  In such case, this License incorporates the limitation as if written in the body of this License.
 
  9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time.  Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
 
Each version is given a distinguishing version number.  If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation.  If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation.
 
  10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission.  For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this.  Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally.
 
NO WARRANTY
 
  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
 
  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.


[1] “tag” in this context refers to the attachment of textual data to a non-textual data source.

[2] see section 2.5.1

[3] See glossary for definition.

[4] See http://www.opensource.org, and Appendix B for more information on open source software.

[5] The project homepage is http://swingpix.sourceforge.net.