Changes between Version 2 and Version 3 of relationships

Timestamp:

03/07/2011 06:29:45 PM (13 years ago)

Author:

christoph.neijenhuis

Comment:

--

relationships

@@ -26 +26 @@
 When checking out from Monticello, an additional instance variable is added to Class, causing a lenghty recompile. You probably want to do this on a new image.
 
+To open the browser that supports relationships, you need to do: ''RelationshipBrowser open''
+
 {{{
 #!div style="clear:both;"
@@ -32 +34 @@
 = How to Use =
 
-''Write a small tutorial. Start with basic steps and then add more details. It is not necessary to explain the whole functionality.''
+When editing relationships, use the relationship browser: ''RelationshipBrowser open''
 
+I'll use a simple example to illustrate the use of this framework: We have a class ''Artist'' and a class ''Artwork''. Artists can create many artworks, but an artwork can only have a single artist. We therefore have a one to many relationship between artist and artwork.
 
+=== Create a relationship ===
+
+In the relationship browser, select the ''Artist'' class and click on the relationship symbol: -->
+
+In the category menu, select ''OneToMany''. As you can see, there is a template for a ''OneToManyRelationship'' in the edit pane. Simply add the ''Artwork'' class as the right class and save. The new relationship has been created.
+
+If you go back to the instance view, you can see that ''Artist'' does now have the methods ''addArtwork:'', ''artworks'' and ''removeArtwork''. ''Artwork'' has the method ''artist''.
+
+=== Edit a relationship ===
+
+Assume we have found out that sometimes, multiple artists collaborate to create an artwork. 
+
+Go back to the relationship view (use -->) and select the existing relationship. The edit pane is filled with the previous values. To create a many to many relationship, replace ''OneToManyRelationship'' with ''ManyToManyRelationship''. Hit save and look at the newly generated methods.
+
+Assume all artworks in this relationships are paintings. We don't want to create a new subclass for this, but change the name used in the methods.
+
+Select the existing relationship and add a name for the right class: ''rightClassName: 'painting' '' and save. The methods will be renamed.
+
+= Known limitations =
+
+The relationships are not added to monticello when saved (however, the generated methods and instance variables are - your code still works).
 
 = How to Extend =