Component-Level Design: Translating Design Model Into Operational Modules

1. Chapter 11 CS 8532: Advanced Software Engineering Dr. Hisham Haddad • Class • will • start • momentarily. • Please Stand By …

2. Component-Level Design Highlights of translating the design model into operational modules/components Chapter 11

3. Component Design - 1 What is it? Taking the architectural design (high-level abstractions) into a lower-level procedural details (i.e., filling the operational details of individual modules of a SD or class operations of an OOD). It is called procedural design (object design in OOP) What operational details? - Sequence - Condition Structures - Repetition Structures

4. Component Design - 2 Why needed? - To bring the design model closer to the source code of the implementation language (translation the design to operational elements) - Help verify correctness of previous layers of the design (data, architectural, and interface of SD or object and message design of an OOD). - Reduce potential source code errors in the target code. - Produce less complex source code that is efficient, readable, testable, and maintainable.

5. Component Design - 3 What is a component? • OMG Unified Modeling Language Specification [OMG01] defines a component as: “a modular, deployable, and replaceable part of a system that encapsulates implementation and exposes a set of interfaces.” • OO view: a component contains a set of collaborating classes. • Conventional view: a component contains logic, the internal data structures that are required to implement the processing logic, and an interface that enables the component to be invoked and data to be passed to it. • Component-based development view: a component is an already developed, proven, and tested operational software module – i.e., available for reuse (Ch-30)

6. OO Analysis OO Design Implementation OO Testing Deployment OO Analysis OO Design Implementation OO Testing Deployment Object Relationship Modeling Class Design Sub-System Design Class Modeling Object Behavior Modeling Responsibilities Design Message Design OOD View

7. a n a P r i n t J o b n u m b e r O f P a g e s n u m b e r O f S i d e s p a p e r T y p e m a g n i f i c a t i o n p r o d u c t i o n F e a t u r e s d e s i g n c o m p o n e n t c o m p u t e J o b C o s t ( ) c o m p u t e J o b p a s s J o b t o P r i n t e r ( ) P r i n t J o b i n i t i a t e J o e l a b o r a t e d d e s i g n c l a s s P r i n t J o b r i o r i t y t o t a l J o b C o s t W O n u m b e r p a s s J o b t o P r o d u c t i o n ( ) c o m p u t e P a g e C o s t ( ) c o m p u t e P a p e r C o s t ( ) c o m p u t e P r o d C o s t ( ) c o m p u t e T o t a l J o b C o s t ( ) b u i l d W o r k O r d e r ( ) c h e c k P r i o r i t y ( ) p a s s J o b t o P r o d u c t i o n ( ) l y s i s c l a s s OO Component Figure 11.1, Page 295 b < < i n t e r f a c e > > c o m p u t e J o b c o m p u t e P a g e C o s t ( ) n u m b e r O f P a g e s c o m p u t e P a p e r C o s t ( ) n u m b e r O f S i d e s c o m p u t e P r o d C o s t ( ) p a p e r T y p e c o m p u t e T o t a l J o b C o s t ( ) p a p e r W e i g h t p a p e r S i z e p a p e r C o l o r m a g n i f i c a t i o n c o l o r R e q u i r e m e n t s p r o d u c t i o n F e a t u r e s c o l l a t i o n O p t i o n s b i n d i n g O p t i o n s c o v e r S t o c k < < i n t e r f a c e > > b l e e d i n i t i a t e J o b p b u i l d W o r k O r d e r ( ) c h e c k P r i o r i t y ( )

8. Conventional Component Figure 11.3, Page 297

9. Component-Level Design Principles* • The Open-Closed Principle (OCP). A module/component should be open for extension but closed for modification. Use <interfaces>(see figure 11.4, page 299) • The Liskov Substitution Principle (LSP). Subclasses should be substitutable for their base classes. Use <pre> and <post> conditions that base and derived classes satisfy. • Dependency Inversion Principle (DIP). Depend on abstractions. Do not depend on concrete components. Use abstraction more often. • The Interface Segregation Principle (ISP).Many client-specific interfaces are better than one general purpose interface. Use specialized interfaces to serve different clients of a class. *Source: Martin, R., “Design Principles and Design Patterns,”

10. Class Packaging Principles* • The Release Reuse Equivalency Principle (REP). The granule of reuse is the granule of release. Group related classes into packages so that they are managed and controlled as new versions, rather than updating individual classes. • The Common Closure Principle (CCP). Classes that change together belong together (Cohesion principle). Group related classes into packages for effective change control and release management. • The Common Reuse Principle (CRP). Classes that aren’t reused together should not be grouped together (easy to update). Group related classes into packages so that un-related classes are not changed and unnecessary integration testing is reduced. *Source: Martin, R., “Design Principles and Design Patterns,”

11. Component-Level Design Guidelines In addition to design Concepts and Principles(Ch-9): • Components - Naming convention: meaningful names for components and operations derived from the architectural model. • Interfaces - Interfaces provide important information about communication and collaboration (helps achieve the OCP) • Dependencies and Inheritance - Model dependencies from left to right and inheritance from bottom (derived classes) to top (base classes). - Represent dependencies via interfaces rather than component-to-component dependency.

12. Again, Cohesion and Coupling Cohesion and coupling are essential to component-level design. Conventional view: cohesion is the “single-mindedness” of a module OO view: cohesion implies that a component or class encapsulates only attributes and operations that are closely related to one another and to the class or component itself. Conventional view: coupling is the degree to which a component is connected to other components and to the external world. OO view: coupling is the a qualitative measure of the degree to which classes are connected to one another. See page 303 - 306.

13. Component-Level Design - 1 Generic Steps (for OOD): 1. Identify all design classes that correspond to the problem domain (in the analysis and architectural models) 2. Identify all design classes that correspond to the infrastructure domain (not part of the analysis or architectural models) 3. Elaborate all design classes that are not acquired as reusable components. • Specify message details when classes or components collaborate (from collaboration diagrams). • Identify appropriate interfaces for each class or component. • Elaborate the attributes and define data types and data structures required to implement them. • Describe processing flow within each operation in detail.

14. Component-Level Design - 2 4. Describe persistent data sources (databases and files) and identify the classes required to manage them. 5. Develop and elaborate behavioral representations for a class or component (State/Statechart diagrams). 6. Elaborate deployment diagrams to provide additional implementation detail on the key locations of components. 7. Factor every component-level design representation and always consider alternatives (component internal improvements) Please see figures 11.6 – 11.9, and 9.7.

15. Object Constraint Language (OCL) - Complements UML by allowing the use of formal grammar and syntax to construct unambiguous statements about various design model elements. - Simplest OCL language statements are constructed in four parts: • Context: defines the limited situation in which the statement is valid; • Property: represents some characteristics of the context (e.g., if the context is a class, a property can be an attribute) • Operation: manipulates or qualifies a property • Keywords: used to specify conditional expressions

16. OCL Example OCL invariant statement: context PrintJob::validate(upperCostBound : Integer, custDeliveryReq : Integer) pre: upperCostBound > 0 and custDeliveryReq > 0 and self.jobAuthorization = 'no‘ post: if self.totalJobCost <= upperCostBound and self.deliveryDate <= custDeliveryReq then self.jobAuthorization = 'yes' endif

17. Algorithm Design It is the the closest design activity to coding. Common approach: • review the design description for the component • use stepwise refinement to develop algorithm • use structured programming to implement procedural logic • use ‘formal methods’ to prove the logic

18. open walk to door; reach for knob; open door; repeat until door opens turn knob clockwise; walk through; if knob doesn't turn, then close door. take key out; find correct key; insert in lock; endif pull/push door move out of way; end repeat Refinement

19. Algorithm Design Model Procedural design can be represented by different notations. The goal is to represent the algorithm at a level of detail that can be reviewed for correctness and quality, and is easy to translate to source code. Representation options: - Graphical notation (flowchart, box diagram) - Decision table notation - Pseudocode notation (PDL) <<choice of many>> - Programming language syntax Conduct walkthroughs to assess quality.

20. Structured Programming for Procedural Design Uses a limited set of logical constructs (sequencing, conditional, loops) Leads to more readable, testable code. Important for achieving high quality, but not enough.

21. a x 1 b c x 2 d x 3 f e x 4 g x 5 Flow-Chart Notation

22. Decision Tables - 1 Good for representing procedural details of algorithms with complex combinations of conditions and alternative actions. This notation translates conditions and actions of a procedure/method into tabular format. It helps verify logic and facilitate testing.

23. Decision Tables - 2 Example scenario: (see another example page 318) “If the customer account is billed using fixed rate method, a minimum monthly charge is assessed for consumption of less than 100 kwh. Otherwise, computer billing applies schedule A rate structure. However, if the account is billed using variable rate method, a schedule A rate structure will apply to consumption below 100 kwh, with additional consumption billed according to schedule B” Actions: min charge, A rate, B rate, and others. Conditions: fixed rate, less than 100 kwh, variable rate, more than 100 kwh

24. Decision Tables - 3

25. if condition x then process a; else process b; endif if-then-else PDL - Easy to combine with source code - Machine readable, no need for graphics input - Graphics can be generated from PDL - Enables declaration of data as well as procedures - Easier to maintain Program Design Language - 1

26. Program Design Language - 2 In addition, PDL can be - a derivative of the high-level programming languages, such as Ada PDL, - a machine readable and processable, - embedded with source code and therefore easier to maintain, - represented in great detail, especially if the designer and coder are different, and - is easy to review. See example of PDL syntax page 340.

27. Attributes of a Representation Notation - 1 Attributes to compare and assess a design notation: - Modularity: Support for modular design. - Simplicity: Simple to learn and easy to read and use. - Editing: Support for design changes and software evolution. - Machine readability: Can be read by computer-based development systems. - Structure enforcement: Support and enforce the use of structured programming constructs.

28. Attributes of a Representation Notation - 2 - Automatic processing: Can be processed to generate useful information about design correctness and quality. - Data representation: Ability to represent global and local data structures. - Logic verification: Ability to verify design logic and improve testing. - Code-ability: Can be easily converted to source code.

29. Suggested Problems Consider working the following problems from chapter 11, page 322: 11.1, 11.2, 11.3, 11.7, 11.8, 11.10, 11.12, and 11.14. NO submission is required. Work them for yourself!