Book: Caché Objects and Atelier

Table of Contents
TABLE OF CONTENTS    1
CHAPTER 1 - OVERVIEW    13
Purpose    13
What this book is not about    13
Interactive environments    13
Where to Start    14
Summary    14
Highlights    18
My impressions    18
Documentation too simple?    19
Atelier for Server-Side Development Video    19
Helpful hints    19
Bookmarks    19
Cheat Sheets    20
Help with Search – reduce your search scope    21
Quick Access Box    23
Note about Atelier/Eclipse Editor    23
Setup Summary    23
CHAPTER 2 - WHEN YOU NEED HELP    25
InterSystems Worldwide Support Center    25
InterSystems Developer Community    25
InterSystems Documentation launched from the Caché Cube    26
Documentation from the Web Browser    29
Documentation from InterSystems Website    30
InterSystems Products Website    30
InterSystems Atelier Documentation    30
Eclipse Documentation    30
CHAPTER 3 - GENERAL INTRODUCTIONS    31
What is Caché?    31
What are Caché Objects?    31
What is Caché ObjectScript?    32
What is MUMPS?    32
Link to InterSystems Documentation    32
What is Eclipse?    33
What is an IDE?    33
What is Atelier?    33
Atelier – background    34
CHAPTER 4 – INSTALLATIONS    35
Install Eclipse and Atelier as a Plugin    36
Atelier Development Environment    36
Eclipse Market Place    37
Installing Caché    37
The Caché Cube    38
The Caché Startup Menu    38
CHAPTER 5 – ATELIER OVERVIEW    39
All editing is done locally    39
Workspace Directory    39
Welcome Page    40
Review IDE configuration settings    41
Overview    41
Workbench Basics    41
From the Overview screen    42
Eclipse Marketplace    42
Team Support with Git.    42
Using the Welcome Page    42
Introductory Documentation    42
From the Overview screen    43
Print the Documentation    43
Atelier Videos    43
How to Migrate to Atelier IDE    43
Tutorials    43
From the Overview screen    44
What's New    45
Eclipse Community    45
Atelier Working sets    45
Atelier Editor and Caché Studio    46
Configuring a Server Connection    46
CHAPTER 6 – ATELIER DROPDOWN MENUS    47
Atelier Dropdown Menus    47
File dropdown menu    47
Edit dropdown menu    48
Source dropdown menu    49
Navigate dropdown menu    49
Search dropdown menu    51
Project dropdown menu    52
Run dropdown menu    52
Tools dropdown menu    55
Window dropdown menu    55
Preferences    62
Help dropdown menu    65
CHAPTER 7 - ATELIER CONCEPTS    67
Learning Atelier    67
Atelier Concepts    67
Workbench    69
Perspectives    69
Views    70
View Stacks    70
Projects    70
Editors    71
Windows    71
Resources    71
Atelier Server Connection    71
Source Code Templates    72
CHAPTER 8 - THE ATELIER WORKBENCH    73
Setting up a Workspace    73
Setting up a Workbench    74
Rearranging Views and Editors    74
Copying, renaming, and moving    75
Comparing Resources    75
In the Workbench you can compare a number of resources and present the results in a special editor.    75
Platform Tips and Tricks    76
Workbench Tips and Tricks    77
Editing Tips and Tricks    83
Help Tips and Tricks Buttons    85
CHAPTER 9 - OBJECT BASICS    87
Goals of Object Technology    87
Terms of Object Technology    88
Class    88
Data    88
Methods    89
Class Methods    89
Instance Methods    89
Instantiation    89
Inheritance    89
Encapsulation    90
Oref    90
Polymorphism    90
Invoking a Class Method    91
Invoking a Method    92
Other Object Methods    93
CHAPTER 10 - STUDIO ROUTINE    95
SLastNameRoutine    95
Creating a Routine in Studio    95
Startup Caché Studio    96
Routine Name    99
Enter Code in Routine    100
Run Studio Routine    100
Debug Studio Routine    101
CHAPTER 11 - ATELIER ROUTINE    103
ALastNameRoutine    103
Creating a Routine in Atelier    103
Startup Eclipse    104
Atelier Class Cheat Sheet    104
Set your Perspective to Atelier    105
Create a new project    106
Select and/or Create Project    107
Select Routine File    108
Select COS Routine    109
Enter COS Routine Information    109
Enter Routine Code    110
Run Atelier Routine    110
Debug Atelier Routine    112
Debug Control    113
CHAPTER 12 - STUDIO CLASS    115
SLastName.Person    115
Creating a Class in Studio    115
The Class – Basic Structure    116
Creating a Class in Studio    116
Startup Caché Studio    117
Class Name    119
Create the SLastName.Person Class    120
Add a Name Property and Index to your Class    121
Class, Routine, SQL Table    121
Default Storage    122
Adding Data to SLastName.Person    122
Difference between a Class and an Object    125
Saving your Class    125
CHAPTER 13 - ATELIER CLASS    127
ALastName.Person    127
The Class – Basic Structure    127
Creating a Class in Atelier    128
Atelier Class Cheat Sheet    128
The Class in Atelier    129
Set your Perspective to Atelier    130
Set your Perspective to Atelier    131
Select and/or Create Project    132
Select Class File    133
Template Page    133
New Empty Class File    134
Add Two Lines    135
Content Assist.    136
Save ALastName.Person    138
Adding Data to ALastName.Person    139
Difference between a Class and an Object    141
Saving your Class    141
CHAPTER 14 - STUDIO PROPERTIES    143
SLastName.Person    143
Adding more Properties to the SLastName.Person Class    143
Property Wizard    144
Data Population    145
Populate Documentation    145
Populate the Class    145
Using SQL to see your data    147
CHAPTER 15 - ATELIER PROPERTIES    149
ALastName.Person    149
Atelier Properties for Class ALastName.Person    149
Data Population    150
Populate Documentation    151
Populate the Class    151
Using SQL to see your data    152
CHAPTER 16 - STUDIO METHODS    153
SLastName.Person    153
Studio Methods for Class SLastName.Person    153
Instance Method    154
Invoking a Class Method    155
Invoking a Method    156
Run an Instance Method    157
Class Method    158
Studio Sections    160
Alt+1 – Inspector    160
Alt+2 – Output from the code. This displays output generated from the code itself.    160
Alt+3 – Workspace    160
Alt+4 – Storage    160
CHAPTER 17 - ATELIER METHODS    161
ALastName.Person    161
Atelier Methods for Class ALastName.Person    161
Instance Method    162
Invoking a Class Method    163
Invoking a Method    164
Run an Instance Method    165
Class Method    166
CHAPTER 18 - CLASS MEMBERS    169
Class Members    169
Properties    170
Properties using Outline View    171
Property Keywords    172
Required    172
InitialExpression    172
Transient    172
Private    172
Calculated    172
MultiDimensional    172
Examples    173
Enumerated Properties    174
Parameters    175
Instance Method    176
Class Method    176
Queries – Basic Class Query    177
Indices    178
SQL Trigger    179
Storage    180
Storage for a preexisting Global    180
Mapping Globals to Classes    181
Regenerate a clean Storage    182
Projections    182
XData    182
CHAPTER 19 - RELATIONSHIPS: ONE TO MANY    183
Relationships    183
Relationships Guidelines    184
Caché Relationships    184
One to Many Relationship    185
Company Class    185
Employee Class    186
Delete Data    188
Create a new Company    189
Create 3 new Employees    190
Establish a Link - Company (One), Employee (Many)    192
Use SQL to find IDs of the Company & Employees    192
Display a Relationship with SQL    196
Remove a Relationship    197
CHAPTER 20 - PROCESSING RELATIONSHIPS    199
Iterate Company thru Employees    199
Display Company Name from Employee    200
CHAPTER 21 - INHERITANCE    203
Object Technology Inheritance Description    203
Parent and Child Class    203
Multiple Inheritance    204
Designing an Object Technology based system    204
Inheritance Application    205
$SYSTEM.OBJ.DisplayError    210
APPENDIX A - MIGRATION TO ATELIER    211
APPENDIX B – AUTOMATIC SOFTWARE UPDATE    213
APPENDIX C – EXPORT AND IMPORT    215
Export while in a Class    215
Import a Class    217
Export Classes with the Wizard.    218
APPENDIX D – ATELIER TERMINAL PLUGIN    221
APPENDIX E - REGENERATE A CLEAN STORAGE    223
APPENDIX F - OBJECT COMMANDS    225
APPENDIX G – COMMENTS    227
APPENDIX H – CONTENT ASSIST    229
APPENDIX I – MUMPS OR CACHÉ?    231
What is Caché?    231
Where is the Problem?    231
MUMPS will be around for years to come    232
APPENDIX J – LEXICON    233
Caché    233
Write the word "Caché" with Cut and Paste    233
Write the word Caché in Terminal    233
Write the word "Caché" in Microsoft Word    234
APPENDIX K - METHODS OF TRANSLATION    235
GLOSSARY    237
INDEX    245