Home

User Manual

1. 55 Editiag OpHORsus ees oet echec EROS 55 Font OpBorS epesi ev xe REPRE 56 Miscellaneous Options 000 cece eee 56 Window Options ccn eer eee Pace tend e er u 56 ZOOM ODUONS st Saas CESARE E Vra AE wager 57 coin This Chapter sred aan set beatae ss 59 The DoME Shelf esses 60 Shelf BFOWSers hee e Peele eed ee ho Ceres 60 The DoME Data Dictionary 0 000005 62 Viewing amp Editing Dictionary Items 62 Hierarchical Decomposition in DoME Models 64 Multiple Diagrams in a Single Model 64 Notations That Support Hierarchical Decomposition 64 Parent Diagrams Subdiagrams amp Referenced Files 65 Parent Object Identifiers 5e sx donate te die eerte EUR 65 Creating a Parent Object iin oie eed eee ek S 66 Creating Subdiagrams amp File References 66 Model Editor Window Menu sess 67 Change Propagauonevesi yc veh REOR e Mee tes YR 67 Graph Labelsios dca ees e e E Sa ERR 67 Breaking Parent Object Subdiagram Links 67 Cause amp Effect in Hierarchical Models 68 Saving amp Printing Hierarchical Models 68 Contents 5 lips Hints amp Work Arounds A Coad Yourdon O O Analysis B Colbert Methodology C Data How Diagram D ProtoDoME F Guide DoME Start Up Script Capability 4 amp 4 aser er ne 69 vo I This Chapter as vex uos e ERXEAVEWEREME E a
2. D ProtoDoME New ProtoDoME Based Model Editor fal an unsaved Experimental Graph File Edit View Layout Tools Window Hel Bia 3 gaum To easily facilitate the sharing of your new editor it is best if your new DoME Tool Specification is saved in an appropriate location 7 8 Using the same directory structure used for other DoME notations create a new directory and a specs subdirectory for your new model type Save your DoME Tool Specification in the new specs subdirectory you created in the previous step Be sure to use the met suffix in the file name for your new specification also used for other DoME specifications When you have saved your specification the DoME Tool Specification model editor will display the name of your new specification in both the title bar and context properties graph label area in the editing pane see below D ProotoDoME Figure 64 Saving Your New Model Saved DoME Tool Specification fa example met Experimental Graph Specification i Layout Tools Window Hel FE n example met Model Type Experimental Graph L 4 Graph Tool Palette Entity Entity Link O Use the information in the remainder of this appendix to complete the specification for your new notation and model editor As you add and change properties appearances and other parameters in the DoME Tool Specification window you will be able to see the changes instantl
3. Note Notation spec ific node tools Notation spec ific connectortools Drawing Toolbar 3 DoMEwide Features Although the illustration below shows a Data Flow Diagram model editor the editors for all DoME notations will always appear similar Differences you will notice from notation to notation occur primarily on the drawing toolbar where notation specific tools nodes and connectors are available For detailed information on notation specific tools and functions see the appendix related documentation or online help that applies to the notation you are currently working with DoME Model Editor Common Features fal an unsaved Data Flow Diagram DFD gt File Edit View Layout Tools Window Hel Cope al AAA E r a NoName L J Z oe a a Graph Label Nu Message Area 32 Scrollbar Zoom Progress MeterArea Bring Launcher to front Editing Pane The following pages describe the tools features and functions common to all DoME model editors 3 DoMEwide Features Model Editor Title Bar Model Editor Menus Model Editor File Menu Ctrl N Open Merge Revertto Saved Save Ctrl S Save As Print Ctrl P Close Ctrl V Close Model Hide Model F Guide Model Editor Common Features The title bar at the top of a model editor window displays the name of the model file you are wor
4. E r e l As with any other DoME notation click the NEW button on the Launcher Open Models Browser or model editor standard toolbar to start a new Colbert OOSD Project model The SELECT MODEL TYPE dialog box appears B Colbert Methodology DoME s Colbert Project Tool Figure 39 Parent Diagram Subdiagram Top of Model Diagram Data Dictionary Hierarchy Map Overlays Set Change Color Description Coloring qa amp S Grid Standard Toolbar Drawing Toolbar Message Area Object Class Diagram Object Oriented Statechart Creating Multi Diagram Hierarchies in a Colbert Model Select Model Type List L3 x Select odel Type Coad Yourdon OOA Colbert OOSD Project Data Flow Diagram DFD Document Outline DoME Tool Specification IDEF 0 Diagram IDEF 1x Diagram Multi Page Model Petri Net Model Projector Diagram ProtoDoME Model State Transition Diagram User Defined Property Specification Y Cancel When you select COLBERT OOSD PROJECT in the list and click lt OK gt a new Colbert Object Interaction Diagram OID window appears A new Colbert OOSD Project model always begins with an Object Interaction Diagram and the other two diagram types are accessible from there e You may create new OCD and OOS diagrams for your model by selecting the options available at the bottom of the root initial OID model editor VIEW menu e You may open
5. About Displays DoME tool version and copyright information for the specific notation you are using Editor Help Topics DoME Help About Model Editor The row of buttons just below the menu bar provides quick Standard Toolbar access to some of the more often used menu commands see previous topic for descriptions Figure 19 Model Editor Standard Toolbar Buttons New SELECT MODEL E Ql jd nia E sab TYPE list Open OPEN dialog box Save SAVE AS Bring dialog box Launcher to front Print PRINT OPTIONS Parent Diagram dialog box bring to front roperties P Adjust Zoom Square Connector Route Set Item Color 90 degree angle routes on selected connector 38 3 DoMEwide Features Model Editor Common Features Model Editor Drawing Toolbar f Guide The DoME model editor drawing toolbar for each notation is unique containing both common and specialized tools and objects that simplify the creation and editing of models Selecting a tool or object To select a tool or object either Click SELECT on its button in the drawing toolbar or Type the shortcut key for the button see HELP EDITOR HELP TOPICS DRAWING TOOLBAR KEYBOARD SHORTCUTS for a list of shortcuts or view shortcuts in the tooltips When a tool or object is active its button is highlighted in the drawing toolbar Only one tool can be selected at a time Creating Multiple Nodes e If
6. Accessory Attached to a node or connector will not affect the object s size or shape Click lt SELECT gt on the accessory icon in the drawing toolbar then click lt SELECT gt directly drop it on the object that you want to contain the accessory Alter See Projector Alter Archetype Object node type designated as a reusable component in the DoME Shelf Classes are used to organize archetypes Artifacts Code documents test cases and so forth created by a generator Auto scroll The ability to move an object or group of objects beyond the visible bounds of the editing pane Back end See Generator Bipartite A class of formal diagram that always contains exactly two types of nodes Any given node cannot be connected to another of the same type Boundary points In hierarchical models indicate entrance and exit points to and from parent diagrams and subdiagrams Clipboard DoME A designated area in memory that contains the most recently copied or cut text or graphical object s Unlike the clipboard used in other environments e g Windows text and graphics in the DoME clipboard can only be accessed from within the DoME environment Configuration identifiers If a hierarchical model can support more than one subdiagram per node or connector each subdiagram can be assigned one or more configuration identifiers Identifiers are essentially names used consistently throughout a hierarch
7. Quality File Edit Scale seconds Worst E 0o05 Pen on Record D 5064 Past 0005 O Curent B For more information see The DoME Data Dictionary on page 62 B 7 DoME s Colbert Project Tool B 8 Nonvisual Objects Concept Quality Question Requirement Figure 42 B Colbert Methodology The Colbert OOSD notation includes some entities that are nonvisual in nature CONCEPT QUALITY QUESTION and REQUIREMENT These objects can be applied to allocated to or otherwise referenced by nodes and connectors in any Colbert diagram Use the EDIT CREATE submenu in any Colbert diagram to create one of these nonvisual objects Upon creation the Data Dictionary will open with the newly created object selected to allow editing of the new object s properties To create a reference from a nonvisual object to a node or connector on a diagram first open the Object Inspector select PROPERTIES on the node or connector A window similar to the following example appears Object Inspector for Nonvisual Object Reference lolx Bay External Object Reference File Edit View Name Transmission Available Driver Responsivenal Brake Responsiver Accuracy Select the CONCEPTS QUALITIES QUESTIONS or REQUIREMENTS tabbed page depending on which type of nonvisual object you wish to reference e Objects listed in the IN USE list are nonvisual objects
8. string that is used to prefix the paragraph counter number Start Value The initial number to use for the first paragraph Style The numbering style to use for the paragraph counter number Suffix A string that is appended to the paragraph counter number Type The kind of counter It s either assigned a new value increments itself by one maintains its value or is a text constant Auto Number Type Used to specify the type of the auto number counter Character Style Captures all relevant information to completely describe a reusable font Name The name of the character style Specification The details of the character style Character Specification Captures all relevant information to completely describe a font Case The capitalization style applied Color The color of the characters Family The font family used to describe the font such as Courier or Times Position The position of the text 1 MetaScribe Output Formatters E MetaScribe cy L 4 Posture The posture of the font Size The font size in points Strike Through Display in strike through style Underline Display in underline style Variation The compactness of the font as a percentage Weight The intensity of the font Figure68 MetaScribe Information Model Paragraph Alignment Page Specification Center Justified
9. 42 Select EDIT PASTE The node returns but without its connector s You may think this is a bit odd but the reason is that you only copied the node not the node and the connector s S Cut only saves what is selected transitively attached connectors are not saved 43 Select EDIT PASTE again A copy of the Process A node is added to the diagram slightly offset from the original Notice again that no connectors reappear 19 Deleting Objects Deleting Objects Undoing Actions 20 2 Quick DoME Tour While CuT and PASTE give you some of the functionality you need sometimes you will simply want to toss out a node or connector 44 Click SELECT on a node with a connector attached 45 Select EDIT DELETE from the menu bar The object and connector are deleted If you were to use the PASTE function now the deleted object would not return DELETE and say Good bye and CUT and PASTE are not the same operation But wait There s still hope if you delete an object you hold near and dear 46 Select EDIT UNDO from the menu bar If you have done nothing since deleting that last node note that the object does come back now with any attached connectors The good news is that the UNDO command can reverse the effects of a DELETE UNDO can also reverse the effects of almost any other operation including CUT PASTE node creation and connector routing UND
10. Note Remove bend Subject Gen Spec Part Whole Enumeration Enumeration Constant Before you get started with a CYOOA model it s important to discuss a possible point of confusion There is only one correct order for creating Gen Spec or Part Whole relationships in CYOOA models This order restriction is necessary in order to generate the correct code when your model is compiled The following steps prescribe the acceptable order 1 Select the CLASS amp OBJECT node in the drawing toolbar and place two nodes on the editing pane Place the nodes as shown in Figure 31 Gen Spec or Part Whole Relationship Creation Order first set of Alpha and Beta nodes to the left The Importance of Order in Model Creation A Coad Yourdon O O Analysis A 4 Figure 31 PID Gen Spec orPart Whole Relationship Creation Order fe Order O0A File Edit View Layout Tools Window Help Destination 2 Select the GEN SPEC or PART WHOLE node in the drawing toolbar and place it between the Alpha and Beta CLASS amp OBJECT nodes DoME will prompt you with a floating connector attached to the mouse pointer to select the link s destination Click lt SELECT gt on the Alpha node as shown 3 Complete the relationship between Alpha and Beta by attaching a SMART CONNECTOR from the Beta node to the GEN SPEC or PART WHOLE node between Alpha and Beta e If you la
11. Object Label Text The expression must return a string DoME uses this string to render the name label for the instance Typically this is some enhancement to the name property of the instance For example append name self thing Creation Check The expression must return a boolean value If the expression returns f creation of the instance is aborted Otherwise the instance is created The argument to the method is the diagram that would contain the new instance Creation Cleanup This method is called immediately after the new instance is created The expression may contain any actions you want The return value is ignored Deletion Check The expression must return a boolean value If the expression returns f deletion is aborted If you want the user to be notified of the reason the method must do this DoME will not do this automatically If the expression does not return f the node is deleted Developing Your New Model Type D ProtoDoME Node Elements H Can a Node Element be Contained by More than One Class D 30 Deletion Cleanup This method is called immediately after the instance is deleted The expression may contain any actions you want The return value is ignored A node element is a kind of object that is contained inside of a node with a location specified by the user Such a containment relationship is specified using the element hub triangle with an e in i
12. R Reference file An existing model linked from a parent object in a hierarchical model Refresh This command redraws the currently displayed diagram to increase clarity The extensive refresh command redraws diagrams and checks the integrity of all nodes and connectors Reuse software DoME provides the ability to reuse both active windows and software objects artifacts Reuse repository DoME s Shelf can be used by some notations to generate and store reusable software components Route point The location of a bend in a connector for aesthetic reasons RPC Remote Procedure Call A tool integration mechanism supported by Projector Alter RTF Rich Text Format Rubber banding Clicking and dragging the mouse pointer around a group of objects to select them Glossary 5 Glossary 6 Glossary Schema A description of a set of types and their interrelationships A relational database schema defines a set of tables and their keys Semantics diagram See Diagram semantics Shelf DoME reuse repository for object archetypes Shortcut Keyboard key combination used to perform a specific action Software reuse See Reuse software Specification model In the DoME environment every notation requires a specification that dictates the set of rules required to implement the methodology SOL Standardized Query Language A programming language used primarily to facilitate cross ap
13. Save Launcher Position Use this check box if you want DoME to remember the position of the Launcher window and position it in the same place the next time you start DoME Tool Directories Use these fields to specify new tool directories that should be associated with DoME The directories are searched for DoME related files such as DoME Tool Specifications Alter files and document registration files A tool directory is expected to follow the following layout registration files are placed in the etc directory Alter files are placed in the lib directory and DoME Tool Specifications are placed in the specs directory This page contains the following options Initial Window Parts Check these boxes to display the standard toolbar drawing toolbar and message area in all model editors Active Tooltip Help Check this box if you want to display tooltips on all DoME windows Reuse Diagram Windows Check this box if you want to reuse currently opened editing windows to start new diagrams rather than opening new windows each time 3 DoMEwide Features Setting Your DoME Desktop Options Zoom Options This page contains the following options Initial Zoom Factor The currently displayed scaling percentage will be the initial zoom factor Use the Zoom Steps list to select a new initial zoom factor Zoom Steps Use this list to modify Add Remove Change the Zoom selections available in model editor windows
14. 3 DoMEwide Features Overlays See Working with Diagram Overlays on page 51 for more information on overlays This submenu has the following commands Create Use this selection to create a new overlay on the currently displayed diagram Edit Use this selection to open the DoME Overlay Editor window for the currently displayed diagram Display All Deactivate all overlays so all objects will be visible on the currently displayed diagram Overlay Names Click to display a specific overlay Set Change Color Use this dialog box to set the color that DoME will use to mark changes on the currently displayed diagram When semantic changes are made to a diagram item e g its name is changed DoME sets its color to the diagram s current delta color You can choose from eight colors which correspond to the eight colors commonly found in word processors Description Coloring Toggles the description coloring on off Description coloring is used to show which objects have non empty descriptions To do this DOME shows objects that have descriptions as orange and those that don t as black Normal user defined coloring is temporarily suspended during description coloring You will not lose the colors if any you have previously assigned to objects by using description coloring the previous colors will return when description coloring is turned off Grid Use this dialog box to set snap gridding for the curr
15. Fie Menu DoME Launcher O pens the SELECT MODEL TYPE list which lists all notations available in DoME Open Save All Recent Files ES Opensa dialog box that lets you select and open an existing model Exit Saves all open models DoME prompts you P to save or discard changesto curently open modelsbefore shutdown Lists models that have been recently opened and lets you select a file for viewing editing When you click the VIEW menu you can toggle the Launcher toolbar or transcript area on off View Menu DoME Launcher v Transcript When you click the TOOLS menu you can open the Open Models Browser access optional Projector Alter tools view change your DoME desktop options or reset tool caches Tools Menu DoME Launcher Opensthe OPEN MODELS BROWSER window which lets you work with a list of all open models You can create open edit save orclose models from this window See topic in this chapter These optional Projector Alter tools are described in the Clearsthe tool cachesso that DoME Extensions Manual new DoME Tool Specifications can be added to DoME without having to restart DoME Browse Open Models Alter Evaluator Alter Projector Browser Options Reset Tool Caches Permits you to change a wide range of DoME desktop options to suit your working habitsjand preferences See topic in this chapter 29
16. FrameMaker PostScript and Adobe are registered trademarks of Adobe Systems Inc Adobe also owns copyrights related to the PostScript language and PostScript interpreter The trademark PostScript is used herein only to refer to material supplied by Adobe or to Adobe defined programs written in the PostScript language Solaris is a trademark of Sun Microsystems Inc UNIX is a registered trademark of UNIX System Laboratories Inc X Window System and X11 are trademarks of X Consortium Inc Other products or services mentioned herein are identified by trademarks designated by the companies that market those products or services Make inquiries concerning such trademarks directly to those companies Contents Za AZY Preface L Introduc ing DoME 2 Quick DoME Tour F Guide About This G ide so iia exe ties t erpiar SQ CENE oi vi Revision History 2k Chess exe Wek ERE OE meee EU vii Related Documents v 4e id Exe bx Rer EX ee EUREN arenira vii Conventions Used in This Guide viii Appearance of Windows amp Screen Elements viii Typographic Conventions 000000 Viii The Mouse Button Dilemma cor te ix Mouse Button Operations csse dur RR es x How to Get Started err ERR EE RR RC RC ees x How to Reach Us uua doe rra RDA T Cad pedo xi s In This Chaplet ss sans axsa ki 4a XE A REPRE PER vad 1 What is DOME 24i cse Et tno eered Ede d Es 2 A Brief Look
17. Legal Notices Trademarks Copyright 1992 1999 by Honeywell Inc This is version 5 2 of the DoME Guide Email dome info htc honeywell com Web www htc honeywell com dome The information contained in this guide is subject to change without notice Neither Honeywell nor the developers of DOME make any warranty of any kind with regard to this guide or its associated products including but not limited to the implied warranties of merchantability and fitness for a particular purpose Neither shall Honeywell nor the developers be liable for errors contained herein or direct indirect special incidental or consequential damages in connection with the performance or use of this guide or its associated products Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one Interleaf is a registered trademark of Interleaf Inc Macintosh is a registered trademark of Apple Computer Inc Microsoft Windows 95 and Windows NT are trademarks of Microsoft Corp Microsoft and Windows are registered trademarks of Microsoft Corp VisualWorks ia a registered trademarks of ObjectShare Inc
18. NOTE included with most DoME model editors as well as the specialized nodes connectors and tools shown below Figure 43 Object Interaction Diagram OID Model Editor fel Context OID Select Move File Edit View Layout Tools Window Help Add bend Active Object Not oS ee Context oD Passive Object Uh Remove bend Extemal Object Data Flow Object Grant Flow 7 Interaction o gt e gt eo Object Give Flow Eror Flow Working with A Colbert Object Interaction Diagram is a diagram in which Objects nodes represent objects There are two types of objects in an OID Internal and External Both types have one visual property IsMultiple The IsCollection property is either true or false Internal objects have an additional visual property Kind An object s Kind property can be active or passive Um An object s default properties are Kind Active and IsMultiple false B Colbert Methodology Colbert Object Interaction Diagrams If you create an internal object of one kind and later decide to change it to a different kind modify its Kind property using the Object Inspector When you apply the change the object s shape will change to reflect its new kind The size of an object can be determined automatically by its name label size or manually by selecting the object and dragging one of the four selection markers in or out Before you get started let s look a
19. Tab Stops The tab stops associated with the paragraph Widow Lines The minimum number of lines of the paragraph that shall be kept together at the beginning of a page Segment A segment is a portion of a paragraph that may have unique character display information Character Override Changes made to the global character style that cause the segment to be displayed in a yet more Output Formatters E 14 1 MetaScribe unique manner Character Tag Information that describes how the segment should be displayed to the user Tab Alignment The tab alignment is used to describe where the text should be positioned with respect to the tab stop location Tab Stop Describes the position of a tab stop Alignment The alignment of the tab stop Leader The string to be repeated from the last text to the tab location Position The distance in inches from the left margin to the tab location Text Text is a kind of segment that is made up of the characters that the user types in Content The characters making up the text 1 MetaScribe Integration with DoME Adding a Document Specification Integration with DoME The DoME document generation dialog was extended to support MetaScribe based document specifications and output formats The user selects the Tools gt Document Generator menu entry to open the document generator dialog from which the document to be pr
20. e To look at or modify a specific item s state first select the item type under the Data Dictionary VIEW menu then select the item in the list at the top of the window Select the appropriate tabbed page to access the information you want to view or work with To undo the most recent change you have made in the dictionary select EDIT UNDO REDO in the Data Dictionary menu bar To go directly to a specific item on its diagram in the model first select the item in the Data Dictionary list then select EDIT FOCUS in the Data Dictionary menu bar The item s diagram moves to the front with the Data Dictionary item selected e Select EDIT DELETE in the Data Dictionary menu bar to delete the currently selected item e Select EDIT FIND to locate text or unset item names descriptions or properties in the Data Dictionary 4 DoME Advanced Features The DoME Data Dictionary Us The Data Dictionary initially lists all items in the model at the time the dictionary was opened Edits performed with the dictionary open are automatically updated as they occur Figure 27 Data Dictionary Window ngu Empisyerberod ra ulla ane PrintogiofS alere died ce Obert Color rz Frese ef cg cg cau rad cB cg ca LEN The data dictionary will initially display the information for the selected object If the data dictionary is open while you select a different object and then invoke the VIEW DATA DICTIONARY menu comma
21. 60 Browser 60 Follow User Navigation checkbox 62 shortcut keys D 17 shortcuts keyboard 26 E 3 Smalltalk 5 software reuse 4 source code 2 spread 73 Index square new connectors 73 square node corners D 11 standard toolbar 12 38 starting DoME 8 start up script 69 State Transition Diagram 5 subdiagram 4 64 creating 21 cutting 20 deleting 20 subdiagrams D 13 D 22 D 29 submenu specifications D 37 T terms glossary of Glossary 1 text height D 35 tips hints amp work arounds 71 token 4 tool Add Bend 17 Remove Bend 18 Select Move 13 15 tool button icons D 16 toolbar 28 drawing 12 standard 12 tooltips 10 27 top left D 9 top right D 9 transcript area Launcher 9 28 transient D 35 U undo 15 20 62 UNIX viii 8 printernames 44 unsettability D 36 User Defined Property Specification 5 V visualimpact D 35 Ww widget label D 34 Windows viii 8 9 working with multiple objects 16 X XWD bitmap 44 Z Zoom 22 73 Index 7
22. Boundary Point on Subdiagram Cruise Control File Edit View Layout Tools Window Help F T Cruise Control L 4 On Compute Acceleration Off x A Watch Activated OK to accelerate ProtoDoME m In This This appendix includes the following topics Appendix F Guide What is ProtoDoME page D 2 How ProtoDoME works page D 2 Creating a new DoME Tool Specification page D 3 Naming your new model type page D 5 Viewing your new model editor page D 5 Saving your new model page D 6 Developing your new model type page D 8 The impact of changes on existing models page D 39 Creating plug in model types page D 42 What is ProtoDoME What is ProtoDoME Figure 60 DoME Tool Specification 7 Language DTSL included with all DOME packages ProtoDoME directly interprets and runs new notations and model editorsfrom standard DoME Tool Specifications D 2 D ProtoDoME Supported by VisualWorks development tools DoME has always offered a great deal of flexibility in the prototyping and production of graphical model based development environments Using DoME as a powerful launch point system designers and developers have been able to easily prototype domain specific notations and general purpose tools based on new visual grammars in a matter of a few hours or days With DoME s ProtoDoME option you now have the ability to design build and run new to
23. C amp O Node Service Properties C amp O Node Service Properties A 8 SVC A Coad Yourdon O O Analysis Computed Stored The storage class for an attribute can be either stored or computed A stored attribute is generated as an instance variable slot column or other direct storage mechanism that the target has available A computed attribute has no direct storage and is instead computed from other stored or computed values DoME may generate access stub methods for computed attributes depending on the target system Ordered Unordered Similar to the uniqueness property an unordered attribute has no restrictions on the values placed in it The restrictions on an ordered attribute depend on whether the attribute is a single value or a collection Some generators ignore this property altogether An ordered single valued attribute acts like a sort field for the class The values in an ordered collection attribute are guaranteed to stay in the order in which they are inserted Using the SERVICE tool on the drawing toolbar you can insert services into Class amp Object C amp O nodes on your CYOOA diagrams C amp O node service properties are accessed by clicking the PROPERTIES button on the standard toolbar with a service selected in a C amp O node see example below Service properties are described in the following paragraphs Return Type You can set the return type of a service to be one of the bas
24. DoME Launcher Launcher Window Menu Figure 14 Launcher Help Menu Figure 15 30 3 DoMEwide Features When you click the WINDOW menu you can bring a specific model to the front or refresh all open windows Window Menu DoME Launcher Use this selection to display a list of curently open DoME models and bring a specific modelto the front Graphicsintensive application windows often become blumed or dirty during intense activity Use this selection to redraw the display When you select WINDOW MODELS DoME always lists the top of model diagram only for parent diagram subdiagram groups even if the top of model diagram is not currently open If the diagram is not currently open DoME will open it when selected When you click the HELP menu you can access DoMEwide online help notation specific help and the DoME Information window Help Menu DoME Launcher Opens a HELP window where you can accessDoMEwide help on Se functions that apply to all DOME tools and notations as well as notation specific help Opens the DOME INFORMATION window which contains DoME copyright information brief descriptions of DOME tools contact information and termsand conditions 3 DoMEwide Features Open Models Browser O pen The DoME Open Models Browser helps you navigate between Models and work with currently open models Browser In addition to allowing you to create new
25. already referenced by the selected object e Objects listed in the AVAILABLE list are nonvisual objects available for reference by the selected object B Colbert Methodology DoME s Colbert Project Tool e To reference a nonvisual object select it in the AVAILABLE list and click the button The object s name will move from the AVAILABLE list to the IN USE list Click APPLY to make this change effective e To un reference a nonvisual object select it in the IN USE list and click the gt gt button The object s name will move from the IN USE list to the AVAILABLE list Click APPLY to make this change effective cs Applying an unanswered question one without its RESPONSE property filled in to an object causes a to appear in its name label Once the question is answered RESPONSE property filled in the is automatically removed from the object s name label B 9 Colbert Object Interaction Diagrams B Colbert Methodology C olbert Colbert Object Interaction Diagrams OIDs are used to represent O bjec t the nature and structure of objects and their interactions nte 1 The following pages explain how to use DoME s Colbert raction Object Interaction Diagram model editor in the context of the Diag raMs DoME Project Tool a DoME specific extension to Colbert OOSD methodology The Colbert OID model editor is equipped with the four common tools SELECT MOVE ADD BEND REMOVE BEND
26. appears dimmed and the user is not allowed to activate it The Alter method must return either true t to enable the button or false f to disable it The graph being edited is passed in as an argument to the method lambda fhs graph 73 leaphioder Developing Your New Model Type D ProtoDoME Connector Spec Renaming a Connector Spec Appearance Properties for Connector Specs D 18 Select the CONNECTOR SPECIFICATION node in the drawing toolbar to create a new connector specification Three things will happen e First DoME will show the new connector class e Second DoME will create a specification for an instantiation button e Third DoME will update any open editors for your notation to include a new button This new button allows you to attempt to create instances of your new connector class See Connection Constraint on page D 25 Your new connector class uses defaults for its appearance and semantics We ll cover how to change those in the following topics Changing the name of the connector specification also changes the name of the instance button specification and the tooltip text that DoME displays when you hold the mouse over the actual instance button To change the name click on the connector specification and press RETURN just like you would to change the name of any other object This topic describes the various properties that govern how instances of a connector c
27. attached to the parent object The initial layout of interactions to and from an object s border in the subdiagram are relative to their layout in the parent diagram Their layout within the subdiagram however is independent of their layout within the parent diagram and may be repositioned to improve readability To help maintain consistency between Object Interaction and the Object Class diagrams when a subdiagram is created for an object in an OID a subdiagram is also created for its class in the corresponding OCD If the object does not have a class in the OCD one is automatically created for it The following illustration shows the initial layout for object Parent s subdiagram Note that once a subdiagram is created for an object its border is bold faced Colbert Object Interaction Diagrams B 16 Figure 45 B Colbert Methodology Sample Hierarchical OID Diagram lInitial Layout obj Weyl Coe Ranga j C E a Op Beal ceed Flee Dataflow go up go down Op Reqt Esrar can M op gea object ae Parent s subdiagram E p eps dh jp Feet ra i In the initial configuration of the subdiagram note that interactions operation requests attach to the object s border at a bar This bar can be selected and moved around the border to improve readability of the diagram Also Interaction connectors can be attached to internal objects in the subdiagram to represent bind
28. bitmap XWD 44 border count node specification D 11 boundary node class connector property D 22 F Guide T boundary nodes D 13 bounds method D 15 browser Alter Projector 9 Hierarchy 73 Open Models 9 31 Shelf 60 button enabling and disabling D 17 buttons custom D 37 mouse ix X C can be an archetype D 13 categories 61 categories of properties D 34 center D 9 change propagation 4 chorded node corners D 11 classes 4 61 client server connections 69 interfaces vii Coad Yourdon OOA 5 A 1 altering subject list contents A 12 attributes 4 bring item into view A 11 C amp O node attributes A 6 C amp O node properties amp appearance C amp O node services A 8 class and object node A 5 classes 4 create view A 11 description A 2 enumeration constants A 10 enumeration lists A 10 gen spec A 3 generator 5 go to view A 11 importance of order in model creation A 3 kill view A 11 model editor A 3 Index 1 name view A 11 overview A 2 part whole A 3 properties window A 12 schema code database 5 services 4 subject lists A 12 tools amp code generators A 14 views A 11 Views menu A 11 code generators vii object 2 source 2 Colbert OOSD Project 5 B 1 Data Dictionary B 7 generic model B 3 hierarchical decomposition B 5 B 15 B 22 B 29 object inspector B 6 Object Class Diagram B 18 Object Interaction Diagram B 10 Object Oriented Statecharts B 24 OID binding patterns B 17 col
29. if there was a node spec named Place in the example that is D ProtoDoME Viewing Your New Model Editor being developed then any alter method that needs to reference the place type would reference it with the name PetriNetPlace instead of just Place Load File The load file is an alter file that is loaded when a model is created or loaded Typically the file contains alter functions that are used by the various custom methods of the DoME Tool Specification Can Be Top Model The can be top model property specifies whether users are allowed to create models of this type via the DOME Select Model Type list Those DoME Tool Specifications that are only going to be used as subdiagrams will have this value set to false Tool Description The tool description merely describes the tool at a very high level to better inform an end user that may want to make use of the tool D Click APPLY to implement your new model type name Viewing YOUF ProtoDoME s dynamic nature allows you to immediately New Model create a model based on the specification by simply selecting a menu entry Editor 6 Dingurnissi Cina rmt From the DoME Tool Specification model editor select the TOOLS CREATE PROTODOME MODEL option Ahar Evelumor The model editor for your mostly empty specification Bri will look like the following example Act Gtendend Too Burr Saving Your New Model Fig ure 63 Saving Your New Model
30. included in documents developed using word processors such as LaTeX The image is scaled to the size specified in the SAVE As dialog window You can apply additional scaling from within LaTeX e Maker Interchange Format Use this format if a diagram will be used as a picture in a FrameMaker document The generated MIF file can be imported into an anchored frame and subsequently edited There is currently no way to re export the model out of FrameMaker to be loaded into DoME it is a one way transfer e XWD Bitmap Writes a bitmap version of the diagram to the named file in color X Window Dump format e RTF Writes a standard Rich Text Format version of the model to the named file Under UNIX you can tailor the Printer list in the PRINT OPTIONS dialog box since the field is initialized with the contents of your PRINTER environment variable DoME first looks in a file called domePrinters in your home directory for a list of printer names e g csps2 If that file does not exist it looks for usr local dome etc printerList If that file does not exist it uses a trivial list consisting solely of the printer ps 3 DoMEwide Features Working with Object Properties Working Nearly every object you see in a DoME model has editable with O bjec t properties Most of these are not shown in the editing pane Prope rties however As shown in the illustration below common editable object properties in DoME models include N
31. 1 MetaScribe Document A product generated from DoME such as a design document or source code Document Generator A subsystem of DoME that produces a document given a document specification an output format and a model Document Specification A description of the appearance content and structure of a document which can be edited by the MetaScribe Editor Formatter A subsystem of the document generator that translates output from the renderer into tool specific output MetaScribe Statement A paragraph that uses a MetaScribe style MetaScribe Style A paragraph style that provides MetaScribe s unique capabilities These include the Assignment Comment Conditional End File Function and Loop paragraph styles Output Format A representation of a document that can be understood by a specific tool Examples of output formats include Interleaf ASCII format IAF FrameMaker Maker Interchange Format MIF and Rich Text Format RTF Paragraph Style Information that describes how a paragraph should be displayed Product Developer Someone who uses DoME to produce a customer deliverable Renderer A subsystem of the document generator that processes the document specification intermediate representation and passes the results to the formatter Tool Infrastructure Developer A user that builds and integrates new functionality into a tool used by a product developer Glossary F Guide
32. 9 Using DoME CYOOA views page A 11 Using subject lists page A 12 CYOOA tools and code generators page A 14 A 1 About Coad Yourdon OOA About Coad Yourdon OOA A 2 A Coad Yourdon O O Analysis This appendix assumes that you are familiar with the Coad Yourdon Object Oriented Analysis modeling notation and semantics An extension to the Coad Yourdon OOA notation DoME s CYOOA modeling tool supports typed attributes services with signatures data flows between objects and ordinality on relationships and attributes typically representing atomic values such as integers dates or enumerations Also several code generators are available most notably SQL DoME supports the following Coad Yourdon notations e Class amp Object C amp O with attributes and services e Subjects but only as self contained boxes not as outlines around groups of C amp O nodes e Generalization Specialization relationships Gen Spec e Part Whole relationships e Simple relationships e Messages Also DoME features a set of extensions in addition to the standard Coad Yourdon notations that support the generation of database code and other export formats see page A 14 for export formats Following is a list of some but not all of the extensions available e Attributes can be annotated with several properties including type ordinality and initial or default value e Services can be annotated with return va
33. As shown in the first example these selections are useful for general editing functions In most diagram windows a replica of the menu bar appears e Inthe menu bar or standard toolbar area click WINDOW see page ix to display a window control pop up menu As shown in the second example these selections are useful for controlling the window itself The DoME Launcher which appears immediately after the banner screen when you start DoME is your primary interface with DoME tools features and functions You will use the Launcher to begin the creation of new models open existing models save models set your DoME desktop options and perform various other functions The DoME Launcher fa DoME Oy x Ele View Tools Window Hel E BA The Progress O El gt Meter Area 4 displaysa string describing the cument action and a round gauge Toolbarbuttons give you The Transcriptarea displays quick accessto the current DoME status or NEW and OPEN functions activity information which You may toggle the toolbar is useful if you have a on off in the View menu problem You can toggle this area on off in the VIEW menu 3 DoMEwide Features DoME Launcher Launcher File Menu Figure 11 Launcher View Menu Figure 12 Launcher Tools Menu Figure 13 F Guide When you click the FILE menu you can begin the creation of a new model open an existing model save all open models or quit DoME
34. Bottom Margin Float Left f aes K Document Specification Columns Integer Right Height Float Page Landscape Boolean C Layout Left Margin Float Right Margin Float Paragraph Placement Top Margin Float Anywhere Width Float Column Top Left Page Top Paragraph Next SY Page Top aragraph 4 Styles r Style p Right Page Top Paragraphs Paragraph Style Paragraph Specification Tab Alignment We 7 Tab Stop Center Name String H Specification Alignment Paragraph Alignment Decimal First Indent Float Tab Alignment Tab Alignment Tou Hyphenate Boolean Stops Leader String Bi h Keep with Next Boolean Position Float ight Paragraph Keep with Previous Boolean Paragraph Tag Left Indent Float z Font C Paragraph Override p Orphan Lines Integer ont Cass m _ Placement Paragraph Placement Lowercase Right Indent Float Normal Space Above Float TS Small Capitals Space Below Float Paragraph Number Uppercase Space Between Float Numberin V Widow Lines Integer i Label String Font Position a Normal Segments Sarm Font uperscript Va Font Posture Character Style aA Character Specification Italic Character F Specification Styles Name St
35. Control process on the parent diagram On Off and Activated e The automatically named Acceleration boundary point placed on the right side of the diagram corresponds to the flow connector output that exits from the process node on the parent diagram DoME keeps subdiagram and boundary point names tightly linked to their parent counterparts so if you change one or more names in a diagram the name changes are propagated to all other components linked to it throughout the model To further illustrate DoME s bookkeeping in hierarchical DFD models let s say that sometime later after developing our Cruise Control subdiagram we want to add another data flow to the parent diagram 6 Click SELECT on the EXTERNAL node type in the drawing toolbar and create a new external named Speedometer on the parent diagram 7 Click SELECT on the Data Flow connector in the drawing toolbar then attach the connector from the Speedometer node to the Cruise Control node Creating a Hierarchical DFD Model Figure 58 Figure 59 C Data Flow Diagram Added Speedometer Extemal on Parent Diagram CruiseControl DFD File Edit View Layout Tools Window Help Acceleration Speedometer DoME automatically adds a new boundary point TBD to the lower left area of the subdiagram below which corresponds to the connector between Speedometer and Cruise Control above Added TBD
36. D 30 node specification D 8 overview D 2 primitive types D 33 property adding to a class D 32 property constraints D 35 registration files D 43 tool description D 5 viewing new editor D 5 drag and drop D 31 drawing toolbar 12 32 39 DTSL see DoME Tool Language D 2 D 34 Specification eccentricity node shape method D 16 property D 10 editing pane 12 32 41 grid 15 73 element tools 41 enabling buttons D 17 menu items D 37 encapsulated PostScript 44 engineering processes 2 engines print vii enumerations D 33 Evaluator Alter 9 Extensions Manual DoME vii 24 external D 13 D 28 connector specification D 21 external class D 13 D 21 D 29 F features DOME 4 7 file Index 3 auto saving 24 formats vii 42 naming 74 opening 24 printing 43 saving 23 42 74 Follow User Nagivation checkbox 62 FrameMaker 5 G gen spec Coad Yourdon OOA A 3 generators 2 5 code vii generic specification D 31 getting started x glossary of terms Glossary 1 Go Down selection 22 GrapE 3 6 graph label 12 32 D 4 graphical languages 3 6 sray connector line pattern D 21 node line pattern D 12 grid editing pane 15 73 guard condition D 36 guide contents vi conventions used viii description vi publication number vii related documents vii revision history vii version vii window screen appearance viii H head style D 20 help vii 9 10 27 30 72 hide model 72 hierarchical decomposit
37. Existine Models Widget Layout Any changes to widget layout take effect immediately but open object inspectors are not updated automatically You should close and reopen any object inspector windows that are displaying one or more of the affected properties All changes to menu specifications take effect immediately Keep the following points in mind when you delete items from your DoME Tool Specifications If you delete a class specification from a DTSL model ProtoDoME does not remove instances of the class from open models It will remove the creation button if any from the toolbar specification and hence the button instances from the corresponding user interfaces Any existing instances of the class will remain in the model but their properties if any will not be accessible from the object inspector They can however be accessed from Alter Deletion of a connection constraint will prevent the connection class from being used in that way in the future but it does not cause the automatic removal of connections that because of the constraint removal are consequently in violation of the remaining constraints All deletions of menu or menu item specifications take effect immediately D 41 Creating Plug in Model Types Creating Plug in Model Types Creating Plug in Functions for Plug in Models Alter Type Definitions Created by DoME D 42 D ProtoDoME It s possible to arrange things so that
38. Fig ure 47 Select Move Add bend I Li Active Class m Passive Cla ui E ir Extemal Class Subclass of Relation Operation Relation Parameter Working with Objects Classes amp Class Templates Derived from Relation Use Relation B Colbert Methodology Colbert Object Class Diagrams are used to describe the nature structure and operations of each object class and the relationships that exist between classes and between objects and classes The following pages explain how to use DoME s Colbert Object Class Diagram OCD model editor in the context of the DoME Project Tool a DoME specific extension to Colbert OOSD methodology The Colbert OCD model editor is equipped with the four common tools SELECT MOVE ADD BEND REMOVE BEND NOTE included with most DoME model editors as well as the specialized nodes connectors and tools shown below Colbert Object C lass Diagram OCD Model Editor Context OCD File Edit View Layout Tools Window Help Lie ml Context OCD L 4 Remove bend Active Object Passive Object Extemal Object Instance of Relation TONG 4 Ec os Class Association Selected by Relation 4 In a Colbert Object Class Diagram one can draw four types of entities internal objects external objects internal classes and external classes The DoME tool does not currently support meta classes or parameterized classes class templates Ea
39. If the connector has no superclass the decoration type defaults to Arrow Rounded Comers If this box is checked instances of the connector class will have rounded bends The curves are circular with a fixed radius rather than using a spline Line Thic kness Width This determines the thickness of the line used to draw the connector Units are pixels You can choose from 1 to 4 The thickness may be fixed custom or inherited If fixed model context has no effect on the appearance of the connector s line thickness If custom model context may have an effect on the thickness The observed effect is determined by an Alter method see below If inherited the connector class superclass provides the setting for the line thickness Line Count Connectors typically appear as a single possibly bent line between two nodes Increasing the count to two causes the connector to be rendered as two parallel lines Normal Simple Dash CE Short Dash Long Dash sez Bf Dash Dot cese Dash Dot Dot Chan Phantom Declaration Properties for Connectors Specs D ProtoDoME Developing Your New Model Type Dash Patem This determines the dash pattern used to draw the connector The menu for the setting displays the different dash patterns available The dash pattern may be fixed custom or inherited If fixed model context has no effect on the appearance of the connector s line dash pa
40. Launcher and DoME Information window appear You are now ready to begin your tour next page To start DoME you must know the directory where DoME was installed We recommend that you install DoME in usr local dome If DoME was not installed in usr local dome substitute the actual name of your DoME directory in the following paragraph and any other references to that directory in this guide To start DoME type usr local dome bin dome amp at your command prompt If you plan to use DoME often add the directory usr local dome bin to your PATH environment variable and simply type dome amp to start DoME The amp puts DoME in the background so you can type more shell commands after starting DoME Either way the banner screen appears and after a few moments both the Launcher and DoME Information window appear You are now ready to begin your tour next page To start DoME first locate the DoME folder the DoME installer defaults to DoME on your main hard disk Double click the dome im file which displays the DoME icon The banner screen appears and after a few moments both the Launcher and DoME Information window appear You are now ready to begin your tour next page To familiarize you with basic DoME features the rest of this chapter takes you through a set of steps you would typically use to build a model with DoME If you perform these steps verbatim you will create and modify a simple Data Flow Diagra
41. Specifi cation Figure 61 Select Move Remove bend Add bend Gen Spec Node Spec Connector Specification List Element Generic Creating a New DoME Tool Specification The process of building a new DoME tool begins with the creation of anew DoME Tool Specification In this specification you can implement classes properties relationships and connection constraints that will be used in your new notation and model editor During this process you can manipulate a wide range of appearance properties to fine tune the visual syntax for your graphical language Running both your specification and model in progress simultaneously under ProtoDoME you will be able to immediately see the impact of your decisions since ProtoDoME directly interprets your DoME Tool Specifications and makes changes instantly Follow these steps to begin working on a new DoME Tool Specification and model editor 1 From the DoME Launcher or any DoME model editor click the NEW toolbar button 2 Select DOME TOOL SPECIFICATION in the Select Model Type list and click lt OK gt The model editor shown below appears To facilitate swifter creation of DoME Tool Specifications several objects are automatically placed in the specification DoME Tool Specification Model Editor Bis x om Graph Handle Accessory Part Whole List Element Pa rt Whole Context Properties unsaved Experimental Graph Specification E Edit View Layout T
42. View Overlays Implementation Instantiability Declaration El C None B C External One Primitive Many g C Primitive TBD A 5 C amp O Node Attribute Properties A Coad Yourdon O O Analysis Properties Page Implementation Page C amp O Node Attribute Properties att Properties Page Instantiability None means that the class represents an abstract class only no instances exist One and Many mean the obvious Declaration If External then the class is described in detail in some other model Class amp Objects declared external are not included in generated code Primitive If this box is checked then the Class amp Object appears as a valid type for Attribute This is a way to create relationships without using a connector between the two objects Source File This allows you to associate a filename with the Class amp Object that can be used during artifact generation For example a C code generator could place the code for each class in a separate file Using the ATTRIBUTE tool on the drawing toolbar you can insert attributes into Class amp Object C amp O nodes on your CYOOA diagrams C amp O node attribute properties are accessed by clicking the PROPERTIES button on the standard toolbar with an attribute selected in a C amp O node Attribute properties are described in the following paragraphs Ordinality Low High Attribute ordinality comes in two parts low
43. and high The ordinality specifies whether an attribute represents a single value or a collection of values For example a low ordinality of zero and a high ordinality of one indicates that the attribute is a single optional value A low ordinality of one and a high ordinality of many says that the attribute represents a limitless collection of values but there must be at least one value Type You can set an attribute as a basic type an enumeration or one of the primitive classes in your model Basic types are String an unlimited sequence of characters Symbol a unique identifier commonly found in languages like Lisp and Smalltalk and in some databases Integer a platform dependent quantity CYOOA supports large positive and negative integers so you need to be careful which values you pick if you intend to generate code Float a platform dependent single precision quantity A Coad Yourdon O O Analysis C amp O Node Attribute Properties Boolean true or false Date a platform dependent type If you designate a date attribute to have an initial value it will be creation date which means the date when that instance of the class was created by the target system Time a platform dependent type If you designate a time attribute to have an initial value it will be creation time which means the time when that instance of the class was created by the target system On some target systems Time
44. and then select WINDOW MODELS and the name of the model Before saving a model select the editor WINDOW REFRESH EXTENSIVE function to make DoME verify correct node and connector placement on your model As you work save your files models often when you know you want to keep the changes you ve made When you re finished with a model make a backup of the file Plan your file model names and where you will store models on disk before you get started Use the FAVORITE FILES and NEW FOLDER buttons on the SAVE AS dialog box to set up your file management scheme When you are experimenting shut off the AUTO SAVE function Launcher TOOLS OPTIONS EDITING page by entering zeroes in the two text fields This way you will not be forced to save a model with changes you may not want If you use the EDIT UNDO selection too late but have saved often use the FILE REVERT TO SAVED selection to abandon the currently open model and replace it with the most recently saved version Coad Yourdon O O Analysis In This Appendix F Guide This appendix includes the following topics About Coad Yourdon Object Oriented Analysis page A 2 The DoME Coad Yourdon OOA Editor page A 3 The importance of order in model creation page A 3 Class amp Object node properties and appearance page A 5 C amp O node attribute properties page A 6 C amp O node service properties page A 8 Using enumeration lists page A
45. are currently in the subject the list on the right shows the remainder of all objects in the model You can move an object type from one list to the other by simply clicking on the name in the list When you click the lt APPLY gt button the changes will be reflected in the subject e Add classes while in the restricted view mode or delete them in either mode If you are in hidden mode any nodes you add to the diagram will automatically be added to the subject s you selected to enter hidden mode If you delete a node it will be removed from all subjects in which it appears whether you are in hidden mode or not A Coad Yourdon O O Analysis Using Subject Lists e You can add a class to a subject by dragging the class over the subject The class will not move but a reference to the class will be added to the subject You can delete classes from the subject in a similar fashion Select the name reference in the subject and drag it outside of the subject DoME will ask if you really want to delete the item Two options are available in the VIEW SUBJECT submenu Restrict View This redisplays the diagram with only the members of the selected subject s visible Subjects can contain explicit references to Class amp Object nodes as well as general references to types of nodes and connectors For example you can construct a subject that includes just the inheritance structure of a diagram by making its members All Class amp O
46. are used to represent the nature and structure of objects and their interactions e Object Class Diagrams OCD are used to describe the nature structure and operations of each object class and the relationships that exist between classes and between objects and classes e Object Oriented Statecharts OOS object oriented renditions of Harel Statecharts are used to describe the dynamic behavior of an object or a class Those familiar with common COTS methodologies such as OMT Booch ROSE or UML should be immediately comfortable with these notations This topic describes DoME s unique Colbert Project Tool an extension to the Colbert OOSD tool set A DoME tool rather than an actual part of the Colbert OOSD methodology this tool includes three model editors that support Colbert OID OCD and OOS diagrams A DoME Colbert OOSD Project is simply a group of related Colbert diagrams i e Object Interaction Diagrams Object Class Diagrams and Object Oriented Statecharts In the DoME environment this tool is used to describe an integrated system model using the Colbert OOSD notation The DoME tool maintains consistency between the three different views of a system In multi view models various editing operations propagate throughout the model as needed to maintain consistency In addition to providing a means for integrating Colbert diagrams into a coherent system model the Colbert Project Tool widens the scope of the DoME D
47. border of the parent state and incoming and outgoing state transitions The initial layout of state transitions to and from a state s border in the subdiagram are relative to their layout in the parent diagram Their layout within the subdiagram however is independent of their layout within the parent diagram and may be repositioned to improve readability The following illustration shows the initial layout for State2 s subdiagram Note that once a subdiagram is created for a state its border is bold faced In the initial configuration of the subdiagram state transitions attach to the object s border at a bar This bar can be selected and moved around the border to improve readability Also the state transition connectors can be attached to internal states or state entrances To move a state transition from the border to an internal state select the connector grab the head tail of the connector with the mouse pointer then drag it to the appropriate internal state and release it B 29 Colbert Object Oriented Statecharts Figure 52 B 30 B Colbert Methodology Sample Hierarchical OOS Diagram Initial Layout Spiel 80 up Data Flow Diagram In This Appendix This appendix includes the following topics e About Data Flow Diagrams DFD page C 2 The DoME DFD Editor page C 2 e Creating a hierarchical DFD model page C 3 About Data Flow Diagrams DFD C D
48. brief descriptive names for objects especially circular nodes Excessively long names entered into the Short Name dialog box can drastically slow down DoME processing The VIEW menu includes the following selections Parent Diagram Bring this subdiagram s parent diagram to the front If the parent diagram is not open DoME will open it You may also use the PARENT DIAGRAM button on the standard toolbar to bring the parent diagram to the front Subdiagram Bring the selected object s next lower subdiagram to the front Top of Model Diagram Bring the top root diagram for this model to the front If the top model diagram is not open DoME will open it Data Dictionary Display the Data Dictionary window for this model see page 62 Hierarchy Use the Hierarchy Browser to inspect the object hierarchy of a diagram or multi diagram model see The DoME Hierarchy Browser on page 49 Map Large diagrams with many objects can make navigation difficult and we ve found that a map can help The Map window is a miniature display of your diagram with a rectangle outlining the portion currently visible in the editing pane see below You can adjust the view of your diagram editing pane by dragging the rectangular outline in the Map window DoME Map Map Miel E3 35 Model Editor Common Features 36 Model Editor Layout Menu Bring to Front Send to Back Connectors gt Nodes gt Spread
49. creating a DoME start up script with the Projector Alter Up Sc ript programming language you can get DoME to perform a wide E variety of actions as it starts up Capability il A DoME start up script is very similar to a Projector Alter user defined function see the Alter Programmer s Reference Manual The difference is that it is executed immediately as DoME starts up and no arguments are passed to it DoME looks for a start up script first in your home directory then in DoME s home directory a platform specific location The filename DoME looks for is platform specific as follows Table6 Start Up Script File Names Start up Script Default DoME Platform File Name Home Location UNIX domeinit usr local dome Macintosh startup dome DoME folder Windows dome ini C Program Files DoME a Or wherever you installed DOME If the start up script is an Alter source file DoME simply executes all the expressions in the source file If the start up script is a Projector program DoME looks to see if the program defines an entry point If there is an entry point DoME executes it otherwise DoME merely installs the operator definitions defined in the program If the start up script is actually a DoME diagram DoME opens the diagram for editing Here are a few practical uses for a DoME start up script e Set the value of dome load path to a custom list of directories see the load command in the Al
50. diagram overlays page 51 Setting your DoME desktop options page 55 Since you have already been introduced to the DoME basics in the previous chapter we assume that you know how to start DoME create open save and close models and exit DoME This chapter is descriptive rather than tutorial and contains detailed descriptions of common features and functions that exist across all DoME tools 25 DoME Keyboard Shortc uts 26 Figure 7 DoME Keyboard Shortcuts 3 DoMEwide Features When you work with DoME menus and toolbars you can use keyboard shortcuts as well as mouse maneuvers to deftly navigate your course Shortcuts for DOME Menu Selections The sample menu below shows how two types of keyboard shortcuts are indicated in DoME menus For the first type of shortcut the underlined character ina selection indicates the key you can use to select an option To use this type of keyboard shortcut In Windows hold down the ALT key and press the shortcut key e Inthe UNIX environment hold down the ALT or CTRL key depends on your X windows configuration and press the shortcut key e Inthe Macintosh environment hold down the lt OPTION gt key and press the shortcut key Sample Keyboard Shortcuts for DOME Menus Depending on your environment Windows UNIX Mac hold down the appropriate key and press Nto create a new model O to open an existing model A to save all ope
51. direct and indirect overlay objects e A direct overlay object is explicitly specified e An indirect overlay object is specified by a query You can only specify queries using the Overlay Editor page 52 Overlay Tips amp When working with diagram overlays observe these tips and Guidelines guidelines e An overlay can be visually represented on a diagram by Overlay 1 using an overlay node see example An overlay node displays the queries and objects included in an overlay and may be deleted without affecting the actual overlay Connector 1 e Direct overlay objects listed on an overlay node have a Connactar 4 pop up selection that allows you to select the object on a Process B diagram Click OPERATE on the object name in the Pracess C overlay node then click the GO TO selection Process D e You can remove nodes and connectors from an overlay node by deleting their associated object from the overlay node e You may only delete an overlay by using the Overlay Editor Anode is visible from the model editor if the diagram has no active overlays or if the node is an overlay object in at least one of the active overlays e A connector is visible in the model editor if the diagram has no active overlays or if the connector and the connector s origin and destination nodes are overlay objects in at least one of the active overlays e Nodes and connectors may be moved between overlay nodes by dragging the asso
52. directory should be searched to see if one that satisfies the new formatter s requirements already exists If a formatter does not exist then you have two options use an existing formatter as the basis for the new formatter or create the new formatter from scratch A formatter is an Alter source code file that defines a formatter type along with three required procedures and returns the formatter type as the final statement in the file Most formatters can just specialize the ms formatter type which is defined in the ms formatter alt file The three procedures that must be implemented are e start file formatter document specification filename This routine should open the output file for writing and output any necessary header information The ms formatter routine opens the output file and sets the instance variable named port to the output port e end file formatter document specification This routine should output any necessary trailer information and then close the output file The ms formatter routine closes the output file and sets the instance variable named port to nil e write paragraph formatter paragraph This routine should output the contents of the paragraph as well as any paragraph specific formatting The rendered content procedure should be used to access the text of each segment of a paragraph rather than getting the content property The ms formatter routine does nothing E 9 Output Formatte
53. f Guide 57 Setting Your DoME Desktop Options 3 DoMEwide Features 58 SAS VIN DoME Advanced Features SP ZA In This The features described in this chapter are common to C ha pter several but not all DoME tools e DoME Shelf reuse repository and Shelf Browser page 60 e DoME Data Dictionary page 62 e Hierarchical decomposition in DoME models page 64 e DoME start up script capability page 69 See chapter 3 for detailed descriptions of the common features and functions that exist across all DoME tools 59 The DoME Shelf The DoME Shelf Shelf Browser Figure 26 60 4 DoME Advanced Features The Shelf is a special utility you can use with DoME notations that can generate and store reusable software components such as Projector Diagrams Note the Shelf facility is not currently available to ProtoDoME based models Using the Shelf Browser you can create reusable software component archetypes objects with subdiagrams store them in the Shelf reuse repository and use them as needed on diagrams throughout your model To access the Shelf Browser from Projector e Select VIEW SHELF in the model editor menu bar A window similar to the following example appears with any existing archetype classes listed Select an existing archetype instance in your model then select VIEW ARCHETYPE in the menu bar A window similar to the following example appea
54. may be reversed 3 Right handed three button mouse The correspondence is from left to right Left SELECT Middle OPERATE Right WINDOW If you operate your mouse left handed these buttons may be reversed F Guide ix How to Get Started Mouse Button Operations Table 4 How to Get Started i Preface The following table describes the actions you can perform with your mouse buttons in the DoME environment Mouse Button Operations When you see Do this Click or Press and release the lt SELECT gt Click lt SELECT gt button Double click Press and release the lt SELECT gt button twice in rapid succession without moving the mouse pointer lt SHIFT gt lt CLICK gt While holding down the lt SHIFT gt lt CTRL gt lt CLICK gt lt CTRL gt or lt META gt key press and lt META gt lt CLICK gt release the lt SELECT gt mouse button If you re somewhat leery about wandering into the DoME without all the lights on 1 First skim the introduction to DoME in Chapter 1 then go to Chapter 2 for a quick DoME Tour These steps will guide you through DoME start up the creation of a rudimentary Data Flow Diagram DFD and DoME shutdown introducing you to many of DoME s basic most often used features Go to Chapter 3 DoMEwide Features This chapter describes DoME keyboard shortcuts pop up menus online help and other features avai
55. may include the information present in Date Um You may control the display of attributes on your diagram using the VIEW ATTRIBUTES menu selection Initial Value Specify that an attribute is to have an initial value by checking the Initialize checkbox You may then specify a type specific initial value for the attribute Implementation Memory Layout Page This property applies only to collection attributes and designates the type of data structure to use for storing them The three options are Array contiguous indexable storage Linked List noncontiguous storage that may or may not be indexable Hash Table noncontiguous nonindexable associative storage Publicity This property applies to data protection attributes public private and protected Declaration Page Unique Not Unique If an attribute is duplicated not unique its value can be set to any value legal for its type A unique attribute however has restrictions on what values it can take These restrictions depend on whether the attribute is a single value or a collection For a single valued attribute uniqueness means that its value must be unique across all instances of the class it annotates In database terminology it acts as a key For a collection attribute e g one to many uniqueness means that the values in the collection must be unique within the collection Thus a unique collection attribute is like a set A 7
56. model editor is much like any general purpose drawing tool The TITLE BAR and GRAPH LABEL display the name of the diagram e The MENU BAR gives you access to all model editor functions e The STANDARD TOOLBAR gives you quick access to several often used functions also available in the menus e The DRAWING TOOLBAR gives you quick access to objects and tools you will use in the EDITING PANE e The MESSAGE AREA displays window or action specific information including help messages When you first open a DoME model editor you will likely have at least one node already placed on the editing pane the graph label see above This node displays the name of the diagram and provides access to other information about the diagram Diagram entities typically include a variety of shapes and are classified as nodes or connectors Most DoME model editors display a single or double vertical row of buttons on the drawing toolbar representing various node and connector types Creating a new node or connector on a diagram is a simple select move operation 2 Quick DoME Tour Renaming Objects 2 3 Click the circle Process node on the drawing toolbar In a Data Flow Diagram DFD this shape represents a process Note that the button stays highlighted after you select it The drawing toolbar is a mode driven interface i e you first select a new mode of operation then select the target of the operation 4 Move the pointe
57. models and open existing models the Open Models Browser lets you edit save and close files To open the Open Models Browser select TOOLS BROWSE OPEN MODELS in the Launcher menu bar Figure 16 Open Models Browser File fibonacci pro Projector Diagram salaries dfd Data Flow Diagram DFD From the FILE menu you can begin to create a new model open an existing model save all open models close the browser or view select a file from a list of recently opened models From the MoDEL menu you can edit save close orhide the curently selected model in the list Toolbar buttons can be used to create new models open existing models or edit save close the currently selected model in the list Click a model in the list to select it then click EDIT SAVE or CLOSE ks In the Open Models Browser DoME always lists the top of model diagram for a parent subdiagram group even if the top of model diagram is not currently open If the browser brings a subdiagram to the front when you select a model and you want to edit view its parent or the top of model diagram use the PARENT DIAGRAM button on the model editor standard toolbar to access the diagram you want f Guide 31 Model Editor Common Features Model Editor Common Features Figure 17 Title Bar Menu Bar Standard Toolbar Select Move ___ v Add bend Remove bend
58. place the group of objects in the new location As described in Step 16 you can move the group of objects beyond the bounds of the currently visible editing pane area auto scrolling If you have selected too many nodes you can use lt SHIFT gt lt SELECT gt to deselect individual or rubber banded groups of objects 2 Quick DoME Tour Changing a Connector s Endpoints C ha ng Ing A Once you have created a connector between two nodes you Connectors y move either endpoint of the connector to a different node End int and still adhere to the requirements of the model notation po 22 Create another Process node named Process C 23 Click SELECT on a connector that you have already created When you click on the connector registry marks indicating the endpoints of the connector appear 24 Click and hold the destination registry point then move the pointer around on the diagram You will see an outline of the connector move with the pointer as you move toward the new destination S As described in Step 16 you can move the connector endpoint beyond the bounds of the currently visible editing pane area 25 Move the pointer on top of the Process C node and release lt SELECT gt When you click lt SELECT gt again outside of the new destination node the registry points disappear and the connector will be redrawn Routing After placing multiple nodes and connectors you may want to
59. print formats and allows you to extend its print capabilities PostScript output to either a file or printer is the most common DoME print application 61 In the model editor window you want to print click the PRINT button on the standard toolbar The Print dialog box appears The DoME default is to print the diagram on a single piece of paper 62 Selecta printer 63 Click the lt OK gt button The diagram should be printing by the time you get to the printer If the optional Projector Alter extension language is included with your version of DoME you can extend DoME printing options by implementing your own print engines This capability is quite useful but requires a bit of programming skill See the DoME Extensions Manual for more information When you re ready to leave the DoME after a work session shut down DoME by selecting FILE EXIT in the Launcher menu bar DoME will ask you to confirm that you want to exit If any unsaved models are open you will be given the option to either SAVE or DISCARD each model s changes or you may CANCEL the shutdown to keep DoME running and continue your session DoMEwide Features In This Chapter F Guide This chapter describes Keyboard shortcuts page 26 Online help amp pop up menus page 27 DoME Launcher page 28 Open Models Browser page 31 Model Editor common features page 31 Working with object properties page 45 Working with
60. the Editing Pane Working e Use hierarchical decomposition and overlays when Smarton appropriate to declutter a diagram and provide a more T Ed iti comprehensible structure to your model ng If you already know the names you want to use for new Pane objects on a diagram speed up object creation by selecting the PROMPT FOR NAME WHEN CREATING NEW OBJECTS checkbox on the Launcher TOOLS OPTIONS EDITING page e If you plan to square all connectors on a new diagram speed up diagram creation by selecting the SQUARE NEW CONNECTORS checkbox on the Launcher TOOLS OPTIONS EDITING page If you know how many objects of a specific type you want to create on a diagram hold down the lt SHIFT gt key when you select the object in the drawing toolbar DoME will create a new object of that type each time you click SELECT in the editing pane e Press lt ESC gt to back out of a dialog box menu or connector route point creation or movement e When you work on a large model open both the HIERARCHY BROWSER and MAP VIEW menu and move them off to the side of your diagram on the desktop so they don t get lost under the model These tools will come in handy when you want to shift the editing pane focus on a specific object on a specific diagram or use the PROPERTY INSPECTOR File gt On large diagrams try to develop a habit of using the Edit E OPERATE menu rather than the menu bar to cut down View gt on your m
61. to the LEFT lt MIDDLE gt and RIGHT buttons To bypass the potentially serious problem of button envy between our three breeds of mice we ve decided to follow the convention that ObjectShare uses in its documentation to use mouse button names that are generically descriptive SELECT OPERATE and lt WINDOW gt Use the descriptions below to identify your specific mouse button s name s Table3 Mouse Button Names SELECT Select a window object or menu item position the pointer or highlight text OPERATE Bring up a menu of operations applicable to the current view area or selected object In certain modes this button has special functions e g creating or going to a subdiagram for a selected node or connector in a hierarchically decomposable model lt WINDOW gt When used in the title bar or toolbar brings up a menu of actions that can be performed in any DoME window except dialog boxes 1 One button mouse The lone mouse button is SELECT To perform an OPERATE function press the OPTION key and click the mouse button To perform a WINDOW function press the COMMAND key and click the mouse button 2 Right handed two button mouse The left and right buttons are SELECT and OPERATE respectively To perform a WINDOW function press the lt CTRL gt key and click the OPERATE button simultaneously If you operate your mouse left handed these buttons
62. to the method is the diagram that would contain the new node Creation Cleanup This method is called immediately after the new node is created The expression may contain any actions you want The return value is ignored Deletion Check The expression must return a boolean value If the expression returns ff deletion is aborted If you want the user to be notified of the reason the method must do this DoME will not do this automatically If the expression does not return ff the node is deleted Deletion Cleanup This method is called immediately after the node is deleted The expression may contain any actions you want The return value is ignored Line Width If the appearance property Line Width is set to CUSTOM this method governs the line width used to draw the outline of the node The method must return an integer greater than 0 Line Style If the appearance property Line Style is set to CUSTOM this method governs the dashing pattern used to draw the outline of the node The method must return one of the following symbols normal simpledash shortdash longdash dot dashdot dashdotdot chain or phantom Line Count If the appearance property Count is set to CUSTOM this property governs the number of progressively bigger outlines drawn for the node The method must return an integer between 0 and 3 D ProtoDoME Developing Your New Model Type Paint Patiem If the appearance proper
63. top to bottom is the same as their left to right order in the specification In the third example shown above the list1 list appears above the list2 list It s possible to have more than one type of object in a given list To specify this simply connect the other types to the list s hub like this NEN oe abjects Developing Your New Model Type D ProtoDoME Creating the List Element Part Whole Node ZB Naming the Part Whole Link Can a List Element be Contained by More than One Class Declaration Properties for List Elements D 28 The first step in specifying a list element relationship is to create an element hub Select the LIST ELEMENT PART WHOLE tool in the drawing toolbar then drop it below the node class that will be the container As soon as you drop it DoME will prompt you to connect it to the container class Once you have created the element hub you can connect the list element class es to the hub the connector must go from the list element class to the element hub Each list element relationship for a container class must have a name that is different from the other list element relationships for that container class It s possible to use a list element class in more than one container class like this Car co TENA parts The declaration properties for a list element class specify some of its semantics Instantiable If false the user is no
64. types of states Basic Operation and Request In DoME O O Statecharts the three state types are actually represented by a single State node type having the visual property Kind Kind can be Basic Operation or Request The kind property can be set using the Object Inspector For convenience three separate tools are provided for creating states To create a state first select the tool icon for the appropriate state type then place the mouse pointer at the appropriate location on the diagram and click lt SELECT gt B Colbert Methodology Colbert Object Oriented Statecharts Figure 51 If you create a state of one kind and later decide to change it to a different kind modify its Kind property using the Object Inspector When you apply the change the state s shape will change to reflect the new kind The size of a state can be determined automatically by its name label size or manually by selecting the state and dragging one of the four selection marks in or out States potentially have two labels Name and Activity These labels are represented as properties and may be edited using the Object Inspector The Activity label is a string Only non empty Activity strings are displayed appearing below the state s name separated by a line Before you get started let s look at a generic example of a Colbert O O Statechart Sample Colbert Object Oriented Statechart States are Y Anl hierarchical rere Colber
65. various properties that govern how instances of a node class appear In most cases you can change these properties even after you have created instances of the node class and DoME will update their appearance accordingly In other cases you must close the model and reopen it to see the new shape To view and or modify the properties associated with a node class select the node and click on the PROPERTIES button on the standard toolbar Name Position The choices available for the position of the name and their meanings are as follows None The node will not have a label D ProtoDoME Developing Your New Model Type Above Centered above the border of the node Inside Top Centered just inside the top of the node s border This is the default Top Right Right justified inside and at the top of the node Top Left Left justified and inside at the top of the node Center Centered both vertically and horizontally inside the node Inside bottom Centered just inside at the bottom of the node s border Below Centered below the border of the node Relocatable Let the user position the name not supported for nodes Custom An Alter method is supplied that indicates where to put the name default is Inside Top if the Alter method is missing or raises an error Inherited Use the setting defined on the node s superclass default is Inside Top if there is no superclass Name Format The name format capabilities
66. view of a model simply select VIEW HIERARCHY from the menu bar of any model editor To display a full view of your model select VIEW SHOW ALL LEVELS in the browser menu bar The Hierarchy Browser menu bar contains the following selections FILE PRINT prints the currently displayed hierarchy FILE CLOSE closes the Hierarchy Browser EDIT FOCUS raises brings to the front the diagram containing the currently selected object in the browser tree EDIT INSPECT invokes the Property Inspector for the currently selected object in the browser tree The VIEW menu enables you to view the next level all levels or the top level only in the tree This menu also allows you to select other hierarchies for viewing if available f Guide 49 Working with Object Properties 50 Figure 22 DoME Hierarchy Browser 3 DoMEwide Features Hierarchy Browser Default File Edit View Process C L TED Connector 1 Connector 3 Process C Process E L TBD LProcess E Connector 4 Connector 2 Process B Connector 1 3 DoMEwide Features Working with Diagram Overlays Working An overlay facility in DoME model editors allows you to select with and group objects so they can be selectively displayed An a overlay is in essence a transparent sheet placed on the Diag ram background of a diagram This sheet contains only those Ove nays objects that should be displayed when the overlay is active An overlay can have both
67. work and graphical languages All model editing tools created in the DoME environment have the same look and feel and GrapE supports coupling between models using different notations including explicit links across diagrams via hierarchical and arbitrary cross references Quick DoME Tour In This This chapter tells you how to C ha pter e Enter the DoME page 8 e Tour through DoME s basic features page 8 e Leave the DoME page 24 This chapter does not include detailed descriptions of all DoME features and functions but is designed to give you a quick hands on introduction to DoME s intuitive look feel and ease of use See other chapters appendices related documents and online help for detailed descriptions of specific DoME features and operations Um In this chapter we assume that you have already installed DoME 2 Quick DoME Tour Entering the DoME Entering the DoME Windows 95 or NT 4 0 CISCTETTEDITTN Piel El Be pa ves i Macintosh Starting Your Tour Through the DoME DoME start up differs from platform to platform Under Windows 95 or NT 4 0 and up the DoME installer creates a pair of shortcuts for you one in a new DoME folder on the desktop and another in the START menu on the taskbar Either double click the desktop folder icon or select the DOME option in the START menu The banner screen appears and after a few moments both the DoME
68. you select and display one or more overlays on the diagram Similar to some functions available on the model editor VIEW OVERLAYS submenu the Overlay Inspector allows you to view and activate or deactivate the overlays on a diagram To access the Overlay Inspector select the graph label on your diagram and click the PROPERTIES button on the toolbar When the window appears click the OVERLAYS tab see example on next page To activate one or more overlays on a diagram click the appropriate overlay name s in the list A check mark appears next to active overlays Click APPLY to immediately activate your changes The DoME Overlay Editor allows you to create delete and manipulate the overlays on a diagram Due to performance considerations the Overlay Editor is a dialog rather than a standard window The Overlay Editor must be closed before you can continue working with other DoME windows Open the Overlay Editor by selecting VIEW OVERLAYS EDIT in the model editor see example on next page 3 DoMEwide Features Working with Diagram Overlays Figure 23 Overlay Inspector Data Flow Diagram DFD olx File Edit View Name a4 Rationale Property Schema Traceability p gt Overlays Active overlays Externals v Processes Stores Figure 24 DoME Ovenay Editor Queries All Boundary Points All Control Flows ComputeSalaries lt Salaries Compute
69. 23 Reopening a Saved Model oer ene ew EA Ee Ree 24 Printing with DoME s cedet sevi be beer cebat 24 Leaving the DOME xov eer tor RE TELE Ere eps 24 1 3 DoMEwide Features 4 DoME Advanced Features Contents oa In This Chapter zoe esa Ew E ERA RE CHE EE 25 DoME Keyboard Sliorteutsc Lc yee Sn Ee 26 DoNIE Online Help eeepc tor uud x ex eed 27 DoME Pop Dp NIenus cese uir EC meee A Ee 28 DoMETa nclet i 1x dam ERR EP RE ES 28 Open Models Browser sssseeeeeeeeeeee 31 Model Editor Common Features 0000 08 32 Model Editor Title Bar 20 0 c cee eee 33 Model Editor Menus eee 33 Model Editor Standard Toolbar 38 Model Editor Drawing Toolbar ss 39 Model Editor Editing Pane 5s et ert eau 41 Menus in Editing Pane esee Rr e 41 Auto Scrolling in the Editing Pane 41 Model Editor Message Area 0 000005 42 Model Editor Object Properties 42 DOME File Formats 0 0 000 cc cece eee eee 42 Printing Models n a enw city ees oretenus 43 Working with Object Properties 45 The DoME Property Inspector 4 45 The DoME Hierarchy Browser sess 49 Working with Diagram Overlays sees 51 Overlay Tips amp Guidelines 04 51 Overlay Tools eee e Wian e IA IU Pet Be 52 Setting Your DoME Desktop Options
70. 44 MetaScribe In This This appendix includes the following topics Appendix e About the MetaScribe System page E 2 e Using the MetaScribe Editor page E 3 e Output Formatters page E 9 e Integration with DoME page E 15 e Debugging page E 17 F Guide E 1 About the MetaScribe System 1 MetaScribe About the MetaScribe System Figure 66 E 2 The MetaScribe document generation system is an extension to DoME that makes it quick and easy to create new kinds of documents In addition the creation of a new kind of document is very intuitive since its editor called the MetaScribe Editor is implemented upon a well known word processor and the word processor document called the document specification is very similar to the generated document There are two components to a MetaScribe based document generator as shown in Figure 66 the document specification and the output formatter MetaScribe Document Generation System Document Specification omat Document A document specification appears to be similar to any other word processor document except that there are certain paragraphs contained in it that are used by DoME to produce a generated document One of these special paragraphs supports looping across the objects in a model and repeatedly generating the paragraphs that are within the loop s scope All of the special paragraphs are described in the Using the MetaScribe Editor section A
71. Connectors adjust connectors so they don t overlap or otherwise get in the way All connectors support multiple route inflection points 26 Select the ADD BEND tool The mouse pointer becomes a hand 27 Hold lt SELECT gt and drag the pointer over a connector A new route point is created on the connector 28 Continue to hold lt SELECT gt and move the pointer to the route point location you want You will see approximately what the connector will look like while you drag the route point Uu As described in Step 16 you can move the route point beyond the bounds of the currently visible editing pane area auto scroll 29 Release SELECT and click on the editing pane to remove the selection markers from the connector The connector is redrawn with the new route point Um If you want to cancel route creation in progress press ESC any time before you release SELECT 17 Rerouting Connectors Rerouting Connectors Removing Route Points Creating Routed Connectors 18 2 Quick DoME Tour Once you ve created a route point it s often desirable to reposition an existing route point 30 With the SELECT MOVE tool selected click SELECT on a connector 31 Click and hold SELECT on a route point on the selected connector and drag the route point to a different location When you release SELECT the connector will be redrawn with the route point in i
72. DoME automatically lists some of your DTSL specifications in the Select Model Type list when you click the standard toolbar NEW button This is the most common way to publish a new model type for DoME users and makes it most convenient to use the model type Such DTSL specifications are called Plug In model types All you need to do is place the DTSL specification in the specs directory of an existing tool directory or a new tool directory If you place the tool specification in a new tool directory that was not placed under the location where DoME was installed then you will need to inform DoME about it To do this you must open the options pane from the DoME Launcher page D 55 and add the directory to the Tool Directories list If you place the tool specification in an existing tool directory then you will need to select the Tools Reset Tool Caches from the DoME Launcher for DoME to know about the new tool Once you have created a plug in model type you can add plug in analysis function generators This is done exactly the same way as for other DoME models First create a lib and etc directory in the tool directory that contains the specs directory In the lib directory place the Projector Alter code that implements the analysis functions In the etc directory place the registration file called function dom that defines the linkages between the user interface and the implementation code ProtoD
73. E VIEW menu Toggle the toolbar or transcript area on off TOOLS menu Browse open models open optional Alter Evaluator or Alter Projector Browser view change DoME desktop options reset tool caches WINDOW menu Bring a specific open model to the front refresh all open windows HELP menu Access online help or the DoME Information window Help amp DoME Pop Ups Tooltips Information 10 replace undo copy cut paste accept cancel refresh move resize front back collapse close Pop Ups Tooltips Help amp DoME Information 2 Quick DoME Tour Before you get started let s try a few of the desktop features available in the Launcher and other DoME windows Pop up Menus Two types of pop up menus are available in every DoME window a context specific menu and a window control menu e With the mouse pointer in the transcript area of the Launcher click OPERATE see page ix to display a context specific pop up menu As shown in the example these selections are useful for general editing functions In most model editing windows a pop up replica of the menu bar appears when you click OPERATE in an open space on the work area editing pane e With the mouse pointer in the menu bar or standard toolbar of the Launcher or a model editor click WINDOW see page ix to display a window control pop up menu As shown in the example these selections are useful for cont
74. ECT gt on the parent object then press the lt DELETE gt key Click the lt YES gt button to confirm the action Hierarchical Decomposition in DoME Models 4 DoME Advanced Features Cause amp Effect in Hierarchical Models Table 5 Saving amp Printing Hierarchical Models 68 Once a parent diagram subdiagram relationship has been established actions performed in the parent diagram influence the subdiagram as follows Parent Diagram Subdiagram Cause amp Effect Parent Diagram Action Effect on Subdiagram Connector added to node Connector boundary point with subdiagram added End of connector moved Boundary point in previous from node with subdiagram subdiagram removed to another node with boundary point added to new subdiagram connected subdiagram Connector removed from Corresponding boundary node with subdiagram point in subdiagram removed e When you select the FILE SAVE command a hierarchical model DoME saves the entire hierarchy all parent diagrams and subdiagrams not just the diagram displayed in the editing window e When you select FILE PRINT DoME prints only the currently displayed diagram in the model unless you select the option to also print its subdiagrams See notation specific documentation for more information on parent subdiagram reference file relationships for a specific model type 4 DoME Advanced Features DoME Start Up Script Capability DoME Sta rt By
75. If the appearance property Corner Style is set to ROUNDED CHORDED or CUSTOM this method governs the amount of the corner used The method must return a number between 0 and 0 5 This represents a fraction of the longest side For example if the longer side of the node s bounds is 100 pixels a radius factor of 0 35 yields a corner radius of 35 pixels Developing Your New Model Type D ProtoDoME Changing an Icon Cursor amp Shortcut Key Figure 65 Polyline Style If the Shape appearance property is set to Polyline this method specifies the specific polyline shape to use and must return one of the following symbols trapezoid parallelogram default rectangle triangle diamond trapezoid or parallelogram Polyline Point Anay If the shape of the node is designated as a custom polyline this method must return a list or vector of points a point is a pair of numbers x y The points are assumed to be normalized to the unit square lt 0 0 gt to lt 1 1 gt Eccentricity If the appearance property Shape is Rectangular or Circular this method controls the aspect ratio of the node The ratio is width over height An instantiation button is created for every instantiable node connector and list element class in the DoME Tool Specification Each button has icon cursor shape and shortcut key properties that you can set with the property inspector To view the properties click on the b
76. LE NAME list box and click lt SAVE gt or press lt RETURN gt When you save your model in a file DoME also saves its window size and position When you reopen the model the window will appear on your desktop at the same size and in the same location If a model has several diagrams being edited when the last save occurred DoME will reopen the model with the same diagrams visible in editing windows C losing a 57 select FILE CLOSE single diagram only or FILE CLOSE Model MODEL all diagrams in this model In either case if you haven t saved your diagram or model since making changes to it DoME will ask if you really want to close it 23 Reopening a Saved Model Reopening a Saved Model Printing with DoME Leaving the DoME 24 2 Quick DoME Tour When a model has been saved in a file you may reopen and modify it as follows 58 Click the standard toolbar OPEN button on the Launcher or an open model editor window An Open dialog box similar to the Save As dialog box appears 59 Locate the file you want using the directory tree or list boxes LOOK IN FILE NAME FILES OF TYPE TEXT OR PROPERTY LAST MODIFIED 60 Click on the file name then click OPEN or press RETURN If the file you selected has an existing auto save file you will be asked if the auto save file should be loaded rather than the last version of the file you saved manually DoME supports many
77. ME lets you tailor several aspects of the user interface to y P DoME ye liking including background color use of screen real estate zoom sizes and so forth Desktop To view or change your DoME desktop options select O pto NS Toors OrrioNs in the Launcher menu bar To access each category simply select the appropriate tabbed page DOME options are listed and described on the following pages Figure 25 DoME Options Window i ndow Zoom editing BFonts Mise g E Default Grid Size Creating Objects edo pixels C PromptFor Name Default Change Color Square Connectors Asis E Auto Save Propagate Deletions Changes D To Subviews Timeout D minutes Ask EI Um Modified DoME Options settings are saved in a file UNIX domerc in the home directory Windows in a file called prefs dom in your HOME directory or in the directory where you installed DoME usually C NProgram FilesN DoME Macintosh in the directory where you start DoME Editing Options This page contains the following options Default Grid Size Use this list box to turn editing pane gridding on off or hidden Use the text box to change the number of pixels between each grid line You can also adjust gridding from any model editor VIEW menu Default Change Color Semantic changes to DoME objects are automatically colored according to the current change color This setting initializes a diagram windo
78. O is the operation you should have used in the first case under the Cutting and Pasting Objects topic if you wanted your connectors back UNDO is a powerful operation in fact it can reverse almost any action you perform even object creation Some actions such as cutting and discarding a subdiagram from a parent object cannot be undone In this case an actual diagram has been deleted Don t forget however that UNDO only remembers one action As another experiment with UNDO try to change the name of an object 47 Click SELECT on a node and change its name 48 select Eprr UNpo in the menu bar The old name is restored 49 select Enrr UNpo again The old name disappears and your new name is restored What you just performed was the undoing of a previous UNDO 2 Quick DoME Tour Creating a Parent Object amp Subdiagram C reating A On the previous page we briefly mentioned parent diagrams Parent and subdiagrams which you probably don t know about yet We won t go into great detail here but a brief introduction is O bjec t amp in order since several DoME notations feature this capability Subd lag FAM In DoME notations that support hierarchical decomposition e g Data Flow Diagrams subdiagrams or implementations of selected parent objects can be easily created In a nutshell this feature gives you the ability to create and attach entire sub diagrams or a hierarchical series of subdia
79. Salaries EmployeeTir All Data Flows ComputeSalaries lt EmployeeTa All Data Stores Delete lt EmployeeTable All Externals Insert lt EmployeeTable All Graph Labels EmployeeTable lt Insert All NetNotes EmployeeTable lt Delete All Processes A DFD describing part of thecor ComputeSalaries si 53 54 Working with Diagram Overlays 3 DoMEwide Features The tools available on the Overlay Editor enable you to easily add remove any object to from any number of overlays The Overlay Editor consists of an EDIT menu and three regions e The Overlay list displays the existing overlays associated with the model e When you select a specific overlay the Queries and Objects lists are updated to reflect the overlay The DoME query mechanism is class based so those objects that are instances of the selected classes are made visible when the overlay is active Those objects that are visible because of the query specification are called indirect query objects Overlay Editor Edit Menu The following functions can be performed from the Overlay Editor EDIT menu Create Creates a new overlay A name is requested Delete Deletes the selected overlay Rename Renames the selected overlay Active Activates or deactivates the selected overlay Visible Overlay Node Creates or deletes the overlay node associated with the overlay 3 DoMEwide Features Setting Your DoME Desktop Options Setti Yo UF Do
80. Select Move File Edit View Layout Tools Window Help Add bend Helal e e 2 Dr Remove ie Note io Process i MEE Store T T T Boundary Data Flow Connector Control te a Connector 1 C Data Flow Diagram Creating a Hierarchical DFD Model C reating A To illustrate the process of creating a hierarchical DFD model Hiera IC hic al we will use an automotive cruise control example that begins with a top level VIEW TOP OF MODEL DIAGRAM DFD Model diagram containing an assortment of externals data flows and control flows surrounding a process Figure 54 DFD Cruise Control Top of Model Diagram 5 2 CruiseControl DFD File Edit View Layout Tools Window Help Accelerator Acceleration Cruise Control Activated Pa a To further develop the cruise control process we will add a DFD subdiagram to the model l Click Select on the Cruise Control process node Selection marks appear around the process node 2 Click lt Operate gt on the Cruise Control process node The Go DOWN selection appears 3 Click Select on the Go Down selection The CHOOSE IMPLEMENTATION dialog box appears see the following example Creating a Hierarchical DFD Model Figure 55 Figure 56 C Data Flow Diagram Choose Implementation Dialog Box r1 Choose Implementation Ed Reference File Select Existing Cancel As described in Parent Di
81. able paragraph tag Name The name given to the paragraph style Next Paragraph Style The paragraph style to use for the next paragraph Specification The details of the paragraph style Paragraph Specification Captures all relevant information to completely format a paragraph Alignment The alignment of the paragraph First Indent A length in inches specifying how far the first line of the paragraph should be indented from the left margin in addition to the left indent Font The font used when presenting characters Hyphenate Specifies that hyphenation should be performed Keep with Next Keep this paragraph with the next paragraph column when crossing page boundaries Keep with Previous Keep this paragraph with the previous paragraph column when crossing page boundaries Left Indent A length in inches specifying how far the paragraph should be indented from the left margin Numbering The numbering used for the paragraph Orphan Lines The minimum number of lines of the paragraph that shall be kept together at the end of a page Placement The location where the paragraph should begin Right Indent A length in inches specifying how far the paragraph should be indented from the right margin Space Above The spacing placed above the paragraph Space Below The spacing placed below the paragraph Space Between The spacing placed between lines in the paragraph
82. access the inspector window for an object click lt SELECT gt on the object then click the PROPERTIES button on the model editor s standard toolbar A window similar to the following example appears where you can view or edit a wide range of object properties Object Inspector Window Object Reference OL XI File Edit View Name CruiseControl 4 Overlays Concepts Is Multiple 24 C True False B Colbert Methodology DoME s Colbert Project Tool Colbert OOSD As you create and modify your Colbert OOSD Project models Projects amp DoME automatically creates and maintains a data dictionary of DoME s Data model elements For most notations DoME maintains a data dictionary for a single diagram type With the Colbert OOSD Project DoME maintains a data dictionary for all three diagram types OID OCD OOS as well as any hierarchical parent diagram subdiagram relationships attached to each Colbert diagram Dictionary The dictionary maintains an inventory of items found in the diagrams in a project and can be used to inspect various aspects of an item s state as well as navigate the project To switch from one item to another in the Data Dictionary window click the VIEW menu and make a selection You may view or edit any item in the list at the top of the window by selecting it and then accessing specific aspects of the item in the tabbed pages Figure 41 Colbert OOSD Project Data Dictionary Window
83. age RS Bites eat Stes RETE S EM D 36 Custom Tool Buttons eaves PERI EA Se D 37 The Impact of Changes on Existing Models D 39 Modifications in DoME Tool Specs D 39 Deletions in DoME Tool Specs D 41 Creating Plug in Model Types 50 5 6 rese D 42 Creating Plug in Functions for Plug in Models D 42 Alter Type Definitions Created by DoME D 42 Registration Biles ince hic naka ey OR eae ee a D 43 In Fhis Appendices d due wd ceded iced E 1 About the MetaScribe System 000 00 E 2 Using the MetaScribe Editor 0 E 3 Word Templates cca dar eG eM EE E 3 EXDressiofiS peesi d ei cans eae San LS Pr PY Ed E 4 Styles sedeo e E UE eese remo sede elt Sd E 4 Global Variables oer e ee E 6 Dser Interface oues ep we P ei eases ied RR E 6 Unsupported Features ele nn E 8 Optput Formmdltetss oso ccu eco tlbi un E 9 Creating a New Formatter o iuo e EROR E 9 Information Model it loss scan 92 nee g aslo td a E 10 Integration with DOME eee e etr os E 15 Adding a Document Specification E 15 Adding an Output Formatter E 16 IDDBBUSBIBS S sorsi erni exe it ova d else ee es E 17 GlIOSSALY iore RR e a IU EC PIU I SMS E 18 Preface This preface includes the following topics e About this guide e Revision history e Related documents e Conventions used in this guide How to get started How to reach the DoME
84. agrams Subdiagrams amp Referenced Files on page 65 you can either create a new subdiagram or select an existing separate model to reference at this point In this example we will create a new DFD subdiagram to further describe the cruise control process 4 Click the CREATE NEW button A SELECT MODEL TYPE dialog box appears which lists the various types of models you may select from to create the new subdiagram Select Model Subdiagram Type Dialog Box C x Select hlodel Type Coad Yourdon OOA a Data Flow Diagram DFD Petri Net Model State Transition Diagram 7 Cancel 5D Select DATA FLOW DIAGRAM DFD in the list and click the OK button A new Data Flow Diagram editing window opens see the following example which is directly attached to the CruiseControl DFD parent diagram When you save the model this subdiagram will become an actual part of the model C Data Flow Diagram Creating a Hierarchical DFD Model Figure 57 DFD Cruise Control Subdiagram fe Cruise Control File Edit View Layout Tools Window Help Acceleration Activated Note that e The new subdiagram has been automatically named Cruise Control which identifies the parent node it is attached to on the parent diagram CruiseControl DFD e Three automatically named boundary points have been placed on the subdiagram which correspond to the three flow connectors inputs that enter the Cruise
85. am to have a subdiagram that is restricted to a certain collection of model types or to have a subdiagram that can be any model type To create a subdiagram for an instance double click on the instance or click lt OPERATE gt with the instance selected Click the Go DOWN option The following Alter methods may be supplied to customize the appearance and behavior of a connector class You specify all such methods as a body for a lambda expression that binds the symbols listed in the property inspector to an instance of the object and possibly other parameters e g graphics context for drawing lines Label Presence If this method returns f the connector does not display a label Otherwise a label is displayed Origin Head Presence If this method returns f the connector does not display a decoration on the origin end Otherwise a decoration is displayed D ProtoDoME Developing Your New Model Type Origin Head Style This method must return one of the following symbols arrow square circle filledsquare or filledcircle Destination Head Presence If this method returns f the connector does not display a decoration on the destination end Otherwise a decoration is displayed Destination Head Style This method must return one of the following symbols arrow square circle filledsquare or filledcircle Object Label Text The expression must return a string DoME uses this string to
86. ame Description Rationale Traceability Color Cross References X Refs and Overlays Depending on the specific notation you are working with other unique properties may be included The DoME The DoME Property Inspector is the tool you will most often Property use to view or modify the properties of an object It is invoked Inspector by selecting an object on the editing pane and then clicking the PROPERTIES button on the standard toolbar Object Property To select an object property for inspection or editing simply Selection select the appropriate tabbed page in the Property Inspector window The functions available on the Property Inspector are described on the following pages Figure 21 DoME Property Inspector fa Process iof x File Edit View Name Process 3 n BRationale gTraceability Heer Description E Process the inputs in such a way that the age of the object is used to set the color of the object 1 As a convenience you can modify the name of an object by pressing RETURN on the selected object Also some enu meration properties can be updated by rotating them through the available values using lt CTRL gt lt RETURN gt f Guide 45 Working with Object Properties Title Bar Menu Bar Selections Editing Keys 46 3 DoMEwide Features The title bar displays the type of object selected in Figure 21 DoME Property Inspector for example a Da
87. ams To move back to the original editing pane area simply move the selected object s toward the upper left corner of the visible editing pane The vertical horizontal scrollbars show your current location relative to the original editing pane area 17 Release lt SELECT gt when the pointer is located where you want the node to move The node is redrawn in its new position complete with any connectors attached to other nodes No matter how you physically arrange objects on a diagram DoME s object framework maintains all logical connection information for you cS If you change your mind and want to return the node to its previous location use the EDIT UNDO menu selection to undo your most recent action The node will return to its original location on the editing pane Um Depending on your VIEW GRID setting the editing pane grid may be turned on If so you will not be able to move objects using the mouse in increments less than the size of a grid section You may however incrementally move a node within a grid section by selecting the node with the mouse holding down the CTRL key and pressing the up down left and right arrow keys 15 Selecting amp Moving Multiple Objects Selecting amp Moving Multiple Objects Process A Pre Process B 16 2 Quick DoME Tour You may select and move multiple nodes and connectors at the same time as a group One of two method
88. are not presently implemented Node Shape The choices available for the node shape and their meanings are as follows Rectangular A box Corners can be rounded see Corners on page D 11 By adjusting the Eccentricity setting you can give more or less width to the node Developing Your New Model Type D ProtoDoME ZA Thao uriom n Custom Shape Circular Includes elliptical shapes defined by an Eccentricity setting less than 1 0 makes the nodes narrow greater than 1 0 makes them wide Circular nodes also have the ability to auto wrap their labels to minimize node size see Name Position below Polyline If you select the Polyline node shape there are seven additional choices available Rectangle default Diamond Parallelogram Trapezoid Triangle Custom Style and Custom Shape If you select Custom Style you need to supply an Alter method that determines the shape to use e g one of the above choices If you select Custom Shape you must supply an Alter method that returns a sequence of vertices normalized to a unit square lower left 0 05 upper right 1 1 See Alter method discussions below Custom Rectangular An Alter method must be supplied to execute drawing commands to display the node a regular box is displayed if the method is missing The shape is assumed to be basically rectangular for the purpose of clipping connectors Custom Circular An Alter method must be supp
89. as a reference file must be open when you set up the reference Parent Object The following example shows a parent diagram that contains Identifiers four parent objects two nodes and two connectors e Parent nodes are identified by a marker attached to the inside of the parent object e Parent connectors are identified by a box rectangle surrounding the parent connector name Figure 28 Parent Object Identifiers on Parent Diagram gm lt an unsaved Data Flow Diagram DFD gt File Edit View Layout Tools Window Help gewsgang E X F a NoN orane ae Parent Node ha Connector 2 Connector 3 Identifier Parent Connector Connector 4 Process Identifier D amp Connector 1 Process A EIEL DeM Guide 65 Hierarchical Decomposition in DoME Models 4 DoME Advanced Features Creating a Parent Object Creating Subdiagrams amp File References Figure 29 Subdiagrams 66 Typically not all types of nodes and connectors on a hierarchically decomposable model can be used as parent objects To determine whether a node or connector can be used as a parent object click lt OPERATE gt on the object e If an object cannot be used as a parent object a pop up menu similar to the menu bar appears e If an object can be used as a parent object you will see a single selection appear on the object GO DOWN When you click the GO DOWN selection the following dialog box appears C
90. at mif sourceFile ms mif formatter alt Care should be exercised so that the formatName does not conflict with the formatName of existing formatters E 16 1 MetaScribe Debugging Debugging The document generator can produce an internal processing error if a document specification or output formatter has a syntax or semantic error An example of this kind of error would be a loop statement whose expression fails to return a list If and when an internal processing error is encountered the generation is terminated and the user is notified with a dialog stating the problem If the problem is associated with the document specification then the user is asked if they want the errors written to a file that may be read via the View Document Generation Errors menu available from the MetaScribe Editor This file will allow the user to pin point the problem in the document specification An internal processing error should only be encountered by those developing new document specifications or new output formatters A fully tested document specification or output formatter should never produce this kind of error To simplify debugging it is recommended that a new document specification and a new output formatter not be debugged at the same time It may be very difficult to determine which one has the problem when an internal processing error is encountered E 17 Glossary Glossary E 18
91. at Model Based Development 2 Model Based Development Using DoME 3 DOME Eeatutes i2 eod orbi een eau d b ert uar 4 DoME s Common Notation Set 0 020s 5 Domain Specific Notations 0 000 00 ee eee 6 s n This Chapter ses dace qva RA I qoe a educ one 7 Entering the DOME v vex sex recien Eder E Reda sen 8 Starting Your Tour Through the DoME 8 About the Launcher cus bsookcerr ere rpUR PIENE weds 9 Pop Ups Tooltips Help amp DoME Information 10 Creating a New Model 1 20 esses edt rs 11 Creating Nodes sia siiis da iisa debo Rd e e n 12 Renaming Objects lt i 222 0 ieestaiwtesccee bier eet reese 13 Creating COImmnectpES xx exa rae CORRER RR 13 Moving Nodes us kk een edo ripe P EAE belo ee OE 15 Selecting amp Moving Multiple Objects 16 Changing a Connector s Endpoints 17 Routing Connectors ete ced eve RR ERE REPERI ERES 17 Rerouting Connectors a cc veiw e tae x ex Ee Rr 18 Removing Route Points ur sohes 6 oh ER ERI ROERVES 18 Creating Routed Connectors oa ee eR 18 Squaring Up Connector Routes sese 19 Cutting and Pasting Objects 1er oeekxc rt ease Rari s 19 Deleting Objecte eecok Heese se ee o e eds 20 Undoing ACtHONS s sis csi diae decor eR oo Re i oan 20 Creating a Parent Object amp Subdiagram 21 Davide m Model uasa sque piia wean cR a E A RR E 23 Closing a Model 5 cckiseds ven6oes cawi e en
92. ata Dictionary to include all dictionary information for multiple Colbert diagrams in a single location see page B 7 1 For more information contact Ed Colbert ABS S W Absolute Software Inc 4593 Orchid Drive Los Angeles CA 90043 3320 213 293 0783 e mail colbert abssw com B Colbert Methodology DoME s Colbert Project Tool Figure 37 subdiagram Colbert OOSD Model Editors gt Toben Tze kvera eia n Diagram OR Like several other DoME notations Colbert OOSD Project model editors adhere to the concept of hierarchical decomposition see Hierarchical Decomposition in DOME Models on page 64 In multi diagram models various editing operations propagate throughout the diagram hierarchy as needed Before you get started let s look at a generic Colbert Project model The example shown below includes one OID one OCD and two OOS s with a hierarchical subdiagram attached to each This model illustrates the dynamics of hierarchical decomposition in DoME s Colbert OOSD Project models which features seamless interconnection and consistency across all three diagram types as well as between parent diagrams and subdiagrams throughout a complex model Sample Colbert OOSD Project Model Skel hal Ub ether Cilicum Baie Chad 04s mim hat Colles Slate Chart 809 Cissa Da rem re Cian Ciam Dag mm ii subdiagram subdiagram subdiagram The DoME notations and mod
93. ata Flow Diagram About Data this appendix assumes that you are familiar with the standard How Structured Analysis Data Flow Diagramming notation and Di semantics lag rams A Data Flow Diagram DFD enables you to graphically DFD represent a system s information flow Transformations are applied to the information flow via Process nodes as the data moves from inputs to outputs Externals data source data sink and data Store nodes are used as the inputs and outputs while Data Flow connectors are used to represent information flow DoME s DFD model editor supports standard Structured Analysis notation including the concept of hierarchical decomposition see Hierarchical Decomposition in DoME Models on page 64 In multi diagram models various editing operations propagate throughout the diagram hierarchy as needed e g changing the name of a data store The example on the following pages illustrates the dynamics of hierarchical decomposition in DoME DFD models and shows what DoME does to maintain consistency between parent diagrams and subdiagrams throughout a model The DOME the DoME Data Flow Diagram editor is equipped with the DFD Model four common tools SELECT MOVE ADD BEND REMOVE BEND 3 NOTE included with most model editors as well as the Editor specialized nodes connectors and tools shown below Figure 53 Data Flow Diagram Model Editor Eel an unsaved Data Flow Diagram DFD gt
94. ations Set this property to the external class you wish to reference Developing Your New Model Type D ProtoDoME Subdiagram Properties for Connector Specs Alter Methods for Connector Specs D 22 Boundary Node Class Specifies the class of node that will serve to visualize the interface for this connector class in a subdiagram The menu displays only those node classes that have been declared to Be A Boundary See Be a Boundary on page D 13 For example let s say that you have defined a type of model called Circuit with two node classes called Chip and Pin and one connector class called Wire Chip has been declared as hierarchical and Pin has been declared as a boundary class You then inspect the properties of the Wire class and specify its Boundary Node Class to be Pin A connection constraint specifies that a Chip can be connected to another Chip with one or more Wires In a Circuit model the user creates two instances of Chip called A and B and connects the first to the second with an instance of Wire The user then creates a subdiagram of A In the new subdiagram the user sees an instance of Pin on the right hand side of the window representing the fact that the parent Chip has an outgoing connection to a Wire In this example the DoME tool specification would also need to specify how Pins can be connected to other objects Subdiagrams A node can be specified to not have a subdiagr
95. based development and DoME s contributions to the discipline page 2 e A summary of DoME s features page 4 e A list of standard notations and tools available with this version of DoME page 5 What is DoME 1 Introducing DoME What is DoME A Brief Look at Model Based Development Figure 1 The Domain Modeling Environment DoME tool set is an extensible collection of integrated model editing meta modeling and analysis tools supporting a Model Based Development approach to system software engineering In the model based development paradigm a model serves as the primary representation of a system under development This implies among other things that engineers should treat a model as source code and rely upon automatic transformation mechanisms to produce the object code In return this approach requires that the model specification tool s provide adequate expressive power to say all that need be said and execute the translation steps in a transparent robust and painless to the user manner Model based development fosters a division of labor in engineering and clarifies the objectives for system software development DoME supports this division of labor by partitioning the engineering processes as shown below Model Based Development Component Infrastructure Developers Methodologists Modeling Languages Product Software Meta Mode
96. bjects All Gen Specs and All Inheritance Links Nodes are visible only if they are members of at least one of the restricting subjects Connectors are visible only if their endpoint nodes are visible and they are members of at least one of the restricting subjects Subjects can be nested i e one subject can refer to another Unrestrict View This shows all nodes and connectors regardless of their subject membership CYOOA Tools amp Code Generators A Coad Yourdon O O Analysis CYOOA Tools amp Code Generators DoME can be used to both design arid implement your Coad Yourdon OOA based applications Your choice of the actual implementation environment determines the format in which you need to save your models As you work on your Coad Yourdon OOA diagrams in the DoME environment you can use the following specialized tools to both aid in model development and tailor your model specifically for your target environment TOOLS PLUG INS NODE COUNT tells you how many semantic nodes your diagram contains TOOLS PLUG INS ALTER CODE optional generates Alter code from your diagram for use in the DoME environment TOOLS PLUG INS FOXPRO SQL generates FoxPro SOL code from your diagram TOOLS PLUG INS CLOS CODE generates CLOS code from your diagram which contains complete class definition macros for CLOS applications TOOLS PLUG INS ACCESS SQL generates SOL code suitable for defining tables i
97. ble a graphmodel is a reference to the model being operated upon e ms settings This variable a metascribegeneratorsettings is a reference to the settings that were specified from the generation dialog The following properties may be accessed to get the settings information filename directory scope gt current subdiagrams hierarchy outputType gt directory file window e ms errors This variable a list type is used for collecting analysis errors that are displayed after the document generator finishes It is initially an empty list that the document specification may modify by adding new associations Refer to the display errors Alter procedure for further details about the list The following two examples show how to add an error to the error list The second example places the errors into the list in reverse order An Assignment statement near the end of the document specification is used to reverse the order of the list before displaying the errors to the user Example 1 set ms errors append ms errors list list ms model The model has no name specified Example 2 set ms errors cons list ms model The model has no name specified ms errors Set ms errors to reverse ms errors The MetaScribe editor extends the Microsoft Word user interface with one new menu one modified menu and one new toolbar The METASCRIBE menu includes the following selections Sa
98. bserved effect is determined by an Alter method see below If inherited the node class superclass provides the setting for the dash pattern A count of 1 is used in this case if the node class has no superclass Dash Patiem This determines the dash pattern used to draw the node s outline The menu for the setting displays the different dash patterns available The dash pattern may be fixed custom or inherited If fixed model context has no effect on the appearance of the node s line dash pattern If custom model context may have an effect on the dash pattern The observed effect is determined by an Alter method see below If inherited the node class superclass provides the setting for the dash pattern Paint Patiem This determines the paint pattern used to draw the node s outline The choices are solid or 5076 gray The paint pattern may also be fixed custom or inherited If fixed model context has no effect on the paint pattern If custom model context may have an effect on the paint pattern The observed effect is controlled by an Alter method see below If inherited the node class superclass provides the setting for the paint pattern A solid pattern is used of the node class does not have a superclass The declaration properties for a node class specify some of its semantics Dependent If this property is set to true instances of this node class must be attached with a connector to another node The Gen Spe
99. c focus in DTSL is an example of a dependent node When creating an instance of a dependent node class DoME will immediately prompt the user for a node to connect it to If the user cancels the connect the node instance is also removed Instantiable If false the user is not given a means for creating instances of the node class the instantiation button is removed If true the default an instantiation button specification is created D ProtoDoME Developing Your New Model Type S If you have removed the instantiation button specification for a node class you can bring it back by toggling this setting from false to true Extemal This property specifies if the external class property should be used The node spec is displayed in gray if it is external Extemal Class The external class property allows a notation to use the classes that are defined in other DoME notations Set this property to the external class you wish to reference Be a Boundary Some nodes can act as boundary nodes in subdiagrams Boundary nodes illustrate the parent node s interface as determined by its incoming and outgoing connectors Boundary nodes are automatically created when a new subdiagram is created or a new connection is made to the parent node Boundary nodes are automatically deleted when corresponding connections are removed from the parent node This is really only half of the specification for boundaries The other half is o
100. ch of these entity types has one visual property IsMultiple An entity s IsMultiple property can be true or false An entity s default IsMultiple property is false This property can be changed using the Object Inspector Doing so will change the entity border s appearance false yields the normal border true creates a cascading appearance for the border B Colbert Methodology Colbert Object Class Diagrams Internal objects and classes have an additional visible property Kind An internal entity s kind can be Active or Passive Because the shape of an internal entity is determined by its kind the entity creation tools described on the following pages are organized with respect to this property Once an internal entity is created its kind can be edited using the Object Inspector its shape will change accordingly Entities externals are displayed as follows e Active entity rectangle with rounded corners e Passive entity rectangle with square corners e External trapezoid shape The size of an entity can be determined automatically by its name label size or manually by selecting the entity and dragging one of the four selection marks in or out Objects and classes have different line types for a node e An Object has a solid border e A Class has a dashed border Before you get started let s look at a generic example of what a Colbert Object Class Diagram looks like Figure 48 Sample Colbert Obj
101. ciated object from one overlay node to another overlay node e You can drag and drop a node directly on top of an overlay node to add it to the overlay e When an object is first created on a diagram it is added to all active overlays that do not indirectly contain the new object e If active overlays exist when a new overlay is created the new overlay is immediately added to the list of active overlays f Guide 51 Working with Diagram Overlays 3 DoMEwide Features Overlay Tools Overlays Submenu Create Edit Display All Process B Overlay Inspector Overlay Editor p 52 You can interact with the DoME overlay facility using these tools which are described on the following pages e The VIEW OVERLAYS submenu The Overlay Inspector accessed through the DoME Property Inspector e The Overlay Editor The VIEW OVERLAYS submenu for a diagram allows you to create new overlays edit existing overlays and specify which overlays are currently active If there are no active overlays all of the diagram s objects are displayed This submenu contains the following selections CREATE first lets you enter a name for the new overlay and then places an overlay object on the diagram EDIT displays the Overlay Editor which lists all overlays for the diagram and lets you select and modify any overlay DISPLAY ALL displays the contents of all diagram overlays OVERLAY NAME lets
102. ct spec can be used to specify properties and Abstract Spec relationships that you want inherited by both nodes and connectors properties are described in detail on page D 32 Normally a node specification can only be a subclass of one other node specification and a connector specification can only be a subclass of one other connector specification single inheritance and within the same kind ProtoDoME does not create tool buttons for generics since it s impossible to create instances of them they are purely abstract superclasses A generic must have at least one concrete subclass node connector list element or basic object in order to contribute semantics Multiple generics can be inherited by a single class Here s an example of this Gravitational Habitational ass Numbe population Number ey Developing Your New Model Type D ProtoDoME Basic Nonvisual Class Property Adding to a Class ius Property Name D 32 A basic class specifies an object that will not have a visualization except through property inspectors Since there is no user interface i e no creation buttons associated with such classes they must be created with Alter methods As with nodes connectors and list elements basic classes may participate in their own class hierarchy and can inherit property and relationship definitions from generics Basic classes usually serve as complex data structure
103. d A subdiagram s graph label is automatically set to the name of the node or connector it corresponds to on its parent diagram Graphical notation See Notation graphical H Hierarchical decomposition Various types of objects nodes connectors in a hierarchically decomposable model can contain another diagram or hierarchical series of diagrams These subdiagrams or implementations of parent objects are resolved through the use of configuration identifiers Glossary 3 Glossary 4 Glossary Hierarchical model One or more diagrams can be embedded in a parent object node or connector on another diagram The embedded diagram is called the subdiagram and the diagram containing it is called the parent diagram A subdiagram is typically not visible when viewing the parent To see it you must go down which creates a new window for the subdiagram HTML HyperText Markup Language A standardized language used primarily to create and maintain Internet documents and web pages Meta model A description of a class of models In DoME this is done with the DoME Tool Specification Language DTSL Minimize Maximize To iconify or de iconify the window s for a currently running application in a window based desktop environment Node A graphical object representing an entity or process on a diagram Independent nodes can be placed without constraint while dependent nodes must be connect
104. d by DoME To create an operation select the OPERATION tool move the mouse pointer to the appropriate entity s border and click SELECT The operation will snap to the border at the closest point from the mouse pointer Operations can be moved about the border of an entity by selecting the operation and dragging it to the appropriate location To help maintain consistency between Object Class and Object Interaction diagrams adding and removing operations from a class changes the available operations for the Operation property of interactions that represent requests made of instances of the class and its subclasses B Colbert Methodology Colbert Object Class Diagrams To help maintain consistency between Object Class Diagrams and Object Oriented Statecharts adding and removing operations from a class changes the available events for the Event property of transitions in the behavior description of the class or its subclasses Subdiagrams are used to describe containment part of or member of relations This illustration shows the use of operations in Object Class Diagrams Entity Relations You can describe six distinct entity relation types in Colbert 4 r Object Class Diagrams i The following illustrations show the six distinct relation types found in a Colbert Object Class Diagram Subc lass of Relation Inherits Classi Class i ST 1 LJ bo Derived from Relation Class Class Ld 2g Us
105. d processor where the user enters text and specifies the paragraph style that describes how the text should be displayed The paragraph styles can be unlimited in appearance from a simple paragraph style that displays exactly what the user has typed to a highly specialized paragraph style such as a bulleted list or a numeric bold heading The user can also specify page layout information as well as character information In addition to the traditional word processing paragraph styles there are several called MetaScribe styles which are tightly coupled to the unique capabilities that the MetaScribe system provides A paragraph that uses a MetaScribe style is called a MetaScribe statement The MetaScribe statements control which normal paragraphs are output to the generated document The editor also supports embedding expressions directly within the text When DoME generates a document it evaluates each expression and replaces it with the result The example shown in Figure 67 is a very simple document specification that outputs the names of the nodes in a model Simple MetaScribe Document Specification The name ms model model contains the nodes For aNode in nodes ms model Loop name aNode End Loop This example would produce a document containing text similar to the following text The Airplane model contains the nodes Glider Ultra light Jet A Word document template which is installed into the default Micr
106. ded with DoME contact information and terms and conditions When you select HELP ABOUT in a model editor description information for the currently active tool appears Tooltip Help In addition to help windows DoME includes tooltip help e To display the name or function of a button or icon in a window see first example below position the pointer on top of the object for a few moments and a tooltip label appears When you move the pointer the label disappears e As shown in the second example some objects in DOME windows display brief descriptions or instructions using the same method Um You may toggle tooltip help on off under the Launcher TOOLS OPTIONS WINDOW menu selection ACTIVE TOOLTIP HELP checkbox Figure 8 Tooltip Help Examples Ea DoME olx Fie View Tools Window Hel 7 SE f Guide 27 DoME Pop Up Menus DoME Pop Up Menus Figure 9 DoME Launcher 28 Figure 10 The Menu Bar givesyou accessto drop down menus where you can accessall DoME features and functions 3 DoMEwide Features Two pop up menus are available in every primary DoME window a context specific menu and a window control menu DoME Pop Up Menus replace refresh unda move copy resize cut front paste back accept collapse cancel close e In the editing pane or transcript area of a window click OPERATE see page ix to display a context specific pop up menu
107. ditor When you have created one or more subdiagrams for a Window Menu hierarchically decomposable model all diagrams that were open when you saved the model will re open when you load the model The WINDOW WINDOWS selection in the model editor Connector 2 Process B menu bar will display the primary diagram plus all open Process subdiagrams in the model Process E Files other models referenced from a parent diagram will not open when the parent diagram is opened and will not appear in the WINDOW WINDOWS selection list Change e Ina hierarchically decomposable model changes made Propagation will be propagated between parent diagrams and subdiagrams e Changes made in a hierarchical model will not be propagated between parent diagrams and referenced files Graph Labels e Ina hierarchical model the top level diagram s graph label is the name of the file in which the model is stored e Asubdiagram s graph label is automatically set to the name of the node or connector it corresponds to on its parent diagram Breaking Parent You may break a parent object subdiagram link as follows Obj ec Click lt SELECT gt on the parent object then select EDIT CUT Subdiagram SUBDIAGRAM The link between the two diagrams will be Links broken and you may choose to delete or keep the subdiagram as a separate top level model e If you want to delete both a parent object and its related subdiagram click lt SEL
108. dius Factor setting Chorded The corners will be diagonal lines chords The length of the chord is determined as a fraction of the node s size according to the Radius Factor setting None on top Like None except that rounded corners are used only for the bottom of the node the top is left cornerless Line Thic kness Width This determines the thickness of the line used to draw the node s outline Units are pixels You can choose from 1 to 4 The thickness may be fixed custom or inherited If fixed model context has no effect on the appearance of the node s line thickness If custom model context may have an effect on the thickness The observed effect is determined by an Alter method see below If inherited the node class superclass provides the setting for the line thickness Border Count A node can have between zero and three borders A node with zero borders shows the name only A node with two or three borders repeats the outline shape a few pixels further out each time Developing Your New Model Type Normal Simple Dash Cie Short Dash Long Dash Dot Dash Dot STi Dash Dot Dot Chain Phantom Declaration Properties for Node Specs C5 D ProtoDoME The border count may be fixed custom or inherited If fixed model context has no effect on the dash pattern If custom model context may have an effect on the border count The o
109. e Relation Classi f Class Lo 3 ee A use relation can also exist from an operation to a class which specifies that the operation uses the class This is more specific than saying that the whole class uses the class Colbert Object Class Diagrams B Colbert Methodology Relation Parameter o Hierarchical OCD Diagrams B 22 Instance of Relation destination should be object pm desde nU a en i E ede Class Association Class fClass2 iacu Eros d Selected by Relation f i C lassi Y f Class2 CEPS Relations can have parameters attached to them that represent parameter bindings in the receiving entity Parameters have no visual properties other than a Name label that can be edited using the Object Inspector This example shows a relation with a parameter f Classi Class2 M i i oe b B M parameter pans binding To create a parameter select the RELATION PARAMETER tool move the mouse pointer to the appropriate relation then click lt SELECT gt Its default position will overlay the relation and can be selected and moved to improve the readability of the diagram When a relation with an attached parameter is moved the parameter will move with the relation on the diagram The positioning policy may not be aesthetically pleasing in some cases requiring further repositioning of the parameter for improved readability Like other hierarchically decomposable nota
110. e format should be used Left Margin The number of inches between the left side of the page and the text at the left side of the page Right Margin The number of inches between the right side of the page and the text at the right side of the page Top Margin The number of inches between the top of the page and the text at the top of the page Width The number of inches between the left and right sides of the page Paragraph A paragraph is a portion of a document specification that may span one or more lines Paragraph Override Changes made to the global paragraph style that cause the paragraph to be displayed in a more unique manner 1 MetaScribe Output Formatters Paragraph Tag The paragraph style that describes how the paragraph should be displayed to the user Segments A paragraph in made up of a collection of segments where each segment can be uniquely displayed such as bold or underlined Paragraph Alignment Possible alignment positions Paragraph Number The numbering that is used to show that the paragraphs are numbered Counters The counters used by the paragraph number Font The font used for the numbering text e Label An identifier used to associate counters with different paragraphs Paragraph Placement Describes where a paragraph should start in the document Paragraph Style The paragraph style captures all relevant information to completely describe a reus
111. e main body of the connector The method must return one of the following symbols normal simpledash shortdash longdash dot dashdot dashdotdot chain or phantom Line Count If the appearance property Count is set to CUSTOM this property governs the number of parallel lines used to draw the connector The method must return an integer between 0 and 3 Paint Patiem If the appearance property Pattern is set to CUSTOM this property governs the paint pattern used to draw the body of the connector The method must return either solid or gray Refer to the similarly named subsection in the Node Spec section for details page D 16 D ProtoDoME Developing Your New Model Type Connection Toallow the user to create an instance of a connector you need Constraint tospecify connection constraints for it Connection constraints cumulatively determine how the connectors can be used to link nodes together Each constraint specifies for a particular class of connector what type of node can be at each end of the connector and how many such connections are allowed Origin amp Destination Type The objects connected to the origin and destination ends of the connection constraint indicate the classes of objects that are valid starting and ending points for the specified connector class For example if the constraint s connection class is Wire and the constraint connects the Chip node class to the Pin node clas
112. ect Class Diagram Bral less Furia Clam Classes are hierarchical Colbert Object Class Diagrams B Colbert Methodology OCD Tools Nodes amp Connectors Active Entities s Passive Entities E External Entities Operations is B 20 This topic describes the Colbert OCD specific tools nodes and connectors used to create diagrams Functions of the drawing toolbar buttons shown on Figure 47 Colbert Object Class Diagram OCD Model Editor are described The following illustrations summarize the various entity types one can draw in a Colbert Object Class Diagram An external class template is not a legal entity in the Colbert methodology and DoME prohibits their creation aida ET Te Acl Aree Anke ru Hi A risum Disc Deci mua A md Che Terplo 3 Colla ctor Collections l cone 1 p ri SSS Pied Pie l Panra l i Pasa ke E 1 ba TT I i ELE ie hpa Ded f Gas jj Chas ogcheeTenp ke n H bee Tenplas i Golmcten ico T f mm Cobos y 1 ji il n Li l a a F aieri inaina r I terra a i Ecbenal H Feel a p m Cham 1 obec et r HHO 5 oue D i m l Coirm 4 BLU I ox P Classes can have operations attached to their border An operation has no visual properties An operation requested of or received by an external object is displayed using a dashed line This is an OOSD convention automatically enforce
113. ect Properties 3 DoMEwide Features Name Page Long Name Description Page Rationale Page Traceability Page Color Page 48 To quickly edit just the Short Name displayed in the editing pane you may simply select the object and press lt RETURN gt If you want to give an object a long name for example on a Note object you can select the NAME tab in the inspector window fill in the text and click APPLY You can include new lines blank lines and tabs in a name on this page Under the DESCRIPTION tab you can view or edit object Description properties just like the Long Name above Normally these properties have no effect on the appearance of an object Under the RATIONALE tab you can view or edit object Rationale properties just like the Long Name and Description properties above Normally these properties have no effect on the appearance of an object The TRACEABILITY tab page shows two properties Anchor and Uplink These properties can be used to link your diagram to external documents such as a requirements document e Uplink is a reference to the anchor of an external object e g a paragraph of text in a requirements document DoME doesn t care how that external object s anchor got there or if it even exists but your traceability report generator may care e Anchor should be set to a string unique to the object In a sense it is the object s name for the purposes of registering it
114. ected class in the list When you select a class in the list the archetypes included in that class appear in the Archetypes list box Shelf archetypes can be organized by category as well as class To view or edit the category in which the currently selected archetype is grouped if any use the lt OPERATE gt mouse button in the Class Category and Archetype panels of the shelf When a class is selected in the Classes list this list displays the Shelf archetypes included in the selected class When you create a new archetype it is automatically placed in the currently selected class Except for the ADD BEND and REMOVE BEND tools this toolbar includes the same tools and objects available in the model editor where the Shelf is used Similar to the model editor editing pane this work area is used to view select or edit the currently selected archetype in the Archetypes list You can also create new archetypes in this area using the tools in the drawing toolbar When you select an archetype object in this area you can invoke an inspector window for the archetype by clicking the PROPERTIES button on the standard toolbar or selecting EDIT PROPERTIES in the menu bar You can use this multi page tabbed window to view or edit archetype properties Displays archetype instances that have been created from the currently selected archetype Displays archetype implementations that have been created from the currently selected archety
115. ector You may edit note contents Description as well as other information in this window 39 40 Model Editor Common Features 3 DoMEwide Features Notation Spec ific Tools Each notation s drawing toolbar contains a unique set of node connector and element tools Editing semantics are generally consistent across all tools with primary differences in how the attributes are edited and how different node types connect Node Categories DoME uses three categories of nodes independent nodes dependent nodes and accessories Independent nodes can be placed without constraint while dependent nodes must be connected to at least one other node in order to exist Accessories are similar to dependent nodes except that they are considered part of their containing node and always move with it e Independent nodes are created in the usual manner where a newly created node is automatically selected so you can immediately edit its attributes e When specifying a dependent node you must specify the node that the new node is to connect to after you select its position This means that you must have previously created the target node DoME prompts you to do this by changing the mouse pointer to a down arrow and waiting for you to click SELECT inside the target node An examples of a dependent nodes the Coad Yourdon Gen Spec e Accessories are components that adorn nodes they don t affect the size of a node Pro
116. ed to at least one other node Accessories are similar to dependent nodes except that they are considered part of their containing node and always move with it Also see Accessory Notation graphical A language where lexical elements are nodes and connectors and where syntax governs how those lexical elements are combined Ontology Branch of metaphysics dealing with the nature of being In the context of DoME the term is used as a noun and refers to a specification of a conceptualization Origin node When one node is connected to another the node where the connection begins Orthogonal Relating to right angles e g using DoME s SQUARE CONNECTOR ROUTE tool Parent diagram See Hierarchical model Glossary Parent object See Hierarchical model Projector Alter DoME s optional variant of the Scheme extension language a general purpose programming language that can be used to write DoME code generators document generators and other specialized tools Propagation The process of spreading out or disseminating e g certain changes on a parent diagram are also made on a hierarchical subdiagram ProtoDoME DoME s optional tool that can interpret and run DoME Tool Specifications Q Query The DoME query mechanism is class based so objects that are instances of selected classes are made visible when an overlay is active Objects made visible by a query specification are called indirect query objects
117. el editors used to create Colbert OOSD Project models similar to this example are described on the following pages DoME model editors have been created to support each of the Colbert OOSD notations used during Requirements Analysis and Preliminary Design Object Interaction Diagrams Object Class Diagrams and Object Oriented Statecharts The OOSD methodology also makes use of language specific notations during the Detailed Design phase DoME editors do not exist for these language specific notations These three editors support the development of an integrated system model by maintaining constraints and dependencies between the three different system views used in the Colbert OOSD methodology DoME s Colbert Project Tool B Colbert Methodology Figure 38 Object Interaction Diagram OID Model Editor Object Class Diagram OCD Model Editor Object Oriented Statechart OOS Model Editor Creating amp Accessing Colbert Diagrams With these three model editor types you can e Create a Colbert OOSD Project model consisting of one or more diagrams of each type Create multiple levels of hierarchical subdiagrams like several other DoME notations attached to each diagram type OID OCD OOS Colbert OOSD Project Model Editors RA Context UID o Edt o MELLE Lie Fnit DE Fie Edil Yew Layul Duus WA nduw r Debarvior H d p Noa r CH 08l
118. ement The text that is specified is optional but typically would be f File or Loop This paragraph style uses a fixed blue font The end statement has the following 1 MetaScribe Using the MetaScribe Editor syntax End text e MS File A file statement sends the paragraphs produced within its scope to the file with the name returned from the evaluated expression The file statement is typically used in those document specifications that must produce more than one document A file statement is not required in a document specification and if no file statement is present then it is assumed that the output will all go to the single file specified by the document generation dialog Each file statement must have a matching end statement This paragraph style uses a fixed blue font The file statement has the following syntax File anExpression MS Function A function statement typically defines a new Alter function that may be called from an expression in the document specification though any valid Alter expression may be specified in a function statement Function statements may appear anywhere in the document specification and are specified using Alter This paragraph style uses a fixed black font Care must be taken when defining new functions Each function statement must be a complete Alter expression Users are recommended to define all functions in a separate file that may be loaded via an Alter require pr
119. ent diagram subdiagram features in hierarchically decomposable models and DoME start up script capability Chapter5 Tips Hints amp Work Arounds A friendly gathering of tips hints shortcuts and fixes Appendix A Coad Yourdon O O Analysis How to use DoME Ss extension to the Coad Yourdon Object Oriented Analysis notation several code generators available including SQL Appendix B Colbert Methodology How to use our Colbert Project Tool with Object Interaction Diagrams Object Class Diagrams and Object Oriented Statecharts Harel based Appendix C Data Flow Diagram How to use DoME s graphic representation of a system s information flow Appendix D ProtoDome How to create your own graphical editors from DoME Tool Specifications Preface Revision History REVISION Table 1 describes the evolution of this document When you History communicate with us please identify the documentation and software versions you are using Table 1 DoME Guide Revision History Publication Number Rev Date Description TRG M99 001 A 1 99 Updated to DoME Version 5 2 TRG M98 001 A 8 98 Updated to DoME Version 5 1 TRG M97 001 A 4 97 Original manual updated and reorganized to support DoME version 5 0 Rela ted This guide is your primary how to and reference for the Doc uments DoME core tool set as well as a few specialized tools in the appendices Other documentation supporting specialized DoME capabilit
120. ently displayed diagram Gridding has three states off on and hidden Grid size is specified in pixels Standard Toolbar Toggles the model editor standard toolbar on off Drawing Toolbar Toggles the model editor drawing toolbar on off Message Area Toggles the model editor message area at bottom of window on off The LAYOUT menu includes the following selections Bring to Front Bring selected object s in front of other objects on a diagram Send to Back Send selected object s behind other objects on a diagram Connectors This submenu contains the following commands Center Name Select a connector and use this command to move the connector s name tag back to the default position approximately at the connector s midpoint Square Route Square up the bends route points in a selected connector creates right angles 3 DoMEwide Features Model Editor Tools Menu Document Generator Alter Evaluator Plug Ins Model Editor Common Features Swap Ends Reverses the direction of a directed arrow connector Nodes This submenu contains the following commands Align Lefts Align the left edges of selected nodes Align Centers Align the centers of selected nodes vertically Align Rights Align the right edges of selected nodes Align Tops Align the top edges of selected nodes Align Middles Align the middles of selected nodes horizontally Align Bottoms Align t
121. etimes this is acceptable sometimes not DTSL gives you a way to override the default Property Categories Properties can be grouped into categories with each category given a separate page in the inspector You can define as many categories as you like By default properties are in the category called Properties Categories are inherited from property definitions in the superclass chain If you want a property to be hidden from the user with no user interface access for editing specify a category of None You still have access to this property via Projector Alter D ProtoDoME Developing Your New Model Type Property Partial Ordering Normally ProtoDoME will present a set of properties in alphabetical order in the inspector You can override this ordering For each property specify which other property it is to come after This constitutes a partial ordering of the properties If you delete a property designated as another s predecessor the remaining property will be placed as close to alphabetically as possible Sheet Build This must be set to Dynamic for ProtoDoME Text Widget Height If the property is of type Long String DTSL allows you to specify the height of the text editing widget in lines The default is 5 Property Local Value Has Priority Constraints This value is used in conjunction with archetypes By default any changes to a property are made directly to the requested object If th
122. eveloping Your New Model Type Adding Menu Items menu item Creating a Submenu Custom Tool Buttons If you want to add one or more items to an existing DoME menu create a new Menu object in your DTSL specification and set its name to be the same as one of the existing menus in the standard DoME menu bar e g Edit The items you create inside this Menu object will be added to the end of the standard DoME menu If you want to add entries to the pop up menu for a particular class of object set that class s Menu property to the desired menu specification Drop new menu items into the appropriate Menu objects ProtoDoME uses the menu item s name to construct the user interface label for the actual menu entry The menu item s Alter method is passed the argument called object If the menu item is installed in the menu bar the argument is the window s graph If the menu item is installed in the pop up menu the object associated with the mouse click is passed as the argument Some typical menu commands operate on the set of currently selected items You can retrieve this set by executing the expression select components object lambda x get property isSelected x If a menu is used as a pop up menu the enabling methods on the items can be used to enable and disable individual menu commands depending on the context They are passed a single argument just as with the action method If you want a menu item t
123. explicitly set by the user This means that a property instance s value may appear to change spontaneously if the property s default value is changed For example Fred creates a DTSL specification with boolean property inLine in node class Block The default value of inLine is false Frieta creates a model of this type with two instances of Block She leaves one alone but changes the inLine property of the other to true Then she saves the model and closes it Subsequently Fred changes the default value of the inLine property to true When Frieta loads her model the next time both instances will show a value of true for the inLine property The following Alter methods may be supplied to control the behavior of setting a property You specify all such methods as a body for a lambda expression that binds the symbols listed in the property inspector to an instance of the object and possibly other parameters Guard Condition The expression must return a boolean value If the expression returns f then the set property operation is prevented from happening Post Action This method is called immediately after the set property operation is completed The expression may contain any actions you want The return value is ignored Menus and submenus can be added to the standard DoME user interface for ProtoDoME models You can add items to existing menus or add entries to the pop up menus on model objects D ProtoDoME D
124. f every page Page Numbering Specification of page numbers including numbering style and location Paragraph Borders Shading Various graphic information associated with a paragraph style Tables An orderly arrangement of information with optional headers and dividers Variables Information that is displayed based on some computed value such as the current page number or the date 1 MetaScribe Output Formatters Creating a New Formatter F Guide Output Formatters Although it is conceivable that DoME may have hundreds of document specifications available for use there may only be a few output formatters For instance if a user creates a new document specification and wants to be able to produce a document that can be understood by FrameMaker then they do not need to create a new FrameMaker based output formatter since one already exists and can be used without change As time goes on new output formatters for other tools will be created and made available by default with DoME DoME currently supports a couple of output formatters e Maker Interchange Format MIF ms mif formatter alt which is used by Adobe FrameMaker e Unformatted Text ms text formatter alt which can be used to produce source code or any plain text file These general use MetaScribe output formatters can be found in the dome home tools metascribe formatters directory Before creating a new formatter the formatters
125. f one visual object may affect the appearance of one or more related objects throughout a model For example changing the name of a data flow in a parent diagram will automatically change the names of all views of that flow in hierarchical subdiagrams In this version of DoME notations that support hierarchically decomposable model structures include e Colbert OOSD Project e Data Flow Diagram DFD Document Outline e IDEF 0 Diagram e Multi Page Model Projector Diagram e ProtoDoME Model e State Transition Diagram See notation specific documentation or online help for parent diagram subdiagram reference file information that pertains to each notation only 4 DoME Advanced Features Hierarchical Decomposition in DoME Models Parent When you work with hierarchically decomposable models Diagrams you will need to know the following terms Subdiagrams amp Parent Diagram A diagram on which one or more parent Referenced Files objects nodes connectors reside e Parent Object A node or connector that holds a subdiagram or file model reference e Subdiagram A diagram in the same model held by a parent object node connector on a parent diagram this subdiagram in turn can be the parent diagram for other subdiagrams in the model and so forth e Referenced File A different model of any type linked to a parent object node connector on a parent diagram a model you want to select
126. fferent with respect to the title bar buttons window appearance and various other desktop widgetry The important point we d like to make here is that DoME is platform independent and performs identically on UNIX Macintosh and all flavors of Windows regardless of the desktop decor and widgetry used You will encounter various items distinguished by specific fonts or symbols Formatting Conventions Example dome_dir model dome Transcript show Hello lt RETURN gt lt ESC gt lt CTRL C gt lt SELECT gt lt OPERATE gt APPLY REVERT FILE NEW LAYOUT CONNECTORS SWAP ENDS p Description Variable Indicates an element for which you must supply a value Literal text Often used for file path names and operating system commands Code fragments Key names mouse button names Brackets and names are not to be entered literally Widgetry selections Button or menu selections are indicated by name submenus and options are delimited by colons Notes cautions warnings Indicated by this symbol pointing to the text Preface Conventions Used in This Guide The Mouse Since DoME runs under multiple platforms we re obliged to Button Dilemma deal with three distinct breeds of mice in a democratic 2 manner the one two and three button varieties From the perspective of a one button mouse for example it could be confusing if not insulting to refer
127. grams to various parent nodes and connectors on a parent diagram Creating and accessing subdiagrams or referenced files from a parent object is a simple process 50 on your Data Flow Diagram create at least one each of the Note Process External Store and Boundary objects Connect several of these objects if possible using both Data Flow and Control Flow connectors 5l Click lt OPERATE gt on each node and connector type noting the results for each object On all object types other than the Process node and Data Flow connector a pop up menu similar to the menu bar appears On the Process node and Data Flow connector however you will see a single option GO DOWN 52 Click OPERATE on a Process node then click the Go DOWN option The Choose Implementation dialog box appears giving you a choice to create a new subdiagram or select a file model or diagram of any type to reference from the parent object Figure 5 Choose Implementation Dialog Box Choose Implementation Ed Reference File Select Existing E E Cancel F Guide 21 Creating a Parent Object amp Subdiagram onnector 1 Connector 3 onnector 2 Process A 22 2 Quick DoME Tour 53 Perform the following to create subdiagrams or file references linked to parent nodes and connectors e Click CREATE NEW to display the Select Model Type list which enables you to create a new sub diagram of any ty
128. h Objects Classes amp Class Templates B 18 OCD Tools Nodes amp Connectors L B 20 Hierarchical OCD Diagrams B 22 Colbert Object Oriented Statecharts B 24 Working with States 0 0 00 B 24 OOS Tools Nodes amp Connectors sss B 26 Hierarchical OOS Diagrams B 29 In This Appendix s12sacdindavasn ats Xr RR RC C 1 About Data Flow Diagrams DFD C 2 The DoME DFD Model Editor s sss C 2 Creating a Hierarchical DFD Model C 3 oh In This Appendix s assez oe e Rak eR deam ea D 1 What is ProtoDoME sseee D 2 E Meta Sc ribe Glossary Index Contents How ProtoDoME Works i2 cue Kies ca re D 2 Creating a New DoME Tool Specification D 3 Naming Your New Model Type suues D 4 Viewing Your New Model Editor D 5 Saving Your New Model 5 oes o ER Rt tes D 6 Developing Your New Model Type D 8 INCAS SPEC rie weston on eder cedent oed arse D 8 Connector Spet bain sith cet eee nas aks D 18 Connection Constraint s s eass cee eee eee D 25 Last Elements cora e SEE r tn PEE EE deena D 26 Node Elements amp 1 bye e eR S epa ep D 30 Generic Abstract Spec ooo oS M Roses ea D 31 Basic Nonvisual Class lessees esse D 32 Property Adding to a Class ssuuue D 32 Menus ooeseti w
129. h having unique line types as shown below Um An interaction s default mechanism is simple synchronous and its type can be changed by setting its Mechanism property using the Object Inspector Simple Interaction Operation Request Timed Interaction Operation Request 4 Balking Interaction Operation Request 4 Op Req Asynchronous Interaction Operation Request Extemal Interaction Operation Request Op Reql Je a i p_Req2 Colbert Object Interaction Diagrams Information Flow B 14 oF gt Error Flow a B Colbert Methodology An interaction to or from an external object is displayed using a dashed line This is an OOSD convention automatically enforced by DoME The Operation property can be either None or the name of a valid operation for the receiver of the request A valid operation is one that is defined for the object s class or one of its class s superclasses When an interaction s Operation property is set to a particular operation not None the name of the operation is displayed as the interaction s name label If the Operation property is None the interaction s name is displayed as its name label An interaction operation request may have attached to it zero or more information flows An information flow has two visual properties Direction and Mechanism Direction can be set to either In Out or In Out Mechanism can be set to Copy Grant or Gi
130. han 40 have been used in the past Although each tool supports a specific notation all tools derive real strength from a common foundation This foundation consists of a multi layered hierarchy of classes supporting both graphical model semantics and user interfacing In addition to supporting multiple model editing tools GrapE provides a framework from which new robust domain specific tools can be developed within a matter of a few hours to a few days Foundational DoME s foundational features include Features Domain Specific Model Syntax Enforcement e Hierarchical Decomposition e User Directed Model Diagram Navigation e Alternative Model Views e User Defined Typed Annotations New Notation Most of the DoME tool set has been automatically generated Generation using DoME Tool Specifications When working with these specifications methodologists first enter a graphical high level specification of node and connector types connection constraints and additional syntax and semantics S Using ProtoDoME available with DoME 5 0 and up you can create and run new tools directly from DoME Tool Specifications See the ProtoDoME appendix in this guide for more information Arbitrary Model In addition to the foundation layer and ProtoDoME support Transformations for component infrastructure developers is enhanced with two more tools Projector and Alter These tools are built into and use the DoME infras
131. he bottom edges of selected nodes Distribute Horizontally Even out the horizontal spacing between selected nodes Distribute Vertically Even out the vertical spacing between selected nodes Flip Up Down Vertically flip exchange placement of selected nodes Flip Left Right Horizontally flip exchange placement of selected nodes Spread Spread out or contract the space between all nodes and route points by a factor you choose This can be useful if a diagram is getting too crowded or has become too spread out This is different from ZOOM in that only locations are affected font and node sizes remain the same The TOOLS menu includes the following selections Document Generator Open the Document Generator Settings window to configure and generate documents for the currently displayed diagram Output formats include plain text RTF MIF Interleaf ASCII PostScript and unformatted SGML Alter Evaluator If your version of DoME includes the Projector Alter option use this selection to open the Alter Evaluator window to write test and debug Alter programs When the window opens the selected item is bound to the symbol self If no item is selected the diagram itself is bound to the symbol self See the DoME Extensions Manual and Alter Programmer s Reference Manual for detailed information Plug ins This user defined submenu allows you to select tools that have been defined by you an
132. he collection of character styles that may be used as font descriptions Colors The collection of colors that may be used as font colors Page Layout Specification of how the pages of the document are laid out Paragraph Styles The collection of paragraph styles that may be used as paragraph tags Paragraphs The collection of paragraphs that make up the document End Statement The MetaScribe end statement Expression A request for some data from the model being operated upon File Statement The MetaScribe file statement Font Case Describes how characters should be displayed with respect to the case of the character set Font Position Position used to distinguish the text Font Posture Describes how characters should be displayed with respect to the angle of the character set Font Weight Describes how intense the characters should be displayed Function Statement The MetaScribe function statement Loop Statement The MetaScribe loop statement Numbering Style Numbering style describes how various numbers should be displayed Page Specification The page specification specifies information about how the pages are laid out Bottom Margin The number of inches between the bottom of the page and the text at the bottom of the page Columns The number of columns on each page Height The number of inches between the top and bottom of the page Landscape Specifies that landscap
133. hoose Implementation Dialog Box Choose Implementation x Reference File Select Existing Ej E Cancel The Choose Implementation dialog box gives you the choice of creating a new subdiagram or selecting a reference file for the parent object Perform the following to create subdiagrams and file references linked to parent nodes and connectors Click CREATE NEW on the Choose Implementation dialog box to display the Select Model Type list From this list you can create a new sub diagram of selected types notations that will be hierarchically linked to the parent object e Once a subdiagram has been created you will go directly to the subdiagram when you select Go DOWN on the parent object e To return to the parent diagram click the PARENT DIAGRAM button on the model editor standard toolbar 4 DoME Advanced Features Hierarchical Decomposition in DoME Models Referenced Files Click REFERENCE FILE on the Choose Implementation dialog box to select an existing model that will be hierarchically linked to the parent object Um The file model you want to reference from the parent object must be open when you implement the reference e Once a reference file link has been established you will go directly to the referenced file when you select Go DOWN on the parent object Unlike subdiagrams you will not be able to return to the parent diagram by clicking the PARENT DIAGRAM button Model E
134. iagram s or keep them as independent unlinked models Color This submenu contains the following commands Set Item Color Use this dialog box to set the color for one or more selected objects and set the color to be locked or unlocked You may change the lock but leave the colors alone as is 3 DoMEwide Features Model Editor View Menu Ctrl Ul Parent Diagram Subdiagram Ctrl D Top of Model Diagram Ctrl T Data Dictionary Hierarchy Map Overlays gt Set Change Color Description Coloring Grid v Standard Toolbar v Drawing Toolbar v Message Area Figure 18 F Guide Model Editor Common Features Rotate Item Color Shift the colors of all non black items according to the following sequence red to green to blue to cyan to magenta to yellow to black Reset Item Color Set the color of all items on the diagram to black Objects with locked colors are not modified Properties Use this selection to display the DoME Property Inspector for the selected object see topic on page 45 Short Name Use this dialog box Enter the new name to rename the selected object The dialog box provides only a single line for the name string but you can insert line breaks by typing the backslash character wherever you want a line break You can also display this dialog box by pressing the lt INSERT gt or lt RETURN gt key with an object selected We recommend that you use
135. ic types as described previously for attributes an enumeration or one of the classes defined in your model Parameters You can create an unlimited number of parameters for each service in a C amp O node Each parameter has a name and a type You may create parameters by using the ADD button see below You may then modify a given parameter by selecting it in the list adjusting the values in the appropriate dialog widgets A Coad Yourdon O O Analysis Using Enumeration Lists Figure 34 C amp O Node Service Properties Page fal Service of x Ele Edi View Name add student aq Traceability Color X Refs Return type Student Class Object Sca sl Parameter names Parameter Spec student IN gt Student usi ame student Type Student Class O B Direction HA cn In Out Out TBD Using ENU in DoMECYOOA diagrams enumerations are explicit lists of meration Lists Enumeration nodes are not designed to be connected to anything but they may appear as types for attributes To me create a new enumeration list simply select the ENUMERATION tool in the drawing toolbar and place it on the editing pane Enumeration constants may be added to enumeration lists by cong Selecting the ENUMERATION CONSTANT tool in the drawing tart toolbar and placing one or more constants inside an enumeration list node To view or edit the constants in an enumeration list select a consta
136. ies and disciplines include DoME Extensions Describes the DoME Projector Alter extension languages with Manual examples covering artifact generation code documents test cases print engines file formats DoME client server interfaces via RPC and others Also describes the complete set of Alter primitives Alter Technical description of Alter DoME s variant of the Scheme Programmer S extension language A general purpose programming Referen ce Manual language Alter can be used to write DoME code generators document generators and a host of other specialized tools Ux If you can t readily locate printed documentation on specific DOME functions be sure to check DoME online help for the information you need or instructions on how to find it vii Conventions Used in This Guide Conventions Used in This Guide Appearance of Windows amp Screen Elements Typographic Conventions Table 2 viii Preface Throughout DoME printed documentation and online help various conventions are used to identify technical terms computer language constructs mouse keyboard operations and window screen element appearance The desktop windows and screen elements shown in DoME documentation depict what you would typically see in the Microsoft Windows 95 or NT 4 0 and up environment If you are running DoME on a Macintosh or UNIX platform your actual DoME windows and screen elements will look di
137. in a traceability database Currently DoME does not have a standard way of generating trace data files but you can write your own using DoME s optional Projector Alter extension facility On the COLOR tab page you can set the color of any visible DoME object Currently eight colors are supported black white red green blue cyan magenta and yellow These are mapped accordingly when you print or export the graphics If you are using a color to indicate changes DoME will sometimes change the color of an object for you To defeat this feature for a specific object lock the object s color by checking the FREEZE check box on this page 3 DoMEwide Features Working with Object Properties Cross References Use the X REFS tab page to set up modify or delete cross X Refs Page references between objects on diagrams An easy to use set of drop down lists text entry fields and function buttons are provided for working with cross references Overlays Page Usethe OVERLAYS tab page to associate overlay information with both diagrams and diagram objects See Working with Diagram Overlays on page 51 for information on overlays The DoME The Hierarchy Browser shown below is another tool you can Hierarchy use to inspect and edit DoME models diagrams and objects Browser Like the DoME Map see page 35 this browser enables you to step back and get an overall view of your work To display a graphic tree
138. in just minutes And the Projector Alter extension languages allow you to write new functions that are tightly integrated with DoME Several export formats supported PostScript Rich Text Format RTF Interleaf and Frame Maker Interchange Format MIF are supported for documentation And for example several software generators specialized back ends have been written for the Coad Yourdon tool that generate database schema code In fact you can write additional functions for any DoME tool DoME s pome currently supports several common notations as well Common 5 few domain specific notations Those available in the current DoME software release are Notation Set e Coad Yourdon Object Oriented Analysis e Colbert Object Oriented Software Development Project e Data Flow Diagram structured analysis e Document Outline 2D spider diagrams e DoME Tool Specification e DEF 0 diagrams e Multi Page Model Petri Net Model e Projector Diagram DoME visual programming system e ProtoDoME Engine with a sample Roadmap tool e State Transition Diagram e User Defined Property Specification Domain Specific Notations 1 Introducing DoME Domain Specific Notations DoME s underlying GrapE infrastructure is a powerful launch point for the prototyping of new domain specific notations and general purpose tools Typical applications include the areas of multimedia computer supported cooperative
139. in specific syntax rules A set of rules that discriminates on the basis of appearance only between what is and is not a valid diagram for a particular class of diagram Element Often displayed as text only items in a list elements sit inside nodes e g a list of attributes in an IDEF 1x entity Glossary Endpoint Either the origin or destination end of a connector attaching two nodes together Extension language A programming language used to create specialized functions that can be integrated with the core of a software application F File reference See Reference file G Generator Sometimes referred to as back ends DoME generators can produce specialized output directly from the contents of a diagram or collection of diagrams Typical generator products include software data definitions for databases and word processor document inserts DoME s optional Projector Alter programming language can be used to write code generators document generators and other specialized tools GIF Graphics Interchange Format GrapE Graph Environment DoME foundation consisting of a multi layered hierarchy of classes supporting both graphical model semantics and user interfacing built on VisualWorks Graph label Node containing the name of a diagram initially located in upper left corner of editing pane In a hierarchical model the top level diagram s graph label is the name of the file where the model is store
140. ings of an operation request to an object s implementation To move an operation request from the border to an internal object select the connector grab the head tail of the connector with the mouse pointer then drag it to the appropriate internal object and release it B Colbert Methodology Colbert Object Interaction Diagrams In addition operation requests may be drawn to from the border to internal objects e g see the Initialize and Finalize operation requests below The illustration below shows the six distinct binding patterns permitted Note that interactions that are connected to one of the contextual objects those without borders representing objects in the parent diagram must be originally created and deleted in the parent diagram The non contextual end of the connector can be changed but the contextual end cannot incoming connection attached to the border incoming connection reattached to internal object connection from border to internal object 1 2 3 4 outgoing connection from border to external object 5 outgoing connection from internal object to external object 6 outgoing connection from internal object to border Figure 46 Permissible OID Binding Patterns 2 5 Cit d Tp Mani K E rvar au a ml Li i Corie ere io Pied t j Sija 1 Faham lean 3 po Fue 6 4 Dix ip Magi Colbert Object Class Diagrams Colbert Object Class Diagrams
141. ion 3 4 5 21 64 Hierarchy Browser 73 home location DOME 69 how to get started x icon predefined D 17 Index 4 Index tool button D 16 IDEF 0 Diagram 5 IDEF 1x Diagram 5 inside bottom D 9 inside top D 9 instantiable connector specification D 21 list element specification D 28 node specification D 12 interface specifications 2 Interleaf 5 K keyboard shortcuts DoME menus 26 E 3 drawing toolbar 26 L label presence D 18 D 22 label text connector specification D 23 label text method node specification D 14 D 29 Launcher 9 28 Filemenu 29 Help menu 30 Tools menu 29 transcript area 9 Window menu 30 line count D 20 D 24 line count method D 14 line style alter method connector D 24 nodes D 14 connector specification D 21 node specification D 12 line width alter method connector D 23 nodes D 14 connector specification D 20 node specification D 11 local value has prioerity D 35 M Macintosh viii 8 Index Maker Interchange Format MIF 5 44 Map View DoME 35 73 mark 4 markers parent object 22 menu bar 28 menu item specifications D 37 menu specifications D 36 creating submenus D 37 menus Model Editor 33 menus pop up 28 message area 12 32 42 Meta CAD D 2 meta modeling 2 methodologists 2 3 MIF see Maker Interchange Format 5 model auto saving 24 closing 23 create new 11 hierarchical 21 opening 24 printing 24 saving 23 syntax enforcement 3 Model Edito
142. is is set to false and the object has an archetype then the change is made to the object s archetype rather than to the requested object Dependence If a property is of type Object and instances of the property may point to nodes connectors list elements or basic objects you probably want to check this box Doing so instructs ProtoDoME to automatically clear any such property whose referent goes away Visual Impact If the property has an impact on how the object appears check this box This prompts ProtoDoME to update the object s visual appearance when the property s value changes Transient If the property is transient then the value is never saved when the model is saved Read Only Declaring a property to be read only disables the user interface widget for the property but still displays the property s value to the user A read only property can still be modified with Projector Alter Developing Your New Model Type D ProtoDoME Alter Methods for Properties Menus D 36 Unsettability Can Be TBD In some cases it s preferable to allow a property to have no value i e nil rather than supply a default value DoME often indicates this with TBD Default Value Once you have specified a property s type you can also specify a default value New instances of the property will automatically have this value For a user s model DoME does not save to disk properties that have not been
143. jector operator ports and Colbert class operations are examples of accessories They are created just like other nodes except that you must click lt SELECT gt on the node that you want to contain the accessory Connector Tools The minimum operation for creating a connector is to specify the origin and destination nodes for the connector Some model formalisms such as IDEF 1x do not attach importance to connector direction Also you may specify intermediate route points when creating a new connector e Unrouted connectors shortest path Click SELECT first on the origin node then on the destination node The connector will be drawn between the nodes properly clipped to the edges of both nodes To abort a connector creation once you have started it press the lt ESC gt key Routed connectors Click SELECT first on the origin node then where you want intermediate routing points and finally on the destination node To abort during the 3 DoMEwide Features Model Editor Common Features Model Editor Editing Pane Menus in Editing Pane Auto Scrolling in the Editing Pane f Guide connector creation process press the lt ESC gt key Element Tools Elements sit inside nodes They are often displayed as text only items in a list such as a list of attributes in a Coad Yourdon class To create a new element first select the tool then click SELECT on the node that you want as the containe
144. king with An asterisk appears to the left of the name once you make the first change to a diagram after creating or opening it indicating that you have unsaved changes The asterisk disappears when you save the diagram in an editable format File Edit View Layout Tools Window Help You will find all DoME model editor functions listed in the drop down menus on the menu bar Each DoME editor supports a common set of menu options and some editors augment this set with notation specific selections All menu items have keyboard shortcuts See DoME Keyboard Shortcuts on page 26 DoME model editor menu selections common to all notations are listed and described on the following pages The FILE menu includes the following selections New Create a new model opens Select Model Type list Open Find open an existing model opens the Open dialog box Merge Read an existing model into an open window and add its contents to the currently displayed model opens the Request File dialog box Revert to Saved Replace the currently displayed model with the last saved version Save Save the currently displayed model or a whole set of diagrams if hierarchical in native editable DoME format under its current file name Save As Save anew model the first time save a model under a different file name or save a model in a different format for exporting opens the Save As dialog box Print Print the
145. lable in the Launcher Open Models Browser and across all DoME model editors and resident notations A skim once use as a reference type of chapter Go to Chapter 4 DoME Advanced Features This chapter covers the remaining features common to several but not all DoME tools The DoME Shelf reuse repository Shelf Browser Data Dictionary parent diagram subdiagram features available in hierarchically decomposable models and DoME start up script capability are described With the lights now getting brighter take a long step into the specialized topics in the appendices and related documents These supplements include the information you need to turn on all the lights in the DoME And don t forget DoME is a highly interactive tool set and as with most software most often the best way to become proficient is to try it all out Preface How to Reach Us How to we d love to get your feedback on the DoME software and Reac h Us documentation Feel free to drop us a note Email dome info htc honeywell com Web www htc honeywell com dome With all communications please include the version number of the software and or documentation as well as the type of computer and operating system you are using xi How to Reach Us Preface xii Introducing DoME KANN f AZN In This Chapter F Guide ROY This chapter includes e lt A brief discussion of model
146. lass appear In most cases you can change these properties even after you have created instances of the connector class and DoME will update their appearance accordingly In other cases you must close the model and reopen it to see the new shape To view and or modify the properties associated with a connector class select the connector and click on the PROPERTIES button on the standard toolbar Label Presence The choices for this property are Always Every instance of the connector class will always have a name default is new lt Connector Spec Name gt If the user deletes the label object from a connector that connector still has a zero length name 1 You will need to specify connection constraints before DoME will allow you to create any instances of the connector D ProtoDoME Developing Your New Model Type Sometimes The presence of a label on an instance depends on the context as implemented by the connector specification s Label Presence Alter method see below Never Instances of the connector class will not have labels their names will always be empty strings Origin amp Destination Head The direction of a connector can be displayed with decorations on both the origin side and the destination side Two properties govern each end The default for the origin side is no decoration The default for the destination end is to always show an arrow head Head Presence The possible values are Ne
147. lection types D 34 component infrastructure developers 2 3 computer supported cooperative work 6 configuration identifier 4 connection class D 25 connection constraints D 25 connector Add Bend tool 17 bending 17 changing endpoints 17 creating 13 naming 14 Remove Bend tool 17 renaming 13 rerouting 18 routing 17 selection 12 14 tools 14 40 connector head properties D 19 connector specification alter methods D 22 conventions viii corner connector specification D 20 radius Index 2 Index alter method D 15 style D 11 alter method D 15 creating a subdiagram 21 creation check method connector specification D 23 node specification D 14 D 29 creation cleanup method connector specification D 23 node specification D 14 D 29 cross references 5 custom button specifications D 37 custom icons and cursors D 17 cutting and pasting objects 19 D dash pattern alter method for nodes D 14 connector specification D 21 node specification D 12 Data Dictionary 62 Colbert OOSD Project B 7 Data Flow Diagram 4 5 8 C 1 description C 2 example C 3 hierarchical decomposition C 3 model editor C 2 overview C 2 declaration properties connector specifications D 21 node specification D 12 default value D 36 deleting objects 20 deletion check method connector specification D 23 node specification D 14 D 29 deletion cleanup method connector specification D 23 node specification D 14 D 30 dependent node specification prope
148. lied to execute drawing commands to display the node an ellipse is displayed if the method is missing The shape is assumed to be basically elliptical for the purpose of clipping connectors Inherited The node class superclass provides the shape property If there is no superclass the Rectangular setting is used Resizable This specifies whether the user can interactively change the size of the node Eccentricity This specifies the aspect ratio that the node should have for both rectangular and circular nodes A value greater than 1 0 will make the node wider A value less than 1 0 will make the node taller D ProtoDoME Developing Your New Model Type Comers This applies only to Rectangular node shapes see above ILI None The cornering may be fixed custom or inherited If fixed C Square model context has no effect on the appearance of the node s T Reunded corners If custom model context may have an effect on the a corners The observed effect is determined by an Alter method see below If inherited the node class superclass provides iene oniop the setting for the corner appearance The settings for the corner shape and their meanings are as follows None The node will have no corners either on the top or on the bottom Square The node will appear as a normal box Rounded The corners will be rounded The corner radius is determined as a fraction of the node s size according to the Ra
149. ls ProtoDoME is a very dynamic environment enabling you to immediately see the impact of changes to your DTSL specification in an editor for a model instance Additions to a DTSL spec are immediately propagated to all open model instances and their user interfaces except perhaps the object inspectors Other kinds of changes to a DTSL spec are not dealt with quite so automatically The following topic describes these limitations and how they affect the instance models and their user interfaces There are two sorts of changes modifications to existing items and the removal deletion of items Keep the following points in mind when you make changes in your DoME Tool Specifications When you change the properties of a creation or custom button ProtoDoME automatically updates the user interfaces of any windows that are open on that type of model This also happens if you move the buttons around or add or remove columns from the toolbar specification ProtoDoME does not use the name of a class except to present information through the generated user interface However you may have written Projector Alter code that makes reference to the name of the class so keep this in mind Otherwise go ahead and change the name of your classes as much as you like Whereas ProtoDoME does not use class names internally it does use property names If you save a ProtoDoME model with an instance of property cost set to 5 and then change
150. ls Developers Artifacts Methodologies Interface Specs System Models Analysis Alcordins Tool Specs Product Models Generators Ontology V amp V Models Training Configuration Component and Models Infrastructure Tools Processes Domain Specific Tools 1 Methodologists analyze modeling methods and build model authoring tools to support the capture and management of domain specific models 2 Product Developers describe the product or system being developed using formal modeling techniques and the model authoring tools developed by methodologists 3 Component Infrastructure Developers use their knowledge of the target environment to a develop model analysis mechanisms that enhance model understanding and b transform models into software artifacts source code documentation test cases interface specs analysis algorithms and generators specialized back ends 1 Introducing DoME What is DoME Model Based Since its beginnings the DoME project has sought to enhance Development the prototyping and production of graphical model based Using DoME development environments DoME focuses on the second division of labor in the engineering process triad defined on the previous page providing powerful tools and support for product developers The DoME tool set supports a wide range of domain specific graphical notations Currently nearly a dozen resident tools are included with DoME and more t
151. lue and parameter information e Relationships can be annotated with several properties including ordinality e A Data Flow connector type is available e Subjects can be used to dynamically restrict the set of nodes and connectors that are visible e Diagrams can be graphically annotated with issue nodes and links which is a handy way to convey review comments or keep track of limitations while developing a model These extensions combined with the ability to generate implementation code give you a powerful set of specialized tools you can use to evolve models during your project using them as up to date anchor points all the way through 1 Peter Coad and Ed Yourdon Object Oriented Analysis Second Edition Yourdon Press Computing Series Prentice Hall Inc 1991 A Coad Yourdon O O Analysis The DoME CYOOA Model Editor The DoME CYOOA Model Editor Figure 30 Select Move Add bend WI Class amp dete Attribute dimer Issue a NM Service Smart Connector Message Connector Data Flow Connector The Importance of Order in Model Creation H The DoME Coad Yourdon OOA editor is equipped with the four common tools SELECT MOVE ADD BEND REMOVE BEND NOTE included with most model editors as well as the specialized nodes connectors and tools shown below DoME Coad Yourdon Editor Eel an unsaved Coad Yourdon 00A File Edit View Layout Tools Window Help
152. m DFD For more information on DFD see the Data Flow Diagram appendix in this guide 2 Quick DoME Tour About the Launcher As discussed previously DoME behaves identically across all platforms even though you will only see illustrations of Windows 95 NT 4 0 and up screen elements and windows in this guide If you are not using Windows 95 or NT 4 0 the appearance of your actual windows icons and desktop widgetry will be different Um You may generically apply the procedures in this chapter to other DoME tools If you follow these steps to create a model other than the DFD example simply fill in the blanks with information from the chapter appendix related documentation or online documentation that describes the specific model you are using About the When you start DoME the Launcher appears shortly after the he banner screen The Launcher is your primary interface with La unc r DoME features and functions and you will use it to create open save models browse open models view set your DoME desktop options and perform other operations Figure 2 Introducing the DoME Launcher Menu Bar fe DoME LE JOU x Toolbar Jl Ele View Tools Window Hel Ca Create War m8 new model 71 aj Open existing model Transcript area shows current status xl activity FILE menu Create a new model open an existing model save all open models view open a recently opened model exit DOM
153. n Access SAVE AS FM SPEC DOCUMENT generates a MIF file that can be imported into a FrameMaker template SAVE AS C CODE generates class definitions for C source modules When generating code DoME defines the two sides of a Part Whole relationship as inverses if the target system supports it In addition to the standard output formats and code generators already wired into DoME you can add your own generators using DoME s optional Projector Alter programming environment Like other DoME models Coad Yourdon OOA models can also be printed to files in specific formats including PostScript XWD bitmap GIF and RTF Colbert Methodology m In This This appendix includes the following topics A end ix e About Colbert Object Oriented Software Development J p OOSD Methodology page B 2 e DoME s Colbert Project Tool page B 2 e Colbert Object Interaction Diagrams page B 10 e Colbert Object Class Diagrams page B 18 e Colbert Object Oriented Statecharts page B 24 F Guide B 1 About Colbert OOSD About Colbert OOSD DoME s Colbert Project Tool B Colbert Methodology This appendix assumes that you are familiar with Colbert Object Oriented Software Development OOSD methodology Originally developed by Absolute Software Inc the Colbert OOSD methodology includes a collection of notations supporting objected oriented analysis e Object Interaction Diagrams OID
154. n hierarchical models can have multiple subdiagrams In notations that provide this capability the various subdiagrams or implementations of parent objects are resolved through the use of configuration identifiers Nodes can contain things Nodes can be adorned with other kinds of objects For example Petri Net places can contain marks tokens and Coad Yourdon classes can contain lists of attributes and services In some notations entire hierarchical subdiagrams can be contained and displayed from within a node or connector You can directly manipulate these items in various ways e g one common operation is to move them from one node to another Node size automatically determined Node boundaries generally expand or shrink to fit the text inside This is a design decision for each specific notation which often results in cleaner simpler interfaces T Introducing DoME DoME s Common Notation Set Diagrams can interelate Diagram components can refer to other components or diagrams in separate models either through hierarchy relationships or more general cross reference relationships DoME is highly extensible Because DoME s foundation is Smalltalk it has a great deal of flexibility and growth potential New editors based on new visual grammars can be added in a matter of a few hours or days The ProtoDoME tool for modeling tool developers can get you up and running with the prototype of a new tool
155. n models F to open a recently opened file X to exit DOME Save All Recent Files gt Exit For the second type of DoME menu shortcut hold down the lt CTRL gt key and press the appropriate key e g lt CTRL O gt to open a model Shortcuts for Model Editor Drawing Toolbars In any DoME model editor window you can use shortcuts to select tools nodes or connectors in the drawing toolbar Drawing toolbar shortcuts for each model editor are listed in both the tooltips underlined character and DoME online help for the specific notation you are using HELP EDITOR HELP TOPICS DRAWING TOOLBAR KEYBOARD SHORTCUTS You may print the notation specific lists of drawing toolbar keyboard shortcuts in online help To select a tool or object in the drawing toolbar Press the appropriate shortcut key or Click the appropriate button in the drawing toolbar 3 DoMEwide Features DoME Online Help DoME O nline DoME includes the following types of online help Help Help Windows e When you select HELP HELP TOPICS in the Launcher or HELP DOME HELP in a model editor a window containing topical help on DoMEwide functions appears When you select HELP EDITOR HELP TOPICS in a model editor a notation specific help window appears e When you select HELP ABOUT DOME in the Launcher the DoME Information window appears This window contains copyright information brief descriptions of the notations and tools inclu
156. n the Connector Class Specification see below That is where you select which boundary node will serve to illustrate the interface for a particular class of connector Can Be An Archetype If true then the node will behave like an archetype Subdiagram Subdiagrams Properties fi or Node A node can be specified to not have a subdiagram to have a Specs subdiagram that is restricted to a certain collection of model types or to have a subdiagram that can be any model type To create a subdiagram for an instance double click on the instance or click lt OPERATE gt with the instance selected Click the Go DOWN option Alter Methods The following Alter methods may be supplied to customize for Node Specs the appearance and behavior of a node class You specify all such methods as a body for a lambda expression that binds the symbols listed in the property inspector to an instance of the object and possibly other parameters e g graphics context for drawing lines Developing Your New Model Type D ProtoDoME Object Label Text The expression must return a string DoME uses this string to render the name label for the node Typically this is some enhancement to the name property of the node For example append name self thing Creation Check The expression must return a boolean value If the expression returns f creation of the node instance is aborted Otherwise the node instance is created The argument
157. n you have selected the second node the drawing toolbar switches back to the arrow Select Move tool mode again and the connector is drawn from the origin node to the destination node An arrowhead on the connector indicates connector direction If you want to cancel connector creation in progress press ESC before you select the destination node 12 Name the new connector by pressing RETURN after you click SELECT on the connector All named objects except the graph label can be renamed using this method 2 Quick DoME Tour Moving Nodes Moving When nodes have been placed on a DoME diagram they re by Nodes no means cast in concrete l3 Make sure the arrow Select Move tool at the top of the k drawing toolbar is selected This is the default mode when no other tool is selected 14 Move the pointer on top of one of the Process nodes then click and hold lt SELECT gt Four selection markers appear around the node 15 Hold lt SELECT gt and move the pointer around the editing pane As you move the pointer it will change from an arrow to cross hairs and you will see an outline of the node under the pointer 16 Keep holding lt SELECT gt and move the pointer against beyond the diagram borders to the right or downward DoME s auto scroll feature lets you dynamically move nodes connectors or selected groups of objects outside the limitations of the visible editing pane on large diagr
158. nd the data dictionary will switch to view the newly selected object Us The data dictionary is not automatically updated as new objects are created To have the data dictioary update itself just reselect the current type in the VIEW menu DEME cuiae i Hierarchical Decomposition in DoME Models Hierarchical Decompost tion in DoME Models Multiple Diagrams in a Single Model Notations That Support Hierarchical Decomposition 64 4 DoME Advanced Features In all DoME notations various objects that can be placed on diagrams can contain things such as detailed descriptions rationale and lists of attributes They can also be hidden or displayed in diagram overlays color coded and categorized The possibilities are practically endless giving both your imagination and skills the freedom they need to accomplish your goals One of the most valuable features DoME offers is the ability to create hierarchically decomposable models which consist of multiple interrelated diagrams In this type of model the impacts of changes made on one diagram can be automatically propagated throughout all diagrams in the entire model In hierarchically decomposable models various objects nodes connectors on a diagram can actually contain another diagram or series of diagrams These subdiagrams or implementations of parent objects are resolved through the use of configuration identifiers Changing a property o
159. ne style alter method D 16 property D 10 pop up menus 10 28 D 37 position of node name D 8 post action D 36 PostScript 5 encapsulated 44 mosaic 43 printing 43 presence of connector head D 19 primitive types D 33 print engines vii printer names UNIX 44 printing 24 43 engines vii printer names 44 product developers 2 3 Programmer s Reference Manual Alter vii Projector vii 3 5 69 description 4 Diagram 5 60 properties 45 categories D 34 default value D 36 object 42 ordering D 35 specifications D 32 text widget height D 35 widgetlabel D 34 ProtoDoME 3 5 D 1 Create ProtoDoME Model option D 5 description D 2 Model 5 overview D 2 publication number vii Q quick tour DOME 7 Index 6 Index R Raise Launcher button 72 74 read only properties D 35 recent files list 72 reference file parent object 22 67 74 reflexivity of connection constraint D 26 refresh 9 18 74 registration files D 43 related documents vii relocatable D 9 Remove Bend tool 17 18 resizable property D 10 reuse software 4 Rich Text Format RTF 5 44 rounded connectors D 20 rounded node corners route point adding 17 18 moving 18 removing 18 square 19 RPC vii 69 RTF see Rich Text Format 5 rubber banding 16 D 11 S saveas 23 saving a model 23 42 68 74 schema code 5 Scheme extensionlanguage vii scrollbars 32 Select Move tool 13 15 services 4 shape alter method D 15 property D 9 sheet build D 35 Shelf 4
160. nee es 71 Optimizing DoME Memory amp Speed 72 Helo WHC Dr 72 Working Smart on Your Desktop 04 72 Working Smart on the Editing Pane 73 Naming Saving amp Managing Your Files 7A ion This Appendix iau o DOE ERE VERE REFERRE A 1 About Coad Yourdon OOA 00 eens A 2 The DoME CYOOA Model Editor sss A 3 The Importance of Order in Model Creation A 3 C amp O Node Properties amp Appearance A 5 C amp O Node Attribute Properties e144 LEER RERO A 6 C amp O Node Service Properties 00000005 A 8 Using Enumeration LI565 2 mper Chro ncn A 9 Using DoME CYOOA Views lsseesse A 11 Using Subject Lists yas seed poke dr ae a Oe otn A 12 CYOOA Tools amp Code Generators A 14 adit This Appendix oos uuu suo uh ER au ex EVE B 1 About Colbert OOSD 0 0 0 0 00 00 nee B 2 DoME s Colbert Project Tool iore eee B 2 Colbert OOSD Model Editors B 3 Object Enspectof ess dedicato yee te KG on meses B 6 Colbert OOSD Projects amp DoME s Data Dictionary B 7 Nonvisual Dette xs a cese rapa REOR RS B 8 Colbert Object Interaction Diagrams B 10 Working with Objects cosa hte EE ERE RA B 10 OID Tools Nodes amp Connectors B 12 Hierarchical OID Diagrams B 15 Colbert Object Class Diagrams sssese B 18 Working wit
161. ng it and dragging one of its four selection marks in or out Transitions Connectors in an O O Statechart represent transitions between states The label of a state transition consists of the triggering cy event name a guard test and action Eventi State Conditiont State2 Action 222 These labels are represented as properties and may be edited using the Object Inspector The guard test and action properties are strings The Event property can be None or the name of a valid operation for the class whose behavior is described by the statechart A valid operation is one that is defined for the class or one of its class s superclasses When a transition s Event property is set to a particular operation not None the name of the triggering event label is the name of the operation If the Event property is None the name of the triggering event label is the transition s name Note that the condition appears below the event name in brackets The action appears below the line Colbert Object Oriented Statecharts B 28 State Entrances B Colbert Methodology In Colbert OOS diagrams there are three ways to specify the initial state of a substate explicit transition to that state default initial state i e indicated with the initial state marker described above and state entrances The following paragraphs describe state entrances The final topic in this appendix describing hierarchical
162. nother difference is that there are expressions that retrieve information from the DoME model embedded within the text of the document etaScribe Editor An output formatter describes how to transform a processed document specification into output that may be used by a specific tool One output formatter that is included with DoME produces a FrameMaker based document Details for defining an output formatter are described in the Output Formatters section After a document specification and output formatter have been created they are associated with DoME as described in the Integration with DoME section Users can then use the standard document generation dialog to generate MetaScribe based documents such as reports or source code When DoME generates a document it interprets the special paragraphs in the document specification as programming language constructs and performs the desired actions It then feeds the produced paragraphs to the output formatter which writes the paragraphs out in the desired format The Debugging section describes what can be done to fix problems with defective document specifications and output formatters 1 MetaScribe Using the MetaScribe Editor Figure 67 Word Template Using the MetaScribe Editor The MetaScribe editor was implemented by extending the Microsoft Word word processor The editor is therefore very similar in functionality and appearance to a traditional wor
163. nt in the list and then click the PROPERTIES button on the standard toolbar see below DeeME Guide A 9 Using Enumeration Lists A Coad Yourdon O O Analysis Figure 35 Enumeration Constant Properties Enumeration Constant OF x Ele Edit View Department Name German Value German Biology Chemistry Compi Economics French cum History literature Mathematics Philosophy Physics Russian A Coad Yourdon O O Analysis Using DoME CYOOA Views Using DoME CYOOA Views Parent Diagram subdiagram Top of Model Diagram Data Dictionary Hierarchy Map Overlays Set Change Color Description Coloring Grid Standard Toolbar Drawing Toolbar X QUE Message Area Subject Attributes Views Name View Go to View Bring Item Into View Kill View Different from DoME overlays and parent diagram subdiagram relationships described in chapters 3 and 4 DoME Coad Yourdon OOA views are actual copies of a diagram In DoME s CYOOA notation Hierarchically decomposable parent diagram subdiagram capability is not available Standard DoME overlays can be used to hide display specific groups of objects on a single diagram CYOOA subject lists can be used to hide display specific types of objects on a single diagram see next topic CYOOA views can be used to create and modify dynamically linked copies of a diagram The VIEW VIEWS menu opti
164. o be implemented as a submenu first create the submenu in the same way as you create any other menu Create a Menu object and fill it with Menu Items Then drag that Menu object on top of the parent Menu object The DTSL editor will create a submenu reference in the parent menu DoME automatically creates buttons on the toolbar for creating the various kinds of objects you define in the DoME Tool Specification With the custom tool button you can add buttons to the tool bar that have essentially arbitrary behavior Developing Your New Model Type D ProtoDoME D 38 Custom tool buttons are just like the automatically created ones except that they have an additional Action Alter method This method is executed whenever the user applies the button selects the button and then clicks somewhere in the editing area The lambda expressions are evaluated in the context of an environment in which the symbol the graph is bound to the window s graph model and the symbol location is bound to the point where the user clicked in the editing area the point 0 0 is the upper left hand corner of the editing area Hnmes new Dusan Geton im frereana For pce D ProtoDoME The Impact of Changes on Existing Models Modifications in DoME Tool Specs Changing an Icon or Cursor Renaming a Class Renaming a Property Changing an Appearance Property on a Node or Connector The Impact of Chanees on Existine Mode
165. oME automatically creates Alter object types that you can use for defining methods in your Projector Alter code The type names are derived from the class names in the DTSL specification and its context properties For example if you have a node class specification called Operator and the Class Prefix context property is set to Control the generated Alter class will be called controloperator Case is not significant in Projector Alter These object types can be used as arguments to add method and other primitives that require Alter types Here is an example that may clarify a few things Let s say you have a node specification called Block in a DoME Tool Specification and that you have created an instance of Block in another window via ProtoDoME You can do the following D ProtoDoME Creating Plug in Model Types 1 Select the instance and in that window invoke TOOLS ALTER EVALUATOR menu command This brings up an alter evaluator with the symbol self bound to the new instance 2 If you type self in the Input pane and hit RETURN you will see something like lt value TBD lt Block gt gt in the Output pane 3 If you have set the Class Prefix in the DoME Tool Specification to say ABC then the expression get type self returns abcblock The symbol abcblock has been bound to an Alter type that represents the type of the model object You can use this type to define methods and to create new instances To contin
166. ocedure specified from a Function statement The Alter code in that file may then be edited by an editor that supports Scheme e MS Loop A loop statement loops through a collection and repeatedly produces the paragraphs that are within its scope Each pass through the loop updates the variable which is an Alter identifier to the next value in the collection If the optional Metered lt text gt is specified then a dialog is displayed showing the text and the progress of the loop Each loop statement must have a matching end statement This paragraph style uses a fixed blue font The loop statement has the following syntax For lt aVariable gt in anExpression Loop Metered lt text gt The paragraph and character information for the MetaScribe styles can be customized in any manner the user desires As long as the names of the MetaScribe styles remain unchanged the MetaScribe system will work as described For instance if a smaller font is desired for comments then just change the font for the MS Comment paragraph style E 5 Using the MetaScribe Editor 1 MetaScribe Global Variables User Interface MetaScribe Menu Eve niger mectaip Save inorren Ae isot parma Irt Sp ment Geek cerra Mira Error List Maroc Docursant Gara ahibn Errors Saleh All dn Sepai The MetaScribe system defines three global variables that may be used in expressions or function statements e ms model This varia
167. odels Unlike nodes you cannot create connectors until nodes are in place Each end of a connector must be attached to a node 8 Create another Process node circle on your Data Flow Diagram and name it Process B 13 Creating Connectors Process QD a TBD Process CD 14 2 Quick DoME Tour 9 select the uppermost connector tool Data Flow PP Connector in the drawing toolbar and move the pointer on top of Process A The pointer changes to cross hairs for a Data Flow Connector Note that if you select the lower connector tool Control Flow Connector the pointer becomes a dimmed arrow 10 Click SELECT and move the pointer around on the editing pane The pointer itself does not change but as you move the pointer a thin line dynamically connects Process A to the moving pointer cross hairs The first node you select when working with connectors is the origin node Interpretation of the specific notation used affects the meaning of origin node vs destination node but for now you don t have to worry about that When creating connectors between nodes you may use the auto scroll feature described under Step 16 to connect the destination endpoint ll Move the pointer on top of Process B and click lt SELECT gt Exact positioning of the pointer on top of the destination node is not necessary since DoME clips the connector at the boundary of each endpoint node Whe
168. oduced is selected and the settings that are to be used during document generation are specified New document specifications and output formatters must be associated with DoME in order for users to be able to use them The following sections describe this process DoME searches the dome home tools etc directories for the generator description and formatter description files at start up In order for DoME to recognize the existence of a MetaScribe based document generator you must create a generator description file named document dom and place it in one of the locations DOME searches A generator description file describes one or more generators and has the following form DoMESGMLDocList generatorspec Where generatorspec looks like DoMEMetaScribeGeneratorSpec functionName menu string graphType symbol outputTypes OrderedCollection symbol sourceFile pathname where functionName is a string that is used to form an entry in the GENERATOR menu of the docu ment generator dialog graphType is a symbol representing one of the DoME graph model types This docu ment specification will appear in the GENERATOR menu of the document generator dialog of those editors that are editing graphs of this type outputTypes isa collection of symbols describing where a document can be output Valid values are directory file and win dow sourceFile is a string giving the filename of
169. ols allow you to export other types of files e g for generating schema definition code from a Coad Yourdon model Selecting FILE PRINT opens the Print dialog box that lets you choose the type of printout you want and the printer you want to send it to Print Dialog Box Format Single Page Size 000 M Landscape Child Graphs Too Cancel Two hardcopy print formats are supported by DoME single page and mosaic Single page The diagram is scaled down if necessary to fit on a single 8 5 x 11 sheet of paper in portrait or landscape orientation e Mosaic The number of sheets is governed by setting the printout size DoME uses 8 0 of the width of each page and 10 5 of the height Setting the size to 21 square the default will produce a mosaic three sheets across and two sheets down There will be some overlap between pages to help you line things up properly and make it easier to slice off the edges most laser printers now allow printing right up to the edge of the paper Output from these formats is sent to the default printer under Windows In addition both the Windows and UNIX platforms support postscript versions of these formats 43 Model Editor Common Features 3 DoMEwide Features Special Formats Printer Names UNIX only Additional formats are available for integrating DoME models into documents e Encapsulated PostScript Generates a form that can be
170. ols from within DoME directly from standard DoME Tool Specifications without having to step outside and use VisualWorks development resources to finish the job DoME Tool Specifications amp ProtoDoME Select Model Type r Coad Yourdon OOA Colbert OOSD Project CyberDoME Model v qre DoME Tool Specification IDEF 0 Diagrarn Multi Page Model Petri Net Model Projector Diagram ProtoDoME Model State Transition Diagram Technology Roadmap ProtoDoME Based Model UML Class Diagram ProtoDoME Based Model User Defined Property Specification Cancel Ei As described in this appendix working with DoME Tool Specifications and ProtoDoME is a simple process 1 Define and begin to develop a new object model using the graphical DoME Tool Specification Language DTSL Your new notation can include object classes properties and relationships as well as new node and connector types unique object appearances tool buttons menus annotations semantic relationships and other elements 2 During development use ProtoDoME to directly interpret run view and make changes to your new model editor ProtoDoME is a dynamic Meta CAD environment that allows you to design modify and run new graphical language systems on the fly by directly interpreting your DTSL specifications Your new graphical languages can include textual numeric and symbolic annotations D ProtoDoME Creating a New DoME Tool
171. ome recursion of terminology is inevitable though unfortunate D ProtoDoME Developing Your New Model Type Property Type ProtoDoME supports several primitive data types as well as enumeration and user defined types Basic classes Primitive Types ProtoDoME supports the following primitive types Type Valid Values User Interface Boolean Simple true or false Either a menu or a check box Number Both integers and A numeric input floating point numbers field Numerical Same as Number A numeric input Range field with a slider based on the lower bound upper bound and increment String Any string of A string input field characters of any whose height is length In Alter two one line of text strings may be equal but not eq Long String Same as String A string input field whose height can be specified Symbol Like a String but two Same as String symbols that are equal are also eq in Alter Filename A string that is a valid String input field file name for the host plus a browse button Enumeration User defined A menu Enumerations ened Enumerations are user defined types with an explicit set of symbolic values cone Enumeration constants have a display name and a symbolic tant value ProtoDoME munges the display name to come up with EM the symbolic name It removes all spaces and capitalizes the first letter of each word except the first This is relevant if you are writing Projector Alter program
172. on contains five commands related to CYOOA views Create View Creates a linked copy of the displayed diagram and opens a new editor window on it The copy is called a derived view Changes to the original view such as renaming deleting and adding are automatically propagated to the derived view but not vice versa All changes to the derived view except name changes affect only the derived view You can create a hierarchy of views Name View Names the current view This works for all Coad Yourdon diagrams even if you haven t created any derived views yet Each view can have a name and it is advisable to give each one a distinct name since this makes navigating among them with the Go TO VIEW command easier Go to View Allows you to open a window on one of the derived views if any or the original view When you choose this command DoME pops up a list of currently defined views with the original view appearing first if you are currently working in a derived view You can also use the WINDOW WINDOWS selection on the menu bar Bring Item Into View If you delete an item from a derived view that was originally copied from the original view and later want to bring it back into the derived view you can bring a linked copy back into the derived view by selecting the item in the original view and then invoking this command in the derived view Kill View Use this option if you either accidentally created a view or you no l
173. on outside the visible editing pane Auto Scrolling Nodes When you select a node in the drawing toolbar click SELECT on a visible portion of the editing pane The node will appear on the pane with selection marks around it 41 Model Editor Common Features 3 DoMEwide Features is Model Editor Message Area p Model Editor Object Properties DoME File Formats 42 Click and hold SELECT on the node then drag the node beyond the border of the visible editing pane The editing pane will shift to keep the object you are moving in view When you reach the destination you want for the node release the mouse button s Select VIEW MAP to control the area you are viewing in the editor Auto Scrolling Connectors When you select a connector in the drawing toolbar click SELECT on the origin node in the visible portion of the editing pane When you move the mouse pointer you will see an outline of the new connector move across the editing pane To attach the connector to a destination node located outside the visible portion of the editing pane simply move the mouse pointer in the direction of the destination node When the destination node comes into view click SELECT on the destination node The connector will appear Select VIEW MAP to control the area you are viewing in the editor DoME displays informational messages in this area at the bottom of the editing pane As you move the mo
174. onger need a view You cannot kill a view that itself has derived views you must delete its derived views first Using Subject Lists Using Subject Lists E Figure 36 A Coad Yourdon O O Analysis CYOOA diagram subject lists are similar to standard DoME overlays When you create a subject list you can selectively hide information e g a list of classes without actually altering a diagram Each subject list may include one or more object types e g C amp O enumeration or other subject nodes To create a subject list first select the SUBJECT node in the drawing toolbar and place it on the editing pane Then click lt SELECT gt on the new node and click the PROPERTIES button on the standard toolbar to display a subject members editing window see below Subject Members View Eel Subject of xj File Edit View Name First Subject aq Traceability Color X Rets Overlays In Subject Not in Subject All Attributes ClassQUsl All Class amp Objects lt All Data Flows lt Class All ClassReferences All Enumeration Cons All Enumerations lt Cle All Gen Specs Class All Inheritance Links lt All Issue Links Class All Issues ClassQue All Messages Class All NetNotes lt ClassC All Part Whole Relatic You can alter the contents of a subject list as follows Directly edit the list of classes using the window shown above The list on the left side shows the objects that
175. ools Window Help Note 1 NoName Model Type Experimental Graph 5 4 Abstract Spec Graph Spec Basic Class Spec Relationship Spec Enumeration Spec Enumeration Constant Menu Spec Menu Item Spec Custom Tool Button Graph Label Entity Env Link Node Part Whole Property Spec Service Spec Smart Connector Node Specification Link Specification a D 3 Naming Your New Model Type D ProtoDoME Naming Your New Model Type Figure 62 As shown in Figure 61 DoME Tool Specification Model Editor context properties are displayed in the graph label located in the upper left corner of the editing pane 3 Click lt SELECT gt on the graph label then click the PROPERTIES button on the standard toolbar A property inspector window appears DoME Tool Specification Properties E DoME Tool Specification for Experimental Gr Ee E3 Model Type Name El Experimental Graph Class Prefic Ell Experimental Load FieB 0 ol Can Be Top Model E True False Tool Description l 4 Inthe inspector window set MODEL TYPE NAME to a descriptive string Model Type Name This is the name of your new model type that will appear in the DoME Select Model Type list see Creating Plug in Model Types on page D 42 The other fields are optional Class Prefix The class prefix is used to prefix the specification names in order to make them more unique For example
176. or bring to the front existing Colbert diagrams using the VIEW menu selections or the WINDOW WINDOWS menu e You must select an object on an OID or OCD in order to create or access an O O Statechart As with other hierarchically decomposable DoME notations all three Colbert OOSD Project diagram types can generate and maintain multiple levels of hierarchical subdiagrams Standard DoME hierarchical model features are available including the ability to create and maintain a subdiagram from any allowable parent object on a Colbert diagram In the DoME Colbert OOSD Project Tool the parent object determines the type of subdiagram that will be created e An object in an OID can have an OID subdiagram B 5 DoME s Colbert Project Tool Object Inspector Figure 40 B Colbert Methodology e A class in an OCD can have an OCD subdiagram e A state or orthogonal in an OOS can have an OOS subdiagram When you click the Go DOWN option after clicking lt OPERATE gt on an object that can generate a hierarchical link to a subdiagram the appropriate type of subdiagram is created if necessary and opened for editing For more information on parent diagrams parent objects and subdiagrams see Hierarchical Decomposition in DoME Models on page 64 Like other DoME notations the properties of Colbert OOSD diagram entities e g objects classes states and so forth can be viewed and edited in an Object Inspector window To
177. osoft Word directory when DoME is installed contains the MetaScribe related capabilities including the MetaScribe styles menus and toolbar This template can be specified as the base template from which to create new documents If an existing document needs to have the MetaScribe template associated with it then attach the template to the document from the dialog opened by Tools gt Templates and Add ins menu The Automatically update document styles box must be checked otherwise the required MetaScribe paragraphs styles are not imported The template named MetaScribe dot may be found in either the Microsoft Word directory or the dome home J tools metascribe templates directory E 3 Using the MetaScribe Editor 1 MetaScribe Expressions Styles E 4 The user is warned when opening a document specification since the MetaScribe template defines several macros Be sure to select Enable Macros when loading the document otherwise the MetaScribe menu and toolbar capabilities will be unavailable Expressions are used to access information from the model and are specified using the Alter extension language Expressions that are in regular paragraphs have the result of the evaluated expression placed directly into the generated document Expressions that are in MetaScribe statements are used in rendering of the generated document Expressions are implemented in Microsoft Word via the fill in field object Al
178. other user or your system administrator Typical tools include a node count utility HTML maps and so forth 37 Model Editor Common Features 3 DoMEwide Features Model Editor The WiNbow menu includes the following selections Window Menu windows i Lists all currently open diagrams in this model only selectable An asterisk Windows precedes the name of each diagram that contains unsaved changes Reuse Window Reuse Window Refresh Click this selection if you want to reuse this editing window to start a new Refresh Extensive diagram rather than open a new window check mark displayed when active Refresh Clear the entire window and redisplay everything This function is useful if the graphics have been corrupted or blurred for some reason e g changing a connector s route over a wide area Refresh Extensive DoME performs a regular refresh and also verifies that all nodes and connectors are placed correctly Model Editor Help The HELP menu includes the following selections Menu Editor Help Topics Open a help window that contains notation specific help for this model editor Includes a list of keyboard shortcuts you may use to select drawing toolbar tools and objects on the currently displayed diagram DoME Help Open a help window that contains information on common features and functions available across all DoME tools and model editors You may also access notation specific help from this window
179. ouse mileage avoui e On large diagrams experiment often with the ADJUST inam ZOOM list box on the standard toolbar to enhance your Window P perspective Hel EE e If you re not content with the selections in the ADJUST ZOOM list box you may concoct your own on the Launcher TOOLS OPTIONS ZOOM page Onlarge diagrams use the editor LAYOUT SPREAD selection to shorten the distance between all your objects Objects remain the same size Onlarge diagrams click OPERATE on the name of the object you want to select in the Overlay Node list Select GO TO to select focus on the object on the diagram Connactor 1 e If you want to make sure your diagram objects line up use Connactor 4 the editor VIEW GRID selection to restrict the positions of Process B nodes and connector route points Process C e If you use the grid often but not always use the editor Process D VIEW GRID GRID HIDDEN selection rather than GRID OFF 73 Naming Saving amp Managing Your Files 5 Tips Hints amp Work Arounds Naming Saving amp Managing Your Files 74 If you want to run DoME with editor toolbars and tooltips turned off print HELP EDITOR HELP TOPICS DRAWING TOOLBAR KEYBOARD SHORTCUTS for the notations you ll be working with To quickly return to a parent diagram from a referenced file in a hierarchically decomposable model clicking the PARENT DIAGRAM button won t work click the RAISE LAUNCHER button
180. pe 61 The DoME Data Dictionary 4 DoME Advanced Features Follow User Navigation Checkbox The DoME Data Dictionary Viewing amp Editing Dictionary Items 62 Check this box to have the Shelf focus on the reference that was most recently selected on a diagram For example if you are working with a diagram that has a reference on it and you would like to know what its archetype is you can open the Shelf check the Follow User Navigation checkbox and then select the reference on the diagram When you return to the Shelf it will be focused on the selected reference if it has an archetype It s possible to open a Shelf Browser and then close all diagrams for the model All diagrams in the model will be directly accessible from the Shelf Browser Implementations list except for the parent diagram Double click the diagram you want to open in the list You can open the parent diagram by clicking the PARENT DIAGRAM button on the Shelf Browser standard toolbar As you create and modify a model DoME automatically builds and updates a dictionary of model elements Access the Data Dictionary window for a currently open model by selecting VIEW DATA DICTIONARY in the model editor menu bar A typical Data Dictionary window is shown on the next page The Data Dictionary contains an inventory of items found in the currently open model and can be used to inspect and modify various aspects of an item s state
181. pe that will be linked to the parent object Once the subdiagram has been created you will go to the subdiagram when you next select Go DOWN on the parent object e Click REFERENCE FILE which enables you to select an existing model of any type that will be linked to the parent object The model you want to select as a referenced file must be open When you next select GO DOWN on the parent object you will go to the referenced model When you have created a subdiagram or reference for a parent object the object will display markers indicating that it has a hierarchical subdiagram or reference In the example to the left Process B Process C Connector 1 and Connector 2 display box and circle markers indicating that they are parent objects The next time you click GO DOWN on the parent object you will go directly to the subdiagram you created or the reference file you selected When you create a subdiagram changes made will be propagated between the parent diagram and subdiagram If you choose to select a reference file rather than create a subdiagram for a parent object changes made will not be propagated between the parent diagram and reference file For example if you change the name of a connector in the parent diagram any boundary nodes or related connectors in the reference file will not be automatically updated To return to a parent diagram from a subdiagram click the PARENT DIAGRAM button on the standard
182. plication and cross platform database access Subdiagram See Hierarchical model Target format Format of the output produced by a generator back end Target medium Storage device used to store the generated output and tools other than DoME used to process the generated output e g C compiler for generated C data structures Toggle Turn a switch on or off e g add or remove a check mark in a checkbox Top of model diagram The root or original diagram in a hierarchical model Widget Tool button list or other user interface device used to perform a task in a window based desktop environment XWD X Window Dump format Index aN AZY Symbols Esc key 14 17 19 73 Operate mouse button ix 73 Select mouse button ix x Window mouse button ix dome load path 69 A aboutthis guide vi above D 9 abstract generic specification D 31 accessories node 40 Add Bend tool 17 Alter vii 3 5 69 description 4 Evaluator 9 primitives vii Programmer s Reference Manual vii types in ProtoDoME D 42 Alter methods connector specifications D 22 node specifications D 13 D 29 properties D 36 Alter Projector Browser 9 annotations 3 archetypes 61 implementations 61 instances 61 artifact generation vii 2 attributes 4 auto saving models 24 auto scroll 14 15 16 17 18 19 back end see generators 5 basic class specification D 32 below D 9 bending connector 17 bipartite 4
183. r common features 12 32 common tools 39 drawing toolbar 39 editing pane 41 Filemenu 33 Help menu 38 Layout menu 36 Map View 35 menus 33 message area 42 notation specific tools 40 standard toolbar 38 Tools menu 37 View menu 35 Window menu 38 model based software development 2 mosaic PostScript 43 mouse buttons ix X multimedia 6 Multi Page Model 5 multiple objects working with 16 name position D 8 F Guide alter method D 15 node accessories 40 boundaries 4 categories 40 creating 12 dependent 40 destination 14 independent 40 moving 15 objects contained within 4 origin 14 renaming 13 selecting multiple 16 selection 12 13 size 4 13 node corner shape D 11 node shape DoME Tool Specification D 9 node shape method D 15 Node specification D 8 non visual class specification D 32 O object code 2 cutting and pasting 19 deleting 20 properties 42 Open Models Browser 9 31 options settings DOME 9 ordering properties D 35 ordinality of connection constraint D 25 origin head presence method D 22 style method D 23 overlay node 73 P paint pattern D 12 alter method connectors D 24 nodes D 15 connector specification D 21 parent diagram 21 64 object 21 parent object Index 5 markers 22 reference file 22 67 part whole Coad Yourdon OOA A 3 Petri Net Model 4 5 bipartite 4 plug in registration files D 43 polyline D 10 polyline point array method D 16 polyli
184. r for the new element By default elements are named TBD The standard toolbar drawing toolbar and message area can be hidden to make more room for the editing pane see bottom of VIEW menu The editing pane is a plane that conceptually extends infinitely to the right and downward think of the origin as being in the upper left corner As you add objects to a model the scroll bars automatically adjust so you can scroll over an area roughly twice the width and height of your model You can exploit the area to the left and above the window as well If you move a diagram item to the left of or above the origin the entire diagram will slide to the right and or down to accommodate the move As you move the mouse pointer into the editing pane the pointer adopts the shape of the currently selected tool The default tool is SELECT MOVE arrow The editing pane is initialized to show elements at normal size DoME itself places no limits on the number of nodes and connectors you can put in a single diagram and you can use the scroll bars ZOOM utility VIEW MAP and auto scrolling to simplify navigation Every object has a pop up menu that is specific to it with the three default entries Rename Properties and Go Down Menu entries that are not currently applicable are disabled When you create a new node or connector you are not restricted to placing it in the visible portion of the diagram You may auto scroll to a locati
185. r over the editing pane As you move the pointer it changes shape from an arrow to a circle Typically every tool used on a diagram has its own button and pointer D Click SELECT with the pointer anywhere on the editing pane A circular shape appears where you click the mouse h button and the drawing toolbar mode switches back to the arrow Select Move tool The node you just created is automatically assigned the name newProcess All newly created objects are named new concatenated with the type of the object created The four black selection markers around the node indicate that the object is selected has focus LEN In most cases the content of a node determines the size of the node on the editing pane You cannot normally use the selection markers to change its size as with general purpose drawing tools Rena ming On a DoME editing pane you have several ways to change the O bjec ts short name of a selected object The simplest and quickest requires no mouse action 6 with the TBD node you created still selected press lt RETURN gt m m A dialog box asks you to enter a new name for the node 7 Type Process Aand press lt RETURN gt again The dialog box disappears and the new name appears inside the Process node Note that the size of the node increases to accommodate the name C reating Connectors are the second type of diagram entity used in C onnec tors DoME m
186. render the label for the connector Typically this is some enhancement to the name property of the connector For example append name self thing Creation Check The expression must return a boolean value If the expression returns f creation of the connector instance is aborted Otherwise the connector instance is created The argument to the method is the diagram that would contain the new connector Creation Cleanup This method is called immediately after the new connector is created The expression may contain any actions you want The return value is ignored Deletion Check The expression must return a boolean value If the expression returns ff deletion is aborted If you want the user to be notified of the reason the method must do this DoME will not do this automatically If the expression does not return ff the connector is deleted Deletion Cleanup This method is called immediately after the connector is deleted The expression may contain any actions you want The return value is ignored Line Width If the appearance property Line Width is set to CUSTOM this method governs the line width used to draw the connector The method must return an integer greater than 0 Developing Your New Model Type D ProtoDoME Changing an Icon Cursor amp Shortcut D 24 Key Line Style If the appearance property Line Style is set to CUSTOM this method governs the dashing pattern used to draw th
187. ring Case Font Case Normal Family String Position Font Position Auto Number Counter Segment Posture Font Posture Display Boolean Font Weight Character Tag Size Integer Prefix String Bold Character Override ae es i Boolean Start Value Integer Extra Bold POSUNE soca Style Numbering Style Extra Light Variation Float Suffix String Light EY Weight Font Weight Type Auto Number Type Medium Semi Bold E Semi Light F Text Ultra Bold Color Ultra Light Content String N Colors Color Auto Number Type Black Float Assign Cyan Float Increment Magenta Float Maintain Expression Name String Text Yellow Float J w Numbering Style Arabic Lowercase Alphabetical Lowercase Roman tY N i aN E N Uppercase Alphabetical Assignment Comment Conditional End File Function Loop Uppercase Roman XK 7 a SS Color A color is used to describe the color of a font Black Percentage of black Cyan Percentage of cyan Magenta Percentage of magenta Name The name of the color Yellow Percentage of yellow E 11 Output Formatters 1 MetaScribe Comment Statement The MetaScribe comment statement Conditional Statement The MetaScribe conditional statement Document Specification A container of all of the information that is used to describe a document Character Styles T
188. rolling the window itself Ea DoME _ Oo x File View Tools Window Hel Tooltips t AS To display the name and often a brief description of a DOME button icon or other widget first click the mouse anywhere in the window to return focus to the window if necessary Then position the pointer on top of the object for a moment As shown above a tooltip appears When you move the mouse the tooltip disappears You may toggle tooltips on off under the Launcher TOOLS OPTIONS WINDOW selection Online Help When you select HELP HELP TOPICS in the Launcher or HELP DOME HELP in a model editor a window containing indexed topical help on the DoME core tool set appears When you select HELP EDITOR HELP TOPICS in a DOME model editor a Help window containing detailed help on the specific notation you are using appears e When you select HELP ABOUT DOME in the Launcher the DoME Information window appears This window contains DoME copyright information descriptions of the tools included with DoME contact information and terms and conditions When you select HELP ABOUT in a DOME model editor description information for the currently active tool appears 2 Quick DoME Tour Creating a New Model C reating A Begin here to create a new model New Model 1 Click the New button on the Launcher toolbar The Select Model Type list appears Us If the Projector Alter and or ProtoDoME options are not included wi
189. row Down Down Left Arrow Left Left Right Arrow Right Right Control Left Arrow Left Word Left Word Control Right Arrow Right Word Right Word Home Begin of Line Begin of Line End End of Line End of Line 3 DoMEwide Features Working with Object Properties Name Field Short Name DeM Guide Key Windows UNIX Control Home Begin of Text Begin of Text Control End End of Text End of Text Page Up Page Up Page Up Page Down Page Down Page Down Backspace Delete Left Delete Left Delete Delete Right Delete Right Control Delete Delete Word Right Delete Word Right Control a Select All Begin of Line Control b Left Control c Copy Copy Control d Delete Right Control e End of Line Control f Find Dialog Right Control h Replace Dialog Replace Dialog Control k Delete to End of Line Delete to End of Line Control n Down Control o Newline Control p Up Control r Replace Replace Control s Find Dialog Control t Flip Characters Flip Characters Control v Paste Paste Control x Cut Cut Control y Paste Control z Undo Undo F3 Find Find Esc b Left Word Esc d Delete Word Right Esc f Right Word Esc lt Begin of Text Esc gt End of Text The Name field immediately under the menu bar is used for viewing editing the object Short Name This field has focus when the window first opens up 47 Working with Obj
190. rs E 10 Information Model 1 MetaScribe It is suggested that new formatters require the metascribe alt file since it defines appropriately named accessor routines for retrieving information from the document specification The following section describes the MetaScribe information model in detail The domain model shown in Figure 68 captures the information contained in a document specification and is the information understood by the document generator A document specification is made up of a collection of paragraphs where each paragraph is made up of a collection of text and expression segments Each segment can have a global character style associated with it that can be overridden to make the appearance of the segment even more specific Each paragraph has a paragraph style associated with it that can be overridden to make the appearance of the paragraph even more specific The document also has page layout information associated with it This section describes each object type and its attributes in detail Accessor routines for the entire information model are contained in the dome home tools metascribe lib metascribe alt file Assignment Statement The MetaScribe assignment statement Auto Number Counter An auto number counter specifies information about how the counter is incremented and displayed Display Specifies whether the counter should be displayed as part of the paragraph number Prefix
191. rs with entries for the selected archetype in all four list boxes Although the Shelf Browser looks somewhat different than a typical model editor you will create your shelf in much the same way you work on a typical DoME diagram The only difference is that you will use four list boxes Classes Archetypes References Implementations and the Interface editing pane in addition to the menu and toolbar functions you normally use Shelf Browser B Shelf Browser for ProtoDoME Model NoName D x Ele Edit View Layout Tools Window ET E Interface References E new Entity Implementations E Follow User Navigation The following topics describe DoME Shelf Browser tools features and functions 4 DoME Advanced Features Shelf Browser Menu Bar Shelf Browser Standard Toolbar Shelf Browser Classes List Shelf Browser Archetypes List Shelf Browser Drawing Toolbar Shelf Browser Interface Editing Pane Shelf Browser References List Shelf Browser Implementations List S F Guide The DoME Shel Includes the same menu selections available in the model editor where the Shelf is used standard model editor options plus specialized Shelf functions Includes the same functions available in the model editor where the Shelf is used Displays a list of classes used to organize Shelf archetypes When you create a new archetype it is automatically placed in the currently sel
192. rty D 12 properties D 35 destination head presence method D 23 style method D 23 diagram printing 24 disabling buttons D 17 menu items D 37 Index document generators vii Document Outline 5 domain modeling environment vi 2 DoME client server interfaces vii core tool set vi 3 Data Dictionary 62 B 7 description 1 exiting 24 Extensions Manual vii 24 features 4 7 getting started x help vii 9 10 27 30 72 home location 69 Information window 9 10 30 Launcher 9 28 Map View 35 memory 72 options settings 9 overview 1 quick tour 7 Shelf 4 shutdown 24 speed 72 starting 8 start up script 69 Tool Specification 3 5 D 1 DoME Tool Specification 3 5 D 1 met suffix D 6 Alter methods connectors D 22 nodes D 13 D 29 Alter methods properties D 36 Alter type definitions created by DoME D 42 basic nonvisual class D 32 can be top model D 5 class prefix D 4 connection constraints D 25 connector specification D 18 context properties D 4 creating new D 3 creating plug in model types D 42 deletions D 41 description D 2 enumeration constants D 33 enumerations D 33 generic abstract specification D 31 icon cursor amp shortcut key D 16 D impact of changes on existing models D 39 interface characteristics Language DTSL D 2 list elements D 26 load file D 5 menus amp menu items D 37 model editor D 3 model type name D 4 modifications D 39 naming new model type D 4 node element specification
193. s Wires can be used to connect Chips to Pins Properties for Connection Class Connec tion This property specifies the class of connector that the Constraints constraint applies to Connection Ordinality Occasionally you may want to restrict the number of connections of a certain class that can emanate or enter certain nodes The Ordinality properties on a connection constraint let you set such limits as follows Origin Destination Pattern Ordinality Ordinality 1 1 p 1 2 LOW 1 many LN 2 1 p Developing Your New Model Type D 26 List Elements eer D ProtoDoME wa many many A8 7 Reflexive Reflexivity is the ability to connect a node to itself If this property is true the user will be able to create such a loop with the indicated class of connector Otherwise reflexive connections will be disallowed A list element is one kind of object that appears inside of a node List elements appear as their name implies in list form that is one above another A node can contain multiple lists each one appearing as a separate group within the node Here are some examples D ProtoDoME Developine Your New Model Type If there is more than one list their visual order
194. s contained by nodes connectors or list elements Properties are variously called slots attributes instance variables characteristics or even properties in other object oriented systems They are essentially buckets for data The DoME Tool Specification language permits properties to be added to node connector list element generic and basic classes Each property has a type defining the set of valid values default value and some visualization properties To add a property to a class select the PROPERTY SPEC tool and click on the class to hold the new property The property s properties can be modified with the object inspector Each property needs to have a name that is unique among all of the classes in its ancestry its superclass chain This is because a class inherits all of the properties from its superclasses Property names can be duplicated between classes that have to subclass or superclass relationship to one another either directly or transitively The name of a property can be anything you want it to be but be aware that ProtoDoME removes spaces and changes capitalization when using the property name internally Here s what it does to capitalization the first word is all lowercase subsequent words are capitalized only in the first letter So Angular Momentum becomes angularMomentum to Alter Projector code 2 When describing a meta language like the DoME Tool Specification Language s
195. s can be used First Method 18 Picture a box around the group of objects you want to select then move the pointer to one of the corners This begins the process of rubber banding around several objects Press and hold the SELECT button then drag the pointer to the opposite corner surrounding the group of objects Release the SELECT button 19 All the objects you rubber banded should now display selection markers see example 20 Place the pointer just inside one of the selected objects then press and hold SELECT and move the outline to the location on the editing pane where you want to move the group 21 Release SELECT to place the group of objects in the new location Second Method Using the first method you gathered a region of objects into a group Alternately you may select individual objects and collect them into a group 18 Click lt SELECT gt with the pointer over a blank area in the editing pane This deselects any currently selected objects Hold down the lt SHIFT gt key then click SELECT on multiple unrelated objects on the editing pane 19 Each time you select a node the current group of selected objects expands 20 Release the lt SHIFT gt key then move the pointer just inside one of the selected objects Press and hold lt SELECT gt and move the outline to the location on the editing pane where you want to move the group 21 Release lt SELECT gt to
196. s described in Step 16 you can move connectors and route points beyond the bounds of the currently visible editing pane area auto scroll 37 Move the pointer to a destination node and click lt SELECT gt A fully routed connector is created and drawn S If you want to cancel connector creation or routing in progress press lt Esc gt any time before you click SELECT on the destination node Sq uanng Up Often a diagram looks better if its connector routes are square Connector By square we mean that the ee enone of connector R t S segments at the route points are 90 angles 38 Select or create a connector that has route points 39 with the connector selected click the SQUARE 1 CONNECTOR ROUTE button in the standard toolbar The connector s route points will move so all segment intersections are orthogonal Ux If after the routing algorithm is done there are more than two co linear route points all but the outside two will be deleted Also if a connector has no route points and you use the SQUARE CONNECTOR ROUTE tool a single route point may be created for you C utting a nd GO Click SELECT on the Process A node Pa sting 41 select Eprr Cur from the menu bar O bjec ts The node is removed and all connectors attached to the node also disappear Don t worry they re retrievable but if you really don t want the object anymore just stop here and don t go on to the next step
197. s that operate on the models Developing Your New Model Type D ProtoDoME D 34 Interface Characteristics Object This is a none of the above type Properties of type Object can be used to hold instances of Basic classes as well as any of the primitive types Unfortunately ProtoDoME does not have a generic user interface that would allow users to examine and set such properties manually so the only way to manipulate them is with Projector Alter Collections Any property can be declared to be a collection of some primitive type rather than just a single value There are three kinds of collections that ProtoDoME supports ordered sorted and sets Ordered collections maintain the ordering of their elements as members are added and removed Sorted collections insert new elements into their proper place in the sort ordering determined by the operation Sets permit only one instance of any given member but inserting or removing a member may change the order of the entire set ProtoDoME adjusts the inspector user interface for collection properties accordingly Each property definition has a set of user interface related settings DoME uses this information when constructing a widget or group of widgets to permit the user to modify an instance of the property such as in the object inspector Widget Label By default ProtoDoME munges the property s name to come up with a label to affix to the widget Som
198. squaring of new connectors You can quickly access notation specific help from the Launcher by clicking HELP HELP TOPICS and then clicking the name of the notation on the opening page You may have more than one help window open e g you could have general Data Flow Diagram and Document Outline help windows all open at the same time If you want to run DoME without opening help windows often e g drawing toolbar keyboard shortcuts print the information you need as you review online help topics When you want to open a model check the Launcher FILE RECENT FILES list first to see if the model you want is in the list To instantly minimize iconify all DoME open windows minimize the Launcher All DoME windows will minimize iconify along with the Launcher If you have several models open but are working on just one select FILE HIDE MODEL for each model you don t want to close but want out of the way until later To redisplay a hidden model select Launcher WINDOW MODELS and the name of the model To quickly bring a different model to the front click the RAISE LAUNCHER button and select WINDOW MODELS and the name of the model To quickly check a file location size type or last saved date time press lt CTRL O gt Press lt ESC gt to exit To quickly change your options preferences from any editor click the RAISE LAUNCHER button and select TOOLS OPTIONS 5 Tips Hints amp Work Arounds Working Smart on
199. states explains how one defines explicit transitions to substates History A history entrance is simply a circular node labeled with an H It has the single visual property Recursive which can be either true or false When Recursive is true the label changes to H As shown in this subdiagram a state transition can be attached to a history entrance Conditional A conditional entrance is a circular node labeled with a C It has no other visual or nonvisual properties As shown below a state transition can be attached to a conditional entrance and the conditional entrance can be connected to multiple states in the subdiagram e See a Ionen E ube eae pen p Simiad oration B Colbert Methodolo Colbert Object Oriented Statecharts S Hierarchical OOS Diagrams Selection A selection entrance is simply a circular node labeled with an S It has no other visual or nonvisual properties As shown in this subdiagram a state transition can be attached to a selection entrance Upei ng Upcimis Typs rini nr Ee Udaie Locatino Updsie _ Pis rme Like other hierarchical notations see Hierarchical Decomposition in DoME Models on page 64 Colbert O O Statecharts are hierarchical in that OOS states and orthogonals can maintain subdiagrams representing their internals An initial subdiagram will be created consisting of the
200. t This is the same object used for list element relationships described in List Elements on page D 26 The first step in specifying a node element relationship is to create the element hub Click on the button then drop the hub below the node class that will be the container As soon as you drop it DoME will prompt you to connect it to the container class Once you have created the element hub you can connect the component class es to the hub the connector must go from the component class to the hub DoME won t let you mix nodes and list elements in the same container class like this Can t do this Yes it s possible to use a node class in more than one container class like this D ProtoDoME Developing Your New Model Type Instantiating the Creating a node within a node is just like any other kind of Node Type on its node creation Click on the creation button for the class then Container drop the cursor inside the container DoME will create the new instance inside of it This will probably cause DoME to recalculate the outline of the container node to make room for the new element Drag amp Drop While list elements can be moved between containers by Features of simply dragging them node components do not behave this Component Nodes way Instead dragging a node outside of its container will cause the container to expand its boundaries to keep the component Generic A generic abstra
201. t Object Oriented Statecharts OOS Tools Nodes amp Connectors Basic State E Operation State Request State CJ Termination State 2 Initial State Marker oe B 26 B Colbert Methodology This topic describes the Colbert OOS specific tools nodes and connectors used to create diagrams Functions of the drawing toolbar buttons shown on Figure 50 Colbert Object Oriented Statechart Model Editor are described A state s visual properties are summarized in the following illustrations Basic State Cperation State Activity stepi step2 2229 Operation State Op Request State e i f In an O O Statechart a single state can be designated as the initial state or default entry state In DoME the initial state can be marked by selecting this tool moving to the appropriate position in the O O Statechart and clicking lt SELECT gt which creates a black circular marker B Colbert Methodology Colbert Object Oriented Statecharts Next move the mouse pointer over the initial state and click lt SELECT gt again A connector from the marker to the initial state appears T bs tee ES ie Orthog onal Orthogonal components represent behavior that can occur Component simultaneously To create an orthogonal state select the tool place the mouse pointer on the appropriate location of the subdiagram and click lt SELECT gt An orthogonal state may be resized by selecti
202. t a generic example of a Colbert Object Interaction Diagram Figure 44 Sample Colbert Object Interaction Diagram bode umm See i lihri Dip y be bey jes T deae T X Ia fe Fun mmi Dhari n objects are hierarchical as a 4 Colbert Object Interaction Diagrams B Colbert Methodology OID Tools Nodes amp Connectors Active Object Passive Object External Object SES This topic describes the Colbert OID specific tools nodes and connectors used to create diagrams Functions of the drawing toolbar buttons shown on Figure 43 Object Interaction Diagram OID Model Editor are described The following illustrations show how OID objects appear on Aclive Collection the editing pane Aclive Object Passive Object Paie Collection External Object j Ex amp ernal Callacon i n J I To help maintain consistency between Object Interaction and the Object Class diagrams When an object is created in an OID it is automatically added to its corresponding OCD B Colbert Methodology Colbert Object Interaction Diagrams Interactions The relationships between OID objects are represented by 4 r interactions operation requests that connect from a sender to i 4 areceiver An interaction has two visual properties Mechanism and Operation The Mechanism property can be simple synchronous timed balking or asynchronous with eac
203. t given a means for creating instances of the list element class the instantiation button is removed If true the default an instantiation button specification is created If you have removed the instantiation button specification for a node class you can bring it back by toggling this setting from false to true Extemal This property specifies if the external class property should be used The list element is displayed in gray if it is external D ProtoDoME Developing Your New Model Type Extemal Class The external class property allows a notation to use the classes that are defined in other DoME notations Set this property to the external class you wish to reference Subdiagram Subdiagrams Properties fi or List A list element can be specified to not have a subdiagram to Elements havea subdiagram that is restricted to a certain collection of model types or to have a subdiagram that can be any model type To create a subdiagram for an instance double click on the instance or click lt OPERATE gt with the instance selected Click the Go DOWN option Alter Methods The following Alter methods may be supplied to customize for List Elements the appearance and behavior of a list element You specify all such methods as a body for a lambda expression that binds the symbols listed in the property inspector to an instance of the object and possibly other parameters e g graphics context for drawing lines
204. ta Flow Diagram Process node has been selected The Property Inspector menu bar contains the following selections FILE CLOSE closes the Property Inspector EDIT APPLY immediately applies activates all changes you have made throughout the Property Inspector EDIT REVERT returns all changed items in the Property Inspector to their previous condition or state No change to any property in the inspector actually takes effect until you specifically APPLY the changes This command causes the inspector to discard any changes re read the values from the object and display them in the inspector DoME will warn you if you take some action that threatens to discard un applied property values VIEW VIEW OBJECT opens de iconifies or raises brings to the front the diagram containing the selected object The object is centered within the diagram and selected VIEW FREEZE INSPECTOR forces the inspector to remain editing this object even if you select another object The inspector will try to follow you around as you select objects in DOME editing windows The window will not actually move but its contents will change depending on the objects you are selecting A check mark indicates that this option is selected active Both the Windows and UNIX platforms define most of the platform specific keyboard bindings as shown in the following table Key Windows UNIX Up Arrow Up Up Down Ar
205. team About This Guide About This Guide Ap N vi Preface Whether you are a new or experienced user this guide is designed to help you turn on the lights in the DoME and illuminate all the advanced technology available within this unique powerful domain modeling environment e The numbered chapters acquaint you with the features and functions of the DoME core tool set and show you how to create new models work with navigate through models and save print and share your models Advanced tools tips hints and work arounds that will make your life more pleasant in the DoME are also described e The appendices describe some of the unique tools that have been built on the DoME framework but are not actually part of the core tool set Each appendix points out the notational and domain specific methodological differences between a specific tool and the DoME core Chapter1 Introducing DoME A brief discussion of model based development and the primary contributions that DoME brings to the discipline Chapter 2 Quick DoME Tour An introductory tour through DoME s basic features in a hands on tutorial format Chapter3 DoMEwide Features Describes common features available across all DoME tools from keyboard shortcuts and online help to model editing tools and user configurable desktop options Chapter 4 DoME Advanced Features Describes the Shelf reuse repository Data Dictionary par
206. ter Programmer s Reference Manual This impacts how DoME resolves relative pathnames given to the load Alter primitive e Pre load some commonly used operations and procedures e Establish RPC client server connections with an external application e Open a model editor window for a new model of a certain type 69 DoME Start Up Script Capability 4 DoME Advanced Features 70 Tips Hints amp Work Arounds In This This chapter includes a friendly gathering of tips hints C ha pter fixes and work arounds that will make your life in the DoME more pleasant General topic areas include e Optimizing DoME Memory amp Speed e Help with Help e Working Smart on Your Desktop e Working Smart on the Editing Pane e Naming Saving amp Managing Your Files F Guide 71 Optimizing DoME Memory amp Speed 5 Tips Hints amp Work Arounds Optimizing DoME Memory amp Speed Help with Help Working Smarton Your Desktop 72 Go to the Launcher TOOLS OPTIONS WINDOW page and select the REUSE DIAGRAM WINDOWS checkbox Every time you open a new window DoME will reuse a currently open window rather than open a new window If you don t need them shut off all remaining checkboxes on the TOOLS OPTIONS WINDOW page toolbars message area tooltips Shut off the following Launcher TOOLS OPTIONS EDITING page functions if you don t need them new object name prompt
207. ter code that is outside the fill in field is treated as regular text to be placed into the generated document unless the code is part of a Function statement To easily recognize expressions within a document set the Field Shading option to Always from the View page of the dialog which is opened by selecting the Tools gt Options menu There are seven MetaScribe styles defined to support the MetaScribe system MetaScribe statements produce no output to be placed in a generated document instead they control the generation of the document These styles include e MS Assignment An assignment statement assigns a variable the result of evaluating an expression The variable which is an Alter identifier with global scope can then be used in other expressions This paragraph style uses a fixed blue font The assignment statement has the following syntax Set lt aVariable gt to anExpression MS Comment A comment statement captures a comment in the document specification This paragraph style uses a non fixed red font e MS Conditional A conditional statement has its expression evaluated and if it is true then the paragraphs within its scope are produced Each conditional statement must have a matching end statement This paragraph style uses a fixed blue font The conditional statement has the following syntax If anExpression Then e MS End An end statement terminates the scope of a conditional file or loop stat
208. ter want to add another connection from say a subclass to a GEN SPEC node you must put the connector s origin on the subclass and the destination on the node e In like manner if you want to add a link from a new part to a PART WHOLE triangle place the origin of the connector on the part class and the destination on the triangle node A C amp O Node Properties amp Appear ance Figure 32 No instantia bility i e abstract no outer border Instantiable once dimmed outerborder No instantiability extemal declaration primitive no outer border top comers missing bold inner borden Figure 33 Coad Yourdon O O Analysis a AS Der Guide C amp O Node Properties amp Appearance The appearance of CLASS amp OBJECT C amp O nodes on CYOOA diagrams varies depending on how you set their properties The following illustration shows how C amp O nodes appear with various property settings Figure 33 C amp O Node Properties Options Each property can be set independently so the various aspects of node appearance can be combined C amp O Node Appearance Extemal declaration top comers missing Instantiable many times not primitive nomal Insta ntiable many times external declaration primitive top comers missing bold inner border Insta ntia bility TBD primitive bold inner border C amp O Node Properties Options fal Class amp Object BEE Ele Edi
209. th your version of DoME the optional selections shown below will not appear in the list Figure3 Select Model Type List Select Model Type Coad Yourdon OOA Colbert OOSD Project CyberDoME Model Data Flow Diagram DFD Document Outline DoME Tool Specification IDEF 0 Diagram Multi Page Model Petri Net Model Projector Diagram ProtoDoME Model State Transition Diagram Technology Roadmap ProtoDoME Based Model UML Class Diagram ProtoDoME Based Model User Defined Property Specification el Cancel 2 Select the type of model you want to create To create the example in this chapter click DATA FLOW DIAGRAM DFD in the list then click lt OK gt The selected model editor appears see Figure 4 DOME Model Editor Common Features The common features available on all DoME model editors are shown 11 Creating Nodes Figure 4 Title Bar Menu Bar Standard Toolbar ___ Remove bend em Note Notation spec ific node tools Notation spec ific connectortools Drawing Toolbar Graph Label 2 Quick DoME Tour DoME Model Editor Common Features Erl can unsaved Data Flow Diagram DFD gt Edit View Layout Tools Window Hel ES Ea ig a NoName L 4 PATIO Ex La X 4 Message Area Creating Nodes 12 Zoom Progress Bring Launcher MeterArea to front Scrollbar Editing Pane The basic look and feel of a typical DoME
210. the intermediate document specification file DoME recursively searches through the dome home tools lib directories for this file Integration with DOME 1 MetaScribe An example generator description file would be DoMESGMLDocList MetaScribeGeneratorSpec functionName Graph Summary graphType GraphModel outputTypes OrderedCollection file sourceFile summary mds Adding an Output In order for DoME to recognize the existence of an output formatter Formatter you must create a formatter description file named dformats dom and place it in one of the locations DoME searches A formatter description file describes one or more formatters and has the following form DoMEDocumentFormatList formatspec Where formatspec looks like DoMEDocumentFormatSpec fileSuffix string formatName menu string sourceFile pathname where fileSuffix is a string appended to the filename specified from the document generator dialog formatName is a string that is used to form the entry in the FORMAT menu of the document generator dialog sourceFile is a string giving the filename of the output formatter s definition file DoME recursively searches through the dome home tools lib directo ries for this file An example formatter description file would be DoMEDocumentFormatList MetaScribeFormatSpec fileSuffix mif formatName Maker Interchange Form
211. the name to material in the DTSL specification ProtoDoME preserves the model s cost property instance while making available the new property definition The old property cannot be edited or even viewed except through Projector Alter code The new property however assuming it has a valid type will have a user interface in the object inspector ProtoDoME automatically updates the display of nodes and connectors if their appearance properties are changed e g shape line width dash pattern The Impact of Changes on Existing Models D ProtoDoME Changing the Declaration of a Class Changing an Alter D 40 Method Changes to Properties Subdiagrams Specifying that a class can have subdiagrams enables it to be hierarchically decomposed Specifying that is does not have subdiagrams disables hierarchical decomposition but it does not delete any subdiagrams that have already been created for instances of that class Instantiation By default new node connector and list item classes are declared as instantiable that is the user has a means of directly creating them Setting the Instantiable property to false removes any button that may have been present for that class and transitively updates the user interfaces for open models of that type ProtoDoME does not however remove instances that may have been previously created Extemal If you change the declaration of a class from not external defa
212. tions see Hierarchical Decomposition in DoME Models on page 64 Colbert Object Class Diagrams are hierarchical in that an OCD internal class can maintain a subdiagram representing that class s internals An initial subdiagram will be created consisting of the border of the parent class and outgoing use relations attached to the parent class Figure 49 B Colbert Methodology Colbert Object Class Diagrams To help maintain consistency between Object Class and the Object Interaction diagrams when a subdiagram is created for a class in an OCD a subdiagram is also created for each of its instances in the corresponding OID The initial layout of relationships to and from an entity s border in the subdiagram are relative to their layout in the parent diagram Their layout within the subdiagram is independent of their layout within the parent diagram however and may be repositioned to improve readability This example shows the initial layout for class Active_Class s subdiagram Note that once a subdiagram is created for a class its border in the parent diagram becomes bold faced Sample Hierarchical OCD Diagram lInitial Layout Forme Ceux m E LL bi I reas b Ww 80 up go down ARR rave Ennai Class g T kd nnn iom Ac E i is In the initial configuration of the subdiagram class relations attach to the class border at a bar This bar can be selected and moved aro
213. toolbar You cannot use this method to return to a parent diagram from a referenced file See Chapter 4 DoME Advanced Features for more information on the parent object subdiagram reference capabilities available in DoME notations that support hierarchical decomposition These features are also described in DoME notation specific documentation 2 Quick DoME Tour Saving a Model Saving A When you re finished working with your model save it to Model disk 54 Click the SAVE button on the standard toolbar Clicking this button will save a previously saved model to its previously assigned file name name displayed on title bar and in graph label If you have not yet saved a model a dialog box appears that lets you specify where to save the model see below Figure6 Save As Dialog Box Save As tools Ex doo dom gt vwut32 dll Contacts txt License txt Copyright txt Readme txt Credits txt o Start DoME 29 dome exe a Uninst isu dome im gt vust32 dll Save as type Dome Model hd Cancel 55 Select the directory folder where you want to save the model Select a directory or folder where you want to save your new model by selecting the appropriate icon in the SAVE IN list box or directory tree When you select a directory it will appear in the SAVE IN list box and the directory tree will be updated 56 Type or select the new model name in the FI
214. tructure to assist in the extraction and manipulation of data represented in the foundation 1 The Projector Alter extension system is described in the DoME Extensions Manual and Alter Programmer s Reference Manual DoME Features DoME Features 1 Introducing DoME Projector is a data flow based graphical language Alter is its functional textual cousin Together they provide functionality needed to write complex model transformations Current uses include document code and test case generation simulation and test execution and model migration The end result of the transformation is really up to your imagination DoME can be distinguished from ordinary drawing tools and other applications of its type in many ways Domain specific syntax rules enforced For example our Petri Net model editor will not let you connect one transition to another transition since Petri Nets are bipartite Change impacts automatically propagated Changing a property of one visual object may affect the appearance of one or more related objects For example changing the name of a data flow in a parent Data Flow Diagram DFD will automatically change the names of all views of that flow in hierarchical subdiagrams DoME inherently supports reuse Some DoME notations may contain a reuse repository called the Shelf Items placed on the Shelf can be reused with full traceability in subsequent diagrams Objects i
215. ts new location As described in Step 16 you can move the route point beyond the bounds of the currently visible editing pane area auto scroll 32 Atthis point experiment a bit by creating a few more connectors and multiple route points So you re getting the hang of this right It looks like you ve created about a dozen or so route points in that one connector now what do you do 33 select the REMOVE BEND tool in the drawing toolbar The pointer becomes a small circled X 34 Click SELECT with the pointer positioned on a route point you want to eliminate The route point is deleted and the connector is redrawn without the route point If the editing pane starts to appear blurred select WINDOW REFRESH from the menu bar to clear up the screen Knowing that it s a lot of work to create a connector and then select another tool to route it we ve added a feature that lets you create connectors and route them at the same time 35 Select the DATA FLOW CONNECTOR tool and click lt SELECT gt on an origin node 36 As you move the pointer over your first route point click either lt SELECT gt or lt OPERATE gt Whenever you click either button a new route point will be created If you want to create a route point on top of a node that is in the way click on lt OPERATE gt otherwise DoME will assume you are trying to connect to the node 2 Quick DoME Tour Squaring Up Connector Routes S A
216. ttern If custom model context may have an effect on the dash pattern The observed effect is determined by an Alter method see below If inherited the connector class superclass provides the setting for the dash pattern Paint Patiem This determines the paint pattern used to draw the connector The choices are solid or 50 gray The paint pattern may also be fixed custom or inherited If fixed model context has no effect on the paint pattern If custom model context may have an effect on the paint pattern The observed effect is controlled by an Alter method see below If inherited the connector class superclass provides the setting for the dash pattern A solid pattern is used if the connector class does not have a superclass The declaration properties for a connector class specify some of its semantics Instantiable If false the user is not given a means for creating instances of the connector class the instantiation button is removed If true the default an instantiation button specification is created If you have removed the instantiation button specification for a connector class you can bring it back by toggling this setting from false to true Extemal This property specifies if the external class property should be used The connector spec is displayed in gray if it is external Extemal Class The external class property allows a notation to use the classes that are defined in other DoME not
217. ty Pattern is set to CUSTOM this property governs the paint pattern used to draw the outline of the node The method must return either solid or gray Name Position If the appearance property Name Position is set to CUSTOM this method governs the position of the node s name Node Shape If the appearance property Shape is set to CUSTOM RECTANGULAR or CUSTOM CIRCULAR DoME calls this method to draw the node shape DoME first computes the bounds of the node assuming a normal rectangular or circular shape Then it calls the method below if provided to make adjustments Finally this method is called to perform the actual rendering There are many occasions when DoME needs to display all or part of a node so the method should make no assumptions about the state of the screen or printer Node Bounds If the appearance property Shape is CUSTOM RECTANGULAR or CUSTOM CIRCULAR DoME calls this method whenever it needs to compute the size or position of the node When this method is called DoME has already figured what the bounds would be for a normal rectangular or elliptical node so this method can either start over from scratch or simply make adjustments Comer Type If the appearance property Corner Style is set to CUSTOM this method governs the type of corner used for the rectangular node The method must return one of the following symbols rounded square chorded none or noneontop Comer Radius Factor
218. ue the example typing new in abcblock container self 300 250 will create a new instance of Block in the same graph as the original instance and at the given x y coordinates y 0 is at the top of the window 4 Any properties on the Block instance must be retrieved with the get property Alter primitive and set with the set property primitive Attempting to manipulate instance variables on the Alter type will not work 5 Typing get property specification self will return the actual node specification Block itself This can also be used with the new in primitive but this is rare since it is harder for the Alter programmer to get a hold of it Registration Files The function dom registration file specifies the information about the plug in functions It is exactly like the other registration files in DoME s tools etc directories The graphType property must match the DTSL specification s Model Type Name property Click on the DTSL spec s context node graph label and edit its properties This is an example file DoMEUserFunctionList DoMEUserFunctionSpec functionName amp Execute MI Net graphType Mixed Initiative Model sourceFile execution alt DoMEUserFunctionSpec functionName amp Save MI Net Marking graphType Mixed Initiative Model sourceFile savemarks alt D 43 Creating Plug in Model Types D ProtoDoME D
219. ult to external in effect the name as seen by Projector Alter programs changes This is because the programmatic name consists of the class name prefixed by either the UI Class Prefix Graph objects or the Element Prefix everything else Changes to Alter methods take effect immediately although you may need to manually request DoME to refresh the window if the method affects the appearance of the object Most changes to properties must be done very carefully Changes that do not affect the semantics of a property e g increasing the height of a Long String property s widget can be done with impunity Type Declaration Changing the type of a property say from Number to String can cause problems If you had set any of the property s instances prior to the type change those old values are not visible through the inspector New values will conform to the new type Constraints Changes to Has Initial Value Initial Value Read Only Has Visual Effects and Local Value Has Priority take effect immediately except that object inspectors that are already open on the affected property instances are not updated You should close them and reopen them Changes to Register Dependence affect only new property instances created after the change D ProtoDoME Menus Deletions in DoME Tool Specs Deleting a Class Specification Deleting a Connection Constraint Deleting a Menu or Menu Item The Impact of Chanees on
220. und the border to improve readability Also relations can be attached to internal classes in the subdiagram to represent bindings of a class relation to a class implementation To move a relation from the border to an internal entity select the relation grab the head tail of the relation with the mouse pointer and then drag it to the appropriate internal entity and release it B 23 Colbert Object Oriented Statecharts Colbert Object Onented Statec harts Figure 50 Select Move Add bend Basic State Operation State Termination State Orthogonal Working with States B 24 B Colbert Methodology Colbert Object Oriented Statecharts object oriented renditions of Harel Statecharts are used to describe the dynamic behavior of an object or a class The following pages explain how to use DoME s Colbert Object Oriented Statechart OOS model editor in the context of the DoME Project Tool a DoME specific extension to Colbert OOSD methodology The Colbert OOS model editor is equipped with the four common tools SELECT MOVE ADD BEND REMOVE BEND NOTE included with most DoME model editors as well as the specialized nodes connectors and tools shown below Colbert Object Oriented Statechart Model Editor kel TBD File Edit View Layout Tools Window Help Note Remove bend History Conditional Selection Initial State Transition Colbert O O Statecharts include three
221. use pointer over various objects in the editing pane DoME displays each object s type in the message area You may toggle this area on off using VIEW MESSAGE AREA Nearly every object you see in a DoME model has a set of associated values you can edit called properties Some of these properties can affect the appearance of an object e g Name while others can only be viewed or modified through a DoME inspector window see Working with Object Properties on page 45 If you want to save an existing model under its current assigned name and format simply click the SAVE button on the standard toolbar If you want to save a model under a different name or in a different format select FILE SAVE AS The following disk file formats are available Editable format Save a model in this format in order to edit it again with DoME The editable format is readable ASCII using a simple attribute value pair approach It should be fairly easy to develop translators for it e FM Spec Document Currently this format is available 3 DoMEwide Features Model Editor Common Features Printing Models Figure 20 Hardcopy Formats F Guide for Data Flow Diagram Coad Yourdon and IDEF 0 models DoME creates a Frame Maker Interchange File MIF that can be imported into a Framemaker document text flow MIF format contains textual descriptions of all the pertinent features of a model e Other special formats Some DoME to
222. utton specification corresponding to the class and then click on the PROPERTIES button The inspector look something like this Icon Cursor amp Shortcut Key Properties Ea Creation Button Iof x File Edit View Icon ol Cursor D Key Used keys bmnz D ProtoDoME Developing Your New Model Type Predefined Icons To change an icon used for the button or the cursor click on the graphic next to the label Icon or Cursor respectively DoME will show you a palette of predefined icons to choose from To select one from the palette simply click on its picture and click lt OK gt Custom Icons If you would like to define a new icon that is not listed in the palette of predefined icons click on the ADD ICON in the icon palette window DoME will start the icon editor and focus it on the button specification After editing the bitmap to suit your application click APPLY in the bitmap editor to set the button s graphic Shortc ut Keys A shortcut key for an object instantiation button is a single keyboard character that when pressed acts the same as clicking the instantiation button To set the shortcut key property simply type the character into the KEY field DoME shows the currently spoken for shortcut keys in the list at the bottom of the property inspector Enabling Method You can also supply an Alter method that controls whether the button is enabled or disabled When the button is disabled it
223. ve O o Return Share O Provide To create an information flow select one of the information flow tools move the mouse pointer over the appropriate operation request on the diagram and click lt SELECT gt Once created the information flow can be repositioned to improve readability and will remain in that relative position if its associated operation request is moved An information flow s default Direction is In and Mechanism is Give Direction and Mechanism may be changed using the Object Inspector An information flow has one nonvisual property Parameter The Parameter property can be None or the name of a valid parameter for its interaction A valid parameter is one that is defined for the interaction s operation An interaction operation request may have zero or more error flows attached to it An error flow is created using the same protocol as an information flow An error flow has no properties associated with it o Error_Flow Op_Req B Colbert Methodology Colbert Object Interaction Diagrams Hierarchical OID Like other hierarchically decomposable notations see Diagrams Hierarchical Decomposition in DoME Models on page 64 Colbert Object Interaction Diagrams are hierarchical in that an OID internal object can maintain a subdiagram representing an object s internals An initial subdiagram will be created that consists of the border of the parent object and interactions operation requests
224. ve Intermediate Save the document specification to a previously specified file in a representation that can be processed by the DoME document generator The document specification is checked for syntax errors before being saved Save Intermediate As Request a filename from the user and then perform the Save Intermediate menu action Insert Expression Insert an expression at the current cursor location Insert Statement This submenu contains the following commands 1 MetaScribe Help Menu F Guide Using the MetaScribe Editor Assignment Insert an assignment statement on the line following the cursor The inserted statement contains the text Set aVariable to anExpression Comment Insert a comment statement on the line following the cursor Conditional Insert a conditional statement on the line following the cursor The inserted statement contains the text If anExpression Then End Insert an end statement on the line following the cursor The inserted statement contains the text End File Insert a file statement on the line following the cursor The inserted statement contains the text File anExpression Function Insert a function statement on the line following the cursor Loop Insert a loop statement on the line following the cursor The inserted statement contains the text For aVariable in anExpression Loop Check Syntax Check the syntax of the document specification and displa
225. ver Always Editable Custom Inherited Never The connector will have no decoration on that end Always The connector will always have a decoration on that end The decoration used is determined by the Type property below Editable The user can determine whether a decoration is displayed or not by adjusting a property DoME will make this property available through the property inspector The head will be displayed by default unless the On By Default field is toggled off Custom The presence of a decoration is determined by an Alter method Origin Head Presence or Destination Head Presence see below Inherited The presence of a decoration is determined by the superclass of the connector If the connector has no superclass a default is used Never for the origin end Always for the destination end Developing Your New Model Type D ProtoDoME D 20 Head Style This property has meaning only if the Presence is set to Always Custom or Editable Its possible values are Arrow Circle Filled Circle Square Filled Square Custom and Inherited Appearances are as follows Arrow i Circle A Filled Circle Square c Filled Square m If the decoration type is set to Custom the decoration chosen is determined by an Alter method Origin Head Style or Destination Head Style see below If the decoration type is set to Inherited the decoration type of the connector s superclass is used
226. visual aspect of the currently displayed diagram in one of the following standard formats opens the Print Options dialog box Single Page Mosiac Single Page PostScript Mosaic wallpaper PostScript Encapsulated PostScript EPSF Frame Maker Interchange Format MIF XWD bitmap GIF or RTF You may also specify whether or not hierarchical subdiagrams should be printed at the same time Close Close the currently displayed editing window 33 Model Editor Common Features Model Editor Edit Menu 34 Undo Cut Ctrl x Copy Ctrl C Paste Ctrl V Delete Delete SelectAll Ctrl A Find Ctrl F Cut Subdiagram Color Properties Ctrl l Short Name Return 3 DoMEwide Features Close Model Close all editing windows associated with the currently displayed model a model can consist of multiple diagrams Hide Model Unmap all editing windows for the currently displayed model but do not close the model Use the Launcher WINDOW MODELS selection to redisplay unhide the model The EDIT menu includes the following selections Undo Un do cancel the effects of the most recent editing operation such as movement name changing deletion and so forth Some operations cannot be undone e g cutting and discarding a subdiagram breaking a parent object subdiagram link Cut Remove the selected item s from the diagram and place them in the DOME clipboard from where they can be pasted Copy Place a cop
227. w s change color which can then be changed to some other color If you don t want item colors to change in this way select As Is f Guide 55 Setting Your DoME Desktop Options 3 DoMEwide Features Font Options Miscellaneous Options Window Options 56 Propagate Deletions to Subviews This currently applies only to Coad Yourdon models Use this list box to determine whether deletions will always extend to subviews never extend to subviews or prompt you whether you want to propagate the delete to subviews or not Prompt for Name When Creating Objects Check this box if you want DoME to prompt you for a name whenever you create a new object in a diagram Square New Connectors Check this box if you want DoME to automatically square connectors with one or more route points when you first create them Auto Save Use these fields to specify when auto saves should be performed Auto saving can be specified to occur after a certain number of changes or after a specified period of inactivity By default auto saving occurs after 15 changes or 15 minutes of inactivity The model is only auto saved if it was previously saved This page contains the following options Diagram Font Use this list box to select the font that will be used to display text in diagrams Text Editing Font Use these list boxes to select the font and size that will be used for text editing This page contains the following options
228. y implemented in your new DoME model editor window The following topics describe the properties and parameters you can manipulate in order to have your new notation and model editor appear and perform exactly the way you want them to Developing Your New Model Type D ProtoDoME Developing Your New Model Type Node Spec H Naming a Node Class Appearance Properties for Node Specs The topics on the following pages tell you how to build and modify your new DoME notations using the DoME Tool Spec editor Click the NODE SPEC button on the DoME Tool Spec editor drawing toolbar to begin creating a new node specification Three things will happen e First DoME will show the new node class e Second DoME will create a specification for an instantiation button Tool Palette e Third DoME will update any open editors for your notation to include a new button This new button allows you to create instances of your new node class Your new node class uses defaults for its appearance and semantics We ll cover how to change those in the following topics Changing the name of the node specification also changes the name of the instance button specification and the tooltip text that DoME displays when you hold the mouse over the actual instance button To change the name select the node spec object and press RETURN just like you would to change the name of any other object This topic describes the
229. y a list of errors The following errors are detected Statements that are missing a matching End statement Extra End statements ncorrect syntax for Assignment Conditional File and Loop statements Nested File statements Output producing paragraphs outside the scope of a File statement Expressions within Function statements View Error List Redisplay the list of syntax or document generation errors View Document Generation Errors Display a list of document generation errors after requesting a filename from the user and loading the errors from the specified file Select All In Scope Highlight all of the paragraphs that are in the same scope as the cursor The HELP menu is extended with the following selection MetaScribe Help Display the on line help E 7 Using the MetaScribe Editor 1 MetaScribe MetaScribe Toolbar There METASCRIBE toolbar includes the following buttons from left to Co reri 26 right Save Intermediate Insert Expression Insert Statement Check Syntax View Error List Unsupported The word processor capabilities listed below are not currently Features supported with this version of the MetaScribe system E 8 Cross References References from one part of the document to another Figures Graphics Frames Non text based information Footnotes Comments at the bottom of a page Page Headers and Footers Information displayed at the top and bottom o
230. y of the selected item s in the DoME clipboard from where they can be pasted Does not remove the item s from the diagram Paste Paste the contents of the DoME clipboard into the currently displayed diagram Delete Permanently delete the selected item s Be sure to note that you may undo a Delete command Select All Select all top level objects in the currently displayed diagram If some items are already selected DoME will select the next level of items within those selected items If for example nothing is initially selected the first application of SELECT ALL will select all nodes and connectors but not the name tags on the connectors Applying SELECT ALL a second time selects the connector name tags as well Find Use this dialog box to search for an item or set of items You can search for text or TBDs unset names descriptions rationales traceability properties When searching for text you can specify a pattern using wildcards and can limit the search to names or properties within the entire model parent diagrams or subdiagrams When the search is complete DoME reports the item s that matched You can then choose an item of interest and DoME will select the item and scroll the appropriate diagram to position the item as close to the center of the window as possible Cut Subdiagram Use this selection to break cut the relationship between a parent object and its subdiagram s You may choose to discard the subd
231. y to organize diagrams in groups or configurations Glossary 1 Glossary 2 Glossary Connector In DoME models used to attach one node to another May be directional Coupling diagram Explicit connections between diagrams These connections are maintained by DoME and while not necessarily visible can be navigated and changed Cross reference relationships Non hierarchical general relationships where diagram components can refer to other components or diagrams in the same or separate models Data dictionary Contains an inventory of items found in the currently open model Can be used to inspect and modify various aspects of an item s state Default An original setting or state that remains active until changed by the user Destination node When one node is connected to another the node where the connection ends Diagram semantics The concepts codified by a particular user drafted diagram i e the space of potential concepts induced by the nodes and connectors of a particular class of diagrams e g Data Flow Diagrams Dialog box A window where action is required in order to exit the window Domain modeling environment Integrated model editing meta modeling and analysis tools supporting a model based development approach to system software engineering Domain specific model A model adhering to the structure and semantics of a specific modeling technique methodology or discipline Doma
232. you want to create several nodes of the same type press and hold the lt SHIFT gt key while you click SELECT on the node button This keeps the button selected after you have created your first node on the editing pane If you want to have all nodes selected when you are finished creating multiple nodes press and hold the lt SHIFT gt key as you create all nodes Model Editor Common Tools The four tools nearest the top of the drawing toolbar are shared by most DoME model editors SELECT MOVE ADD BEND REMOVE BEND NOTE SELECT MOVE is active by default and is used to select objects When you click SELECT on a node or connector with this tool selected registry marks appear on or around the object ADD BEND is used to create route points on connectors that attach nodes To create a route point simply select this tool and pass the pointer over the connector where you want to create a route point while holding the SELECT button down When you release the button the route point appears REMOVE BEND is used to remove route points from connectors With this tool selected simply click SELECT on the route point that you want to delete NOTE is primarily a communication device e To start a note select the NOTE tool and click SELECT where you want the note positioned Tochange note contents click SELECT on the note then click the PROPERTIES button on the standard toolbar to display a multi page insp

User Manual

Contents

Download Pdf Manuals

Related Search

Related Contents