@@ -24,19 +24,25 @@ </ul> </div> + This page introduces my example models in both ORM2 and CQL. The CQL + files are exactly as generated from the ORM2 versions, but you could have + written them by hand. Either type of file can be converted to SQL or Ruby, + using the relational and object-oriented mapping algorithms implemented + in the ActiveFacts generator afgen. The output files from these + conversions are available here, as are the PNG images of the ORM2 versions. + + The example models presented here were created as Object Role Models - using <a href="http://www.ormfoundation.org/files/">NORMA</a>. The - ActiveFacts generator afgen was used to convert them from ORM2 - to CQL, SQL and Ruby code using ActiveFacts. They're all available here - as PNG images and in the other formats. + using <a href="http://www.ormfoundation.org/files/">NORMA</a>. A selection + of the basic models is discussed below, and a full table below that. - + To make a start learning Object Role Modeling, read the <a href="intro.html">Introduction to ORM2</a> or check the Resources page for other sites. - The CQL code here formatted and laid out is exactly as it was generated. + The CQL code here is formatted and laid out is exactly as it was generated. It's interesting how cleverly the semantic clustering algorithm works! @@ -105,11 +111,11 @@ <td></td> <td></td> <td></td> - <th>Diagrams</th> + <th>ORM2 Diagrams</th> </tr> <tr> - <td>Address</td> + <td>Address <a href="ORM/Address.orm">(orm)</a></td> <td><a href="CQL/Address.cql">CQL</a></td> <td><a href="ruby/Address.rb">Ruby</a></td> <td><a href="SQL/Address.sql">SQL</a></td> @@ -118,7 +124,7 @@ </tr> <tr> - <td>Blog</td> + <td>Blog <a href="ORM/Blog.orm">(orm)</a></td> <td><a href="CQL/Blog.cql">CQL</a></td> <td><a href="ruby/Blog.rb">Ruby</a></td> <td><a href="SQL/Blog.sql">SQL</a></td> @@ -127,7 +133,7 @@ </tr> <tr> - <td>CompanyDirectorEmployee</td> + <td>CompanyDirectorEmployee <a href="ORM/CompanyDirectorEmployee.orm">(orm)</a></td> <td><a href="CQL/CompanyDirectorEmployee.cql">CQL</a></td> <td><a href="ruby/CompanyDirectorEmployee.rb">Ruby</a></td> <td><a href="SQL/CompanyDirectorEmployee.sql">SQL</a></td> @@ -136,7 +142,7 @@ </tr> <tr> - <td>Death</td> + <td>Death <a href="ORM/Death.orm">(orm)</a></td> <td><a href="CQL/Death.cql">CQL</a></td> <td><a href="ruby/Death.rb">Ruby</a></td> <td><a href="SQL/Death.sql">SQL</a></td> @@ -145,7 +151,7 @@ </tr> <tr> - <td>Genealogy</td> + <td>Genealogy <a href="ORM/Genealogy.orm">(orm)</a></td> <td><a href="CQL/Genealogy.cql">CQL</a></td> <td><a href="ruby/Genealogy.rb">Ruby</a></td> <td><a href="SQL/Genealogy.sql">SQL</a></td> @@ -159,14 +165,25 @@ <td><a href="ruby/Insurance.rb">Ruby</a></td> <td><a href="SQL/Insurance.sql">SQL</a></td> <td> - <a href="images/Insurance/Claim.png">Claim</a> <a href="images/Insurance/Insurance.png">Insurance</a> <a href="images/Insurance/Person.png">Person</a> <a href="images/Insurance/Policy.png">Policy</a> + <a href="images/Insurance/Claim.png">Claim</a> + <a href="images/Insurance/VehicleIncident.png">VehicleIncident</a> + <a href="images/Insurance/Related.png">Related</a> + </tr> + + <tr> + <td>JoinEquality <a href="ORM/JoinEquality.orm">(orm)</a></td> + <td><a href="CQL/JoinEquality.cql">CQL</a></td> + <td><a href="ruby/JoinEquality.rb">Ruby</a></td> + <td><a href="SQL/JoinEquality.sql">SQL</a></td> + <td> + <a href="images/JoinEquality.png">JoinEquality</a> </tr> <tr> - <td>Marriage</td> + <td>Marriage <a href="ORM/Marriage.orm">(orm)</a></td> <td><a href="CQL/Marriage.cql">CQL</a></td> <td><a href="ruby/Marriage.rb">Ruby</a></td> <td><a href="SQL/Marriage.sql">SQL</a></td> @@ -174,21 +191,26 @@ <a href="images/Marriage.png">Marriage</a> </tr> + <a name="Metamodel"></a> <tr> <td>Metamodel</td> <td><a href="CQL/Metamodel.cql">CQL</a></td> <td><a href="ruby/Metamodel.rb">Ruby</a></td> <td><a href="SQL/Metamodel.sql">SQL</a></td> <td> - <a href="images/Metamodel/Constraints.png">Constraints</a> - <a href="images/Metamodel/Import.png">Import</a> <a href="images/Metamodel/Objects.png">Objects</a> - <a href="images/Metamodel/Populations.png">Populations</a> + <a href="images/Metamodel/Terms.png">Terms</a> + <a href="images/Metamodel/ValueTypes.png">ValueTypes</a> + <a href="images/Metamodel/Constraints.png">Constraints</a> + <a href="images/Metamodel/Units.png">Units</a> + <a href="images/Metamodel/Joins.png">Joins</a> <a href="images/Metamodel/Values.png">Values</a> + <a href="images/Metamodel/Populations.png">Populations</a> + <a href="images/Metamodel/Context.png">Context</a> </tr> <tr> - <td>MultiInheritance</td> + <td>MultiInheritance <a href="ORM/MultiInheritance.orm">(orm)</a></td> <td><a href="CQL/MultiInheritance.cql">CQL</a></td> <td><a href="ruby/MultiInheritance.rb">Ruby</a></td> <td><a href="SQL/MultiInheritance.sql">SQL</a></td> @@ -197,7 +219,7 @@ </tr> <tr> - <td>OilSupply</td> + <td>OilSupply <a href="ORM/OilSupply.orm">(orm)</a></td> <td><a href="CQL/OilSupply.cql">CQL</a></td> <td><a href="ruby/OilSupply.rb">Ruby</a></td> <td><a href="SQL/OilSupply.sql">SQL</a></td> @@ -206,7 +228,7 @@ </tr> <tr> - <td>Orienteering</td> + <td>Orienteering <a href="ORM/Orienteering.orm">(orm)</a></td> <td><a href="CQL/Orienteering.cql">CQL</a></td> <td><a href="ruby/Orienteering.rb">Ruby</a></td> <td><a href="SQL/Orienteering.sql">SQL</a></td> @@ -217,7 +239,7 @@ </tr> <tr> - <td>OrienteeringER</td> + <td>OrienteeringER <a href="ORM/OrienteeringER.orm">(orm)</a></td> <td><a href="CQL/OrienteeringER.cql">CQL</a></td> <td><a href="ruby/OrienteeringER.rb">Ruby</a></td> <td><a href="SQL/OrienteeringER.sql">SQL</a></td> @@ -226,7 +248,7 @@ </tr> <tr> - <td>PersonPlaysGame</td> + <td>PersonPlaysGame <a href="ORM/PersonPlaysGame.orm">(orm)</a></td> <td><a href="CQL/PersonPlaysGame.cql">CQL</a></td> <td><a href="ruby/PersonPlaysGame.rb">Ruby</a></td> <td><a href="SQL/PersonPlaysGame.sql">SQL</a></td> @@ -235,7 +257,16 @@ </tr> <tr> - <td>SchoolActivities</td> + <td>RedundantDependency <a href="ORM/RedundantDependency.orm">(orm)</a></td> + <td><a href="CQL/RedundantDependency.cql">CQL</a></td> + <td><a href="ruby/RedundantDependency.rb">Ruby</a></td> + <td><a href="SQL/RedundantDependency.sql">SQL</a></td> + <td> + <a href="images/RedundantDependency.png">RedundantDependency</a> + </tr> + + <tr> + <td>SchoolActivities <a href="ORM/SchoolActivities.orm">(orm)</a></td> <td><a href="CQL/SchoolActivities.cql">CQL</a></td> <td><a href="ruby/SchoolActivities.rb">Ruby</a></td> <td><a href="SQL/SchoolActivities.sql">SQL</a></td> @@ -244,7 +275,7 @@ </tr> <tr> - <td>SimplestUnary</td> + <td>SimplestUnary <a href="ORM/SimplestUnary.orm">(orm)</a></td> <td><a href="CQL/SimplestUnary.cql">CQL</a></td> <td><a href="ruby/SimplestUnary.rb">Ruby</a></td> <td><a href="SQL/SimplestUnary.sql">SQL</a></td> @@ -253,7 +284,7 @@ </tr> <tr> - <td>Warehousing</td> + <td>Warehousing <a href="ORM/Warehousing.orm">(orm)</a></td> <td><a href="CQL/Warehousing.cql">CQL</a></td> <td><a href="ruby/Warehousing.rb">Ruby</a></td> <td><a href="SQL/Warehousing.sql">SQL</a></td> @@ -262,7 +293,7 @@ </tr> <tr> - <td>WindowInRoomInBldg</td> + <td>WindowInRoomInBldg <a href="ORM/WindowInRoomInBldg.orm">(orm)</a></td> <td><a href="CQL/WindowInRoomInBldg.cql">CQL</a></td> <td><a href="ruby/WindowInRoomInBldg.rb">Ruby</a></td> <td><a href="SQL/WindowInRoomInBldg.sql">SQL</a></td> examples/index.html @@ -1,7 +1,7 @@   -<link rel="stylesheet" href="css/offline.css" media="screen" type="text/css" /> +<link rel="stylesheet" href="../css/offline.css" media="screen" type="text/css" /> <div id="sidebar"></div> <div id="top" class="content"> @@ -11,52 +11,121 @@ ActiveFacts Project Status </h2> + <h4>Constellation Query Language</h4> + - The Constellation Query Language has DDL support sufficient to allow - conversion of any ORM2 model. The Ruby generator is complete. The SQL - generator is complete, but with a couple of known defects in corner cases. - The generated Ruby code has only a partial implementation of the mapping - data needed to convert to and from SQL tables, and even that has to be - enabled using an option. + The Constellation Query Language implementation available in + version 0.8.5 compiles all features of ORM2 implemented by NORMA + with only minuscule differences. Entity Types, Value Types, Fact + Types (including objectified), Reference Modes, and all types of + constraints - Value and Role Value Restriction, Presence + Constraints (which covers Mandatory, Uniqueness, and Frequency + constraints), Subset, Equality, Exclusion, Mandatory Exclusion, + and Ring constraints. + + At this version Terms (object type names) may not contain + spaces. Terms may not appear in readings (unless in lower-case) + and readings may only contain single adjectives (hyphen-binding). + Deontic constraints are recognised using the annotation (otherwise + action). Join Constraints may also be defined beyond those + available in NORMA. Example data may be declared. - CQL is not yet handling imported vocabularies, example fact populations or - value type units yet. It has limited model validation facilities, and it's - not yet possible to add a new reading to an existing fact type. It's also - only parsing query syntax, with no semantic analysis or SQL generation. + This version provides functionality not available in NORMA. Additions + include: + <ul> + <li> Business Context Notes, which are annotations indicating why a + particular modeling construct was used, and who approved that. + </li> + <li> Definition of Units using conversion formulae. A library of + 500 standard unit conversions is provided. </li> + <li> Value Types may be defined to utilise those units. </li> + </ul> - The Constellation API (in Ruby) supports the generated Ruby code, allowing - any fact population to be constructed for a given vocabulary. There is - not yet any support within the API for database persistence, but that's - coming up for implementation soon. + New features are being developed for an upcoming 0.9.0 release: + <ul> + <li> Multi-word terms, and multiple adjectives. + <li> Improvements on the use of the hyphen to allow hyphenated words in readings. + <li> Term Synonyms + <li> Imported vocabularies (including multi-lingual versioning) + <li> Improved model validation + </ul> - The Metamodel is generated to Ruby from CQL or ORM2 to support the - creation and manipulation of any semantic model. Some changes are upcoming - to support a vocabulary that provides a translation of an existing - vocabulary, such as a Dutch or Japanese version of an English language - model. + Beyond that, the query syntax will be completed and queries will be generated + to SQL. + <h4>Constellation Query Language generators</h4> + + + The CQL generator allows conversion of NORMA files. At the present release, + deontic constraints and example fact populations are not emitted. + + + + The Ruby generator is functional. Not all constraints are emitted to Ruby yet, + but any combination of facts allowed by the vocabulary may be represented. + + + The SQL generators are generating correct and useful SQL, using a relational + mapping algorithm that produces similar results to NORMA. This algorithm will + be extended to emit more constraints, and to provide more control over + the generation of object names, and to directly support Ruby on Rails. + Deontic constraints are still handled as Alethic. + + + <h4>The Constellation API</h4> + + + The Constellation API (in Ruby) supports the generated Ruby code, by + allowing any fact population to be asserted into a constellation for + a given vocabulary. The generated Ruby module for a vocabulary can be + told which object types are tables in the SQL, and can infer all the + column names and object mappings from that. + + + Processing of the deny operation (which removes facts from a + constellation) does not yet propagate denial through mandatory roles. + There is not yet a validate operation to verify that all verifible + constraints are met. Where a constellation is known to be + incomplete, that's not yet able to be recorded (this will be used + in determining which constraints can be checked) + There is not yet any support within the API for database persistence + (creating a constellation from query results, and creating, deleting or + updating database rows by saving a constellation). + + + <h4>The ORM2 Metamodel</h4> + + + The ORM2 Metamodel is generated to Ruby from CQL or ORM2 to support + the creation and manipulation of any semantic model. Some changes are + upcoming to support synonyms, including allowing a vocabulary to + provide a translation of an existing vocabulary, such as a Dutch or + Japanese version of an English language model. + + +  - +  <!--p> APRIMO allows the definition of vocabulary aspects as well as the addition status.html dc09dcb1ec21060076b5eb908f49ad84dd9945a4 Clifford Heath clifford.heath@gmail.com http://github.com/cjheath/activefacts/commit/8c3a376351d978b3a50d5b5e77cc01872acf4d3b 8c3a376351d978b3a50d5b5e77cc01872acf4d3b

2009-10-30T05:47:24-07:00

Updated examples and status to 0.8.5 level 808e9b0c46b0efd34bf78d9f716b1e7aa9f48964 Clifford Heath clifford.heath@gmail.com