activefacts-compositions 1.9.22 → 1.9.23

data/lib/activefacts/generator/doc/css/ldm.css

@@ -1,33 +1,28 @@
-a:link, a:visited {
-  color: #8A0092; text-decoration: underline;
-}
-
-span {
-  font-family: "Frutiger", sans-serif;
-}
-
 .keyword {
   color: #0000CC;
 }
 
-.term, .concept {
+.schema, .term, .concept {
   /* Xcolor: #6A0072;   The color used by NORMA */
   color: #8A0092;
 }
 
-.vocabulary, .object_type {
-  /* Xcolor: #6A0072;   The color used by NORMA */
-  color: #8A0092;
-}
-
-.linking, .reading {
+.reading {
   color: #0E5400;
 }
 
-.literal, .value {
+.value {
   color: #FF990E;
 }
 
+a:link, a:visited {
+  color: #8A0092; text-decoration: underline;
+}
+
+span {
+  font-family: "Helvetica Neue", Helvetica,"Arial Unicode MS", Arial, sans-serif;
+}
+
 .glossary-objectification .glossary-reading {
   margin-left:  30px;
 }
@@ -42,4 +37,4 @@ span {
 
 .row-bordered {
   border: 1px solid #ddd;
-}
+}

data/lib/activefacts/generator/doc/css/orm2-print.css

@@ -0,0 +1,19 @@
+.keyword {
+  color: #0000CC;
+  font-style: italic;
+  display: inline;
+}
+
+.schema, .term {
+  color: #8A0092;
+  font-weight: bold;
+}
+
+.reading {
+  color: #0E5400;
+}
+
+.value {
+  color: #FF990E;
+  display: inline;
+}

data/lib/activefacts/generator/doc/css/orm2.css

@@ -0,0 +1,28 @@
+span {
+  font-family: "Helvetica Neue", Helvetica,"Arial Unicode MS", Arial, sans-serif;
+}
+
+.keyword {
+  color: #0000CC;
+  display: inline;
+}
+
+.schema,
+.term {
+  /* Xcolor: #6A0072;   The color used by NORMA */
+  color: #8A0092;
+}
+
+.schema:link, .schema:visited,
+.term:link, .term:visited {
+  color: #8A0092; text-decoration: underline;
+}
+
+.reading {
+  color: #0E5400;
+}
+
+.value {
+  color: #FF990E;
+  display: inline;
+}

data/lib/activefacts/generator/doc/css/reset.css

@@ -0,0 +1,18 @@
+* {
+  margin: 0px;
+  padding: 0px;
+}
+
+ul, menu, dir {
+  display: block;
+  list-style-type: disc;
+  -webkit-margin-before: 0px;
+  -webkit-margin-after: 0px;
+  -webkit-margin-start: 0px;
+  -webkit-margin-end: 0px;
+  -webkit-padding-start: 0px;
+}
+li {
+  list-style: none;
+}
+

data/lib/activefacts/generator/doc/css/treetable.css

@@ -0,0 +1,83 @@
+/* Composition in the Treetable */
+.mandatory {
+  font-weight: bold;
+}
+
+/* Treetable */
+
+div.tt-outer {			/* The wrapper for a Tree-Table structure */
+  line-height: 1.7em;		/* Separate the lines by more than the height */
+  margin: 10px;
+}
+
+.tt-node {			/* A node in a Tree-Table structure */
+  line-height: 1.5em;
+  background-color: #FFF;	/* Make the message stand out from the background */
+  border: 3px ridge;            /* A nice border around each node */
+  padding-left: 0.5em;          /* Start text a bit further inside the border */
+  margin-left: 5px;		/* Indent each node this much further  */
+  margin-right: -3px;		/* Overlay the right border of the outer object */
+  margin-bottom: -3px;		/* Overlay the bottom border of the outer object */
+}
+
+.tt-list {			/* A node for an array or list of items */
+  background: #DDF;		/* Make it stand out by colour */
+  border: 4px ridge;		/* Use a slightly fatter border */
+  margin-left: 1px;		/* Stand a little further to the left than our peers */
+  margin-top: -3px;		/* Stand a little to upwards */
+  margin-right: -3px;		/* Bring the right margin to the left as well */
+  margin-bottom: 1px;		/* Leave room below for the shadow to show */
+  box-shadow: 4px 4px 2px #888; /* Leave a shadow to the right and below */
+}
+
+.tt-list:before{
+  content:'(N)  ';
+  font-size: 8pt;
+  vertical-align: top;
+}
+
+.tt-alt {
+  border-radius: 10px 10px 0px 10px;  /* Use rounded corners */
+  margin-top: 10px;		/* Leave a space above alternative items */
+}
+div:first-of-type.tt-alt {
+  margin-top: 0px !important;	/* Don't leave a space above the first list item */
+}
+div:first-of-type.tt-alt:before {
+  content:'either';
+  font-size: 6pt;
+}
+
+.tt-alt:before{
+  content:'or';
+  font-size: 6pt;
+}
+
+.tt-desc {			/* Display the data item description */
+  position: absolute;		/* Glue it to the right of the outer block */
+  display: inline-block;
+  border-left: 3px ridge;	/* Draw a vertical separator to the left */
+  background: #FFF;		/* Ensure a long tt-type doesn't show through */
+  right: 11px;			/* Fill the space to the far right, minus borders */
+  left: 36em;			/* Start where the data type ends */
+  padding: 0px 5px 4px 5px;	/* Leave room at the start and end */
+  line-height: 1.5em;		/* Separate the lines by more than the height */
+  height: 1.3em;		/* Clip the height to one line */
+  overflow: hidden;		/* Don't attempt to show the whole text if it doesn't fit */
+}
+
+.tt-list > .tt-desc {
+  background: #DDF;		/* Make it stand out by colour */
+  padding-bottom: 6px;		/* -list has a bigger border, so the -desc needs to be taller */
+}
+.tt-type {			/* Display the data type */
+  position: absolute;		/* Glue it just left of the description */
+  display: inline-block;
+  border-left: 3px ridge;	/* Draw a vertical separator to the left */
+  left: 24em;			/* Start this far across */
+  width: 12em;			/* Provide space for the type name */
+  padding: 0px 5px 0px 5px;	/* Leave room at the start and end */
+  line-height: 1.5em;		/* Separate the lines by more than the height */
+  height: 1.4em;		/* Clip the height to one line */
+  overflow: hidden;		/* Don't attempt to show the whole text if it doesn't fit */
+}

data/lib/activefacts/generator/doc/cwm.rb

@@ -15,26 +15,7 @@ require 'activefacts/support'
 module ActiveFacts
   module Generators
     module Doc
-      
-      # Add namespace id to metamodel forward referencing     
-      class ActiveFacts::Metamodel::Composite       # for tables
-        attr_accessor   :xmiid
-      end
-      
-      class ActiveFacts::Metamodel::Component      # for columns
-        attr_accessor   :xmiid
-        attr_accessor   :index_xmiid
-      end
-      
-      class ActiveFacts::Metamodel::Index           # for primary and unique indexes
-        attr_accessor   :xmiid
-      end
-      
-      class ActiveFacts::Metamodel::ForeignKey      # for foreign keys
-        attr_accessor   :xmiid
-      end
-      
-      class CWM      
+      class CWM
         MM = ActiveFacts::Metamodel unless const_defined?(:MM)
         def self.options
           {
@@ -42,7 +23,12 @@ module ActiveFacts
           }
         end
 
-        def initialize composition, options = {}
+        def self.compatibility
+          [1, %i{relational}]   # one relational composition
+        end
+
+        def initialize constellation, composition, options = {}
+          @constellation = constellation
           @composition = composition
           @options = options
           @underscore = options.has_key?("underscore") ? (options['underscore'] || '_') : ''
@@ -119,15 +105,15 @@ module ActiveFacts
         def populate_namespace_ids
           model_ns = rawnsdef
           schema_ns = rawnsdef
-          
+
           @composition.
           all_composite.
           sort_by{|composite| composite.mapping.name}.
           map{|composite| populate_table_ids(composite)}
-          
+
           [model_ns, schema_ns]
         end
-        
+
         def populate_table_ids(table)
           tname = table_name(table)
           nsdef(table)
@@ -136,7 +122,7 @@ module ActiveFacts
             next if leaf.is_a?(MM::Absorption) && leaf.parent_role.fact_type.is_a?(MM::TypeInheritance)
             nsdef(leaf)
           end
-          table.all_index.sort_by do |idx| 
+          table.all_index.sort_by do |idx|
             idx.all_index_field.map { |ixf| ixf.component.xmiid }
           end.map do |index|
             nsdef(index)
@@ -146,7 +132,7 @@ module ActiveFacts
             nsdef(fk)
           end
         end
-        
+
         def generate_header
           "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" +
           "<!DOCTYPE XMI SYSTEM \"CWM-1.1.dtd\">\n" +
@@ -167,11 +153,11 @@ module ActiveFacts
           generate_data_types(2) +
           "  </XMI.content>\n"
         end
-            
+
         def generate_footer
           "</XMI>\n"
         end
-      
+
         def generate_catalog(depth, model_ns, schema_ns)
           catalog_start =
             indent(depth, "<CWMRDB:Catalog xmi.id=\"#{model_ns}\" name=\"Model\" visibility=\"public\">") +
@@ -179,34 +165,34 @@ module ActiveFacts
             indent(depth, "    <CWMRDB:Schema xmi.id=\"#{schema_ns}\" name=\"Schema\" visibility=\"public\" namespace=\"#{model_ns}\">") +
             indent(depth, "      <CWM:Namespace.ownedElement>")
 
-          catalog_body = 
+          catalog_body =
             @composition.
             all_composite.
             sort_by{|composite| composite.mapping.name}.
             map{|composite| generate_table(depth+4, schema_ns, composite)}*"\n" + "\n"
-        
+
           catalog_end =
             indent(depth, "      </CWM:Namespace.ownedElement>") +
             indent(depth, "    </CWMRDB:Schema>") +
             indent(depth, "  </CWM:Namespace.ownedElement>") +
             indent(depth, "</CWMRDB:Catalog>")
-        
+
           catalog_start + catalog_body + catalog_end
         end
-      
+
         def generate_data_types(depth)
           @datatypes.map do | dt |
             indent(depth, dt)
           end * ""
         end
-      
+
         def generate_table(depth, schema_ns, table)
           name = table_name(table)
           delayed_indices = []
-        
+
           table_start =
             indent(depth, "<CWMRDB:Table xmi.id=\"#{table.xmiid}\" name=\"#{name}\" isSystem=\"false\" isTemporary=\"false\" visibility=\"public\" namespace=\"#{schema_ns}\">")
-          
+
           table_columns =
             indent(depth, "  <CWM:Classifier.feature>") +
             (table.mapping.all_leaf.flat_map.sort_by{|c| column_name(c)}.map do |leaf|
@@ -220,7 +206,7 @@ module ActiveFacts
 
           table_keys =
             indent(depth, "  <CWM:Namespace.ownedElement>") +
-              (table.all_index.sort_by do |idx| 
+              (table.all_index.sort_by do |idx|
                 idx.all_index_field.map { |ixf| ixf.component.xmiid }
               end.map do |index|
                 generate_index(depth+2, table.xmiid, index, name, table.all_foreign_key_as_target_composite)
@@ -231,23 +217,23 @@ module ActiveFacts
               end
             ) * "" +
             indent(depth, "  </CWM:Namespace.ownedElement>")
-  
+
           table_end =
             indent(depth, "</CWMRDB:Table>")
-          
+
           table_start + table_columns + table_keys + table_end
         end
 
         def generate_column(depth, table_ns, column)
           name = safe_column_name(column)
-        
+
           is_nullable = column.path_mandatory ? "columnNoNulls" : "columnNullable"
           constraints = column.all_leaf_constraint
 
           type_name, options = column.data_type(data_type_context)
           options ||= {}
           length = options[:length]
-          
+
           type_name, type_num = normalise_type_cwm(type_name, length)
           column_params = ""
           type_params = ""
@@ -259,14 +245,14 @@ module ActiveFacts
 
         def create_data_type(type_name, type_num, type_params)
           type_ns = rawnsdef
-        
-          cwm_data_type = 
+
+          cwm_data_type =
             "<CWMRDB:SQLSimpleType xmi.id=\"#{type_ns}\" name=\"#{type_name}\" visibility=\"public\" typeNumber=\"#{type_num}\" #{type_params}/>"
-          
+
           @datatypes << cwm_data_type
           type_ns
         end
-        
+
         def generate_index(depth, table_ns, index, table_name, all_fks_as_target)
           key_ns = index.xmiid
 
@@ -285,7 +271,7 @@ module ActiveFacts
           #   (index.composite_as_primary_index ? ' CLUSTERED' : ' NONCLUSTERED')
 
           key_type = primary ? 'CWMRDB:PrimaryKey' : 'CWM:UniqueKey'
-          
+
           # find target foreign keys for this index
           fks_as_target = all_fks_as_target
 
@@ -307,7 +293,7 @@ module ActiveFacts
             if fks_as_target.count > 0
               indent(depth, "<CWM:UniqueKey.keyRelationship>") +
               fks_as_target.map do |fk|
-                indent(depth, " <CWM:KeyRelationship xmi.idref=\"#{fk.xmiid}\"/>") 
+                indent(depth, " <CWM:KeyRelationship xmi.idref=\"#{fk.xmiid}\"/>")
               end * "" +
               indent(depth, "</CWM:UniqueKey.keyRelationship>")
             else
@@ -316,10 +302,10 @@ module ActiveFacts
             indent(depth, "</#{key_type}>")
           end
         end
-        
+
         def generate_foreign_key(depth, table_ns, fk)
           key_ns = fk.xmiid
-          
+
           if fk.all_foreign_key_field.size == 1
             fkf = fk.all_foreign_key_field[0]
             ixf = fk.all_index_field[0]
@@ -335,16 +321,16 @@ module ActiveFacts
                 out += indent(depth, "    <CWM:StructuralFeature xmi.idref=\"#{fkf.component.xmiid}\" uniqueKey=\"#{ixf.component.index_xmiid}\" />")
               end
               out
-            end + 
+            end +
             indent(depth, "  </CWM:KeyRelationship.feature>") +
             indent(depth, "</CWMRDB:ForeignKey>")
           end
           # fk.all_foreign_key_field.map{|fkf| safe_column_name fkf.component}*", " +
           # ") REFERENCES #{safe_table_name fk.composite} (" +
           # fk.all_index_field.map{|ixf| safe_column_name ixf.component}*", " +
-        
+
           # indent(depth, "<CWMRDB:ForeignKey xmi.id=\"#{key_ns}\" name=\"R#{key_ns}\" visibility=\"public\" namespace=\"#{ns}\" feature=\"_41\" uniqueKey=\"_48\" deleteRule=\"importedKeyRestrict\"  updateRule=\"importedKeyRestrict\"/>")
-            
+
         end
 
         def boolean_type
@@ -426,8 +412,8 @@ module ActiveFacts
             ['int', 4]
           end
         end
-        
- 
+
+
         def sql_value(value)
           value.is_literal_string ? sql_string(value.literal) : value.literal
         end
@@ -516,9 +502,29 @@ module ActiveFacts
             default_varchar_type
           end
         end
-        
+
       end
     end
     publish_generator Doc::CWM, "Common Warehouse Metamodel represented as an XMI file. Use a relational compositor"
   end
+
+  module Metamodel
+    # Add namespace id to metamodel forward referencing
+    class Composite       # for tables
+      attr_accessor   :xmiid
+    end
+
+    class Component      # for columns
+      attr_accessor   :xmiid
+      attr_accessor   :index_xmiid
+    end
+
+    class Index           # for primary and unique indexes
+      attr_accessor   :xmiid
+    end
+
+    class ForeignKey      # for foreign keys
+      attr_accessor   :xmiid
+    end
+  end
 end