Type:org/oomodels/wiki/Bundle

From OOModels
< Type:org‎ | oomodels‎ | wiki
Revision as of 07:44, 12 May 2009 by AndreasLeue (talk | contribs)
Jump to navigationJump to search
Classification
Category Type:org/oomodels/wiki/Type
Namespace (more)

Reserved for items that directly relate to the oomodels wiki, like e.g. types of pages.

create new pages

Description[edit]

Bundles define a set of oomodels artefacts. They are used for packaging purposes. Typically, a bundle is used as a compilation unit of related artefacts that result in some software component.

Syntax[edit]

Besides Metadata and free text, bundle pages contain artefact lists and optionally mappings.

Artefact Lists[edit]

Syntactically these are normal lists, prefixed with a star. E.g.

* Artefact 1
* Artefact 2
* ...

Artefacts are referenced by normal wiki links. E.g.

* Artefact:Model/org/oomodels/Class01
* Artefact:Model/org/oomodels/Class02
* ...

Alternatively, one may refer to a specific revision of an artefact page, like this:

* Artefact:Model/org/oomodels/Class01 - Revision 1234
* Artefact:Model/org/oomodels/Class02 - Revision 5678
* ...

where 1234 and 5678 are the respective revision numbers. Moreover, artefact lists can refer to packages

* Artefact:Model/org/oomodels/package01
* Artefact:Model/org/oomodels/package02
* ...

In this case, all direct childs of the named packages are included within the bundle. And finally, artefact lists can refer to other bundles:

* Artefact:Bundle/org/oomodels/Bundle01
* Artefact:Bundle/org/oomodels/Bundle02
* ...

Like with packages, all contents of the named bundles are then included within this bundle.

Mappings[edit]

Mappings allow to relocate artefacts into different packages as within oomodels. They are specified as numered lists:

# mapping 1
# mapping 2
# ...

A mapping is a pair of two packages, separated by a colon. E.g.:

# org/oomodels/package1 : my/different/path1
# org/oomodels/package2 : my/different/path2
# ...

Such mappings have to be applied to all artefacts as well as all included artefacts when bundles are used by some software.