Difference between revisions of "Overview"

From OOModels
Jump to navigationJump to search
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
=== A quick tour to start working with OOModels ===
=== A quick tour to start working with OOModels ===


OOModels is a repository for modelling ''artefacts of all kinds''. The majority of content will consist of ''classes'' of ''packages''.
* OOModels is a repository for modelling ''artefacts of all kinds''. The majority of content will consist of ''classes'' or ''packages''.


An example of such a class is [[Artefact:Model/net/leue/andreas/sandbox/model03/Person]]. It - obviously - models a preson.
* An example of such a class is [[Artefact:Model/net/leue/andreas/sandbox/model03/Person]]. It - obviously - models a preson.


Press "edit" or "view source" to ''see how the class is specified''. In this case, it's in [[Type:org/oomodels/WIML/1.0|WIML notation]].
* Press "edit" or "view source" to ''see how the class is specified''. In this case, it's in [[Type:org/oomodels/WIML/1.0|WIML notation]].


To download an artefact, press the "Download Code" link in the box on the right side of the page. There, select a target format, don't forget to check the disclaimer confirmation checkbox, and press download. Note, that you can download the code either ''as specified'' or ''converted''.
* To download an artefact, press the "Download Code" link in the box on the right side of the page. There, select a target format, don't forget to check the disclaimer confirmation checkbox, and press download. Note, that you can download the code either ''as specified'' or ''converted''.


If you work with an application, you need to select a subset of classes you need from oomodels. To do this, you define a ''bundle'', e.g. [[Artefact:Bundle/net/leue/andreas/sandbox/model03/Model03]]. Here, you list all classes you want to select, or just list a packages and thereby implicitly select all classes in that package, or you include other bundles.
* If you work with an application, you need to select a subset of classes you need from oomodels. To do this, you define a ''bundle'', e.g. [[Artefact:Bundle/net/leue/andreas/sandbox/model03/Model03]]. Here, you list all classes you want to select, or just list a packages and thereby implicitly select all classes in that package, or you include other bundles.


Bundles can also be "downloaded", if you do so, you can get a resolved list of all final artefact pages you need for that project.
* Bundles can also be "downloaded", if you do so, you can get a resolved list of all final artefact pages you need for that project.


If you work with ''eclipse'', you can use a plugin (see [[DevelopmentPlan]], direct link [http://www.oomodels.org/updatesite eclipse updatesite], currently still a bit slow because of mediawiki, which isn't made for mass downloads, we're working on a cache - want to contribute?).
* If you're working with ''eclipse'', you can use a plugin (see [[DevelopmentPlan]], direct link [http://www.oomodels.org/updatesite eclipse updatesite], currently still a bit slow because of mediawiki, which isn't made for mass downloads, we're working on a cache - want to contribute?).


To start your own project (classes, packages. bundles etc.), see this [[HowToStartAProject|short introduction]].
* You can also integrate the download software into your own application. It already works as a standalone commandline downlaoder, and within Sphenon's EM/OS system.


* To start your own project (classes, packages. bundles etc.), see this [[HowToStartAProject|short introduction]].
* An exmaple of a [[Artefact:Diagram/net/leue/andreas/process01/Process01|diagram]].


=== The overall picture ===
=== The overall picture ===

Latest revision as of 13:53, 18 September 2009

A quick tour to start working with OOModels[edit]

  • OOModels is a repository for modelling artefacts of all kinds. The majority of content will consist of classes or packages.
  • Press "edit" or "view source" to see how the class is specified. In this case, it's in WIML notation.
  • To download an artefact, press the "Download Code" link in the box on the right side of the page. There, select a target format, don't forget to check the disclaimer confirmation checkbox, and press download. Note, that you can download the code either as specified or converted.
  • If you work with an application, you need to select a subset of classes you need from oomodels. To do this, you define a bundle, e.g. Artefact:Bundle/net/leue/andreas/sandbox/model03/Model03. Here, you list all classes you want to select, or just list a packages and thereby implicitly select all classes in that package, or you include other bundles.
  • Bundles can also be "downloaded", if you do so, you can get a resolved list of all final artefact pages you need for that project.
  • If you're working with eclipse, you can use a plugin (see DevelopmentPlan, direct link eclipse updatesite, currently still a bit slow because of mediawiki, which isn't made for mass downloads, we're working on a cache - want to contribute?).
  • You can also integrate the download software into your own application. It already works as a standalone commandline downlaoder, and within Sphenon's EM/OS system.

The overall picture[edit]

          OOModels contains Artefacts
                      |
                      |
          Artefact:Model
             org
               oomodels
                 sandbox                                                      Artefacts have a Type
                   business                                                   (and other metadata)
                     foundation                                               e.g. WIML or XMI
                   |   entities                                                       |
                   |     Company ------------------------------- Artefacts can be downloaded
                   |     Person                                + during download, they can be converted
                   |     Name                                    into another format, like WIML or XMI
                   |     ...
                   |                                           + conversions are specified within the wiki itself
          Artefacts are organised in Namespaces,                 by adding a converter (e.g. OOEM to Java POJO),
          and they belong to a Domain                            and a template (e.g. ooem-1.0-java-pojoraw-1.0)
                |
          learn more...                                        + there is an eclipse plugin
                                                                 to download directly into your eclipse workspace

More Help[edit]