Sdd 4
•Als DOCX, PDF herunterladen•
1 gefällt mir•760 views
The document provides a software design description for a weather station database management system. It describes the system decomposition into five subsystems and the database subsystem's six components: API, Query Manager, Database Connection Manager, Unit Conversion, Notification Manager. It provides detailed descriptions of each database component, their classes, responsibilities, and contracts to manage interactions with the database.
![Weather Station Data Management System Software Design Document Version 2.5 4/15/2009 Document Control Approval The Guidance Team and the customer shall approve this document. Document Change Control Initial Release:1.5Current Release:2.5Indicator of Last Page in Document:Q.E.DDate of Last Review:04/15/09Date of Next Review:04/15/09Target Date for Next Update:04/15/09 Distribution List This following list of people shall receive a copy of this document every time a new version of this document becomes available: Guidance Team Members: Dr. Steve Roach B.S Evelyn Torres Customer: Dr. Craig Tweedie Software Team Members: Carmen Avila Neith Estrada Antonio Garza Albert Hernandez Veronica Valenzuela Leonel Villagomez Change Summary The following table details changes made between versions of this document VersionDateModifierDescription2.004/13/09TeamInitial Draft2.104/14/09Neith EstradaModified Sections 2,7 and 82.204/14/09Antonio GarzaModified Sections 2, 3 and 52.304/15/09Veronica ValenzuelaModified Sections 1, 42.404/15/09Carmen AvilaModified Sections 2 and 62.504/15/09Leonel VillagomezModified Section 1 Table of Contents TOC
1-3
Document Control PAGEREF _Toc227597700 ii Approval PAGEREF _Toc227597701 ii Document Change Control PAGEREF _Toc227597702 ii Distribution List PAGEREF _Toc227597703 ii Change Summary PAGEREF _Toc227597704 ii Introduction PAGEREF _Toc227597705 1 1.1Purpose and Intended Audience PAGEREF _Toc227597706 1 1.2Scope of Product PAGEREF _Toc227597707 1 1.3References PAGEREF _Toc227597708 1 1.4Definitions, Acronyms, and Abbreviations PAGEREF _Toc227597709 1 1.1.1Definitions PAGEREF _Toc227597710 1 1.4.1Acronyms and Abbreviations PAGEREF _Toc227597711 2 1.5Overview PAGEREF _Toc227597712 2 2Decomposition Description PAGEREF _Toc227597713 3 2.1System Collaboration Diagram PAGEREF _Toc227597714 3 2.2Subsystem and Component Descriptions PAGEREF _Toc227597715 4 3Detailed Description of API Component PAGEREF _Toc227597716 6 3.1API Component PAGEREF _Toc227597717 6 3.2ServerProtocol Class PAGEREF _Toc227597718 6 3.2.1Contract 1: Manage interaction between database and other subsystems. PAGEREF _Toc227597719 6 3.3DatabaseServer Class PAGEREF _Toc227597720 7 3.4PHPObjectGenerator Class PAGEREF _Toc227597721 7 4Detailed Description of Query Manager Component PAGEREF _Toc227597722 8 4.1Query Manager Component PAGEREF _Toc227597723 8 4.2SecureQueryVerifer Class PAGEREF _Toc227597724 8 4.3QueryGenerator Class PAGEREF _Toc227597725 9 4.3.1Contract 2: Construct SQL Query String PAGEREF _Toc227597726 9 4.4UpdateQueryGen Class PAGEREF _Toc227597727 10 4.5InsertIntoQueryGen Class PAGEREF _Toc227597728 10 4.6SelectFromQueryGen Class PAGEREF _Toc227597729 10 4.7RemoveFromQueryGen Class PAGEREF _Toc227597730 10 5Detailed Description of Database Connection Manager Component PAGEREF _Toc227597731 11 5.1Database Connection Manager Component PAGEREF _Toc227597732 11 5.2ConnectionExecuter Class PAGEREF _Toc227597733 11 5.2.1Contract 3: Execute a query string. PAGEREF _Toc227597734 11 5.3DataSetConfiguration Class PAGEREF _Toc227597735 12 6Detailed Description of Unit Conversion Component PAGEREF _Toc227597736 13 6.1Unit Conversion Component PAGEREF _Toc227597737 13 6.2AuxiliaryClass PAGEREF _Toc227597738 13 6.3EvaluationClass PAGEREF _Toc227597739 14 6.4ConverterClass PAGEREF _Toc227597740 15 6.4.1Contract 5: Do Unit Conversion PAGEREF _Toc227597741 15 7Detailed Description of Email Notification Component PAGEREF _Toc227597742 16 7.1Email Notification Component PAGEREF _Toc227597743 16 7.2EmailManager Class PAGEREF _Toc227597744 16 7.2.1Contract 6 Send Email Notification PAGEREF _Toc227597745 16 Appendix A: Weather Database Schema PAGEREF _Toc227597746 17 Appendix B: DataSet and Cell Objects PAGEREF _Toc227597747 18 Introduction Purpose and Intended Audience The purpose of creating a Software Design Document (SDD) is to provide an overall guidance of the architecture and design of the AWSD Database subsystem. The intent of this document is to give a detailed description of how the Database subsystem is divided in order to better fulfill the requirements of the client. Furthermore, the SDD should adequately provide any information needed by developers in order to understand the lifecycle of the subsystem and implement the Database subsystem. Scope of Product Global warming produced by activities such as, pollution from automobiles and oil refineries, has become a great concern due to its negative impact on the planet. In order to better understand how global warming is affecting the planet, ecologists are now trying to collect and study patterns of climate change. When analyzed, the collection of climate data could play a crucial role in understanding the past, present, and future climate change patterns. Due to advances in technology it is now possible to deploy weather stations around the globe to collect data about a climate such as temperature, amount of rainfall, among others automatically. The collection of data by these weathers stations gives an enormous volume of data, which makes it hard for an Ecologist to do by hand or even in a spreadsheet. Therefore, Dr. Craig Tweedie and researchers in the Systems Ecology Lab (SEL) at the University of Texas at El Paso (UTEP) are seeking to create a system on which the collection and analysis of climate data can be easily done. In response to this need the 2009 Software Engineering II class is designing and implementing an Automatic Weather Station Database system. The AWSD Database subsystem assigned to Team CAT.6 is responsible for the management of all weather station data. The management of the weather data includes allowing other subsystems a means of communicating with Weather Database. The Database subsystem is also responsible for the email notification and unit conversion functionality. References [1]. S. Roach, F. Modave, “Automatic Weather Station Database SRS”, UTEP Software Engineering 2009, [Online document], 2009 Jan 24, available at: http://courses.utep.edu/Default.aspx?tabid=40297 [2]. S. Roach, “Software Design Document”, available at: http://courses.utep.edu/Default.aspx?tabid=5661 Definitions, Acronyms, and Abbreviations Definitions CouplingThe degree to which each component relies on each one of the other component.CollaborationCooperation and interaction between components.ComponentIn this document a component refers to a subsystem or a subdivision.DatasetThe collection of data returned from the Database, usually presented in tabular form.DatabaseA comprehensive collection of related data organized for convenient access, generally in a computer.Design EntitiesSubsystems and classes.InterfaceA means of communication and interaction between two entities which could be the system and the user, as an example.MetadataData that provides information about other data. In this system, metadata describes the weather data uploaded such as time, sensor serial number, and weather station serial number.Query A command sent to a DBMS to extract or update information in the database. In this system, queries are sent to the DBMS in SQL.SchemaThe description of the tables and views in a database together with the relationships between them. Acronyms and Abbreviations APIApplication Program InterfaceAWSDAutomatic Weather Station DatabaseDBDatabaseDBMSDatabase Management SystemNMNotification ManagerUCUnit ConversionWSWeather Station Overview Throughout this document the Database subsystem will be described in terms of its decomposition, dependency and detailed design. The decomposition section contains information regarding the structure of the system along with the major division between the design entities. The dependency section describes the design entities and any collaboration within the system. Last but not least, the detailed design section provides internal descriptions of each component ant its organization. Decomposition Description The descriptions of our components will enable designers and maintainers to better identify the major entities and responsibilities of each of the entities by providing them with an encapsulated description of the main areas that our domain for database management covers. These descriptions will offer insight of the designers and maintainers on what responsibilities each entity was designed to fulfill. System Collaboration Diagram The AWSD system is divided into five design entities, these being the System (or Administrator) Tools, the Data Provider subsystem, the Search subsystem, the Data Analysis, and the Database subsystem. Each of these subsystems contains one of the main functionalities the system is to offer the user. The Database design entity is responsible for managing the database and the communication with it. The Search subsystem's main focus is the interaction that the user has in order to look up data from the database, and offering a mechanism for doing so. The Data Analysis is responsible for taking whatever data set a user generated with a search and generating analysis and plots on the given data. The Data Provider subsystem is responsible for all interaction that a user has in order to add new data to the system's database, including all security and validation checks. And finally, the System Tools design entity relates to all functionality the administrator needs in order to fully manage the system, including user interfaces to do so. In addition to the five mentioned subsystems, an Email Notification design entity, which belongs to the Database subsystem, is responsible for notifying users of changes in the data he or she may have used in the past. Figure 2.1 AWSD UML Component Diagram Subsystem and Component Descriptions Figure 2.2 Database Subsystem UML Component Diagram API Description: Provide functions for the others subsystems for them to communicate with the Weather Database. ,[object Object],Contracts: ,[object Object],Query Manager: Description: Generate an sql query given a string *Query Manager component can be found in section 4 Contracts: 2. Construct sql query and pass query to QueryExecuter Database Connection Manager: Description: Connect to the database and manages queries to retrieve and update the database. As well as generate and format the data set that is to be returned from a query. *ConnectionExecuter component can be found in section 5 Contracts: 3.- Execute a query string. Unit Conversion: Description: This component is used as the name indicates to convert units. If we have a record in the database such as temperature sensor in Celsius unit and the user wants to see those records in Fahrenheit units, we use the component of Unit Conversion to perform the task. *Unit Conversion component can be found in section 6 Contracts: 4.- Provide any unit conversion that the user wants. NotificationManager: Description: This component keeps track the changes done to data in the weather database and notifies users who requested the notification. This component also should keep track of the last run of notification process. *NotificationManager component can be found in section 7 Contracts: 5.- Send email Notifications Detailed Description of API Component API Component Purpose: Provide functions for the others subsystems for them to communicate with the Weather Database. Classes: ServerProtocol, DatabaseServer, PHPObjectGenerator, WebServerManager. Figure 4.1 API Component UML Class Diagram ServerProtocol Class Description: Responsible for receiving incoming requests from other subsystems. Super Classes: none Private responsibilities: ,[object Object]](https://image.slidesharecdn.com/sdd4-090811051756-phpapp02/85/Sdd-4-1-320.jpg)
![Manage type of request for storing or retrieving data.Contract 1: Manage interaction between database and other subsystems. Description: Manage incoming requests from other subsystems to the database. Responsibilities: ,[object Object]](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)
Empfohlen
Weitere ähnliche Inhalte
Was ist angesagt?
Was ist angesagt? (14)
Ähnlich wie Sdd 4
Ähnlich wie Sdd 4 (20)
Mehr von Auro Infomation Technology
Mehr von Auro Infomation Technology (10)
Kürzlich hochgeladen
Kürzlich hochgeladen (20)
Sdd 4
- 3. Translate from PHP instances to Java instances and vice versa.
- 8. Know the rules to verify security
- 10. Inform of an unsafe query
- 12. Know how to construct appropriate select, update, remove, or select sql query string
- 21. Close the connection to the database.
- 22. Execute a data retrieval query string.
- 27. Identify operators in the formula.
- 30. Get a list of affected users from the database.