activefacts-metamodel 1.7.0

data/lib/activefacts/metamodel.rb

@@ -0,0 +1,624 @@
+require 'activefacts/metamodel/version'
+require 'activefacts/api'
+
+module ActiveFacts
+  module Metamodel
+
+    class Adjective < String
+      value_type :length => 64
+    end
+
+    class AgentName < String
+      value_type 
+      one_to_one :agent                           # See Agent.agent_name
+    end
+
+    class AggregateCode < String
+      value_type :length => 32
+      one_to_one :aggregate                       # See Aggregate.aggregate_code
+    end
+
+    class Annotation < String
+      value_type 
+    end
+
+    class Assimilation < String
+      value_type 
+      restrict 'absorbed', 'partitioned', 'separate'
+    end
+
+    class ContextNoteKind < String
+      value_type 
+      restrict 'as_opposed_to', 'because', 'so_that', 'to_avoid'
+    end
+
+    class Date < ::Date
+      value_type 
+    end
+
+    class Denominator < UnsignedInteger
+      value_type :length => 32
+    end
+
+    class Discussion < String
+      value_type 
+    end
+
+    class DisplayRoleNamesSetting < String
+      value_type 
+      restrict 'false', 'true'
+    end
+
+    class EnforcementCode < String
+      value_type :length => 16
+    end
+
+    class EphemeraURL < String
+      value_type 
+    end
+
+    class Exponent < SignedInteger
+      value_type :length => 16
+    end
+
+    class Frequency < UnsignedInteger
+      value_type :length => 32
+    end
+
+    class Guid < ::Guid
+      value_type 
+      one_to_one :alternative_set                 # See AlternativeSet.guid
+      one_to_one :component                       # See Component.guid
+      one_to_one :composition                     # See Composition.guid
+      one_to_one :concept                         # See Concept.guid
+      one_to_one :role_sequence                   # See RoleSequence.guid
+      one_to_one :shape                           # See Shape.guid
+      one_to_one :step                            # See Step.guid
+    end
+
+    class ImplicationRuleName < String
+      value_type 
+      one_to_one :implication_rule                # See ImplicationRule.implication_rule_name
+    end
+
+    class Length < UnsignedInteger
+      value_type :length => 32
+    end
+
+    class Literal < String
+      value_type 
+    end
+
+    class Name < String
+      value_type :length => 64
+      one_to_one :composition                     # See Composition.name
+      one_to_one :plural_named_unit, :class => "Unit", :counterpart => :plural_name  # See Unit.plural_name
+      one_to_one :topic, :counterpart => :topic_name  # See Topic.topic_name
+      one_to_one :unit                            # See Unit.name
+      one_to_one :vocabulary                      # See Vocabulary.name
+    end
+
+    class Numerator < Decimal
+      value_type 
+    end
+
+    class Offset < Decimal
+      value_type 
+    end
+
+    class Ordinal < UnsignedInteger
+      value_type :length => 16
+    end
+
+    class Pronoun < String
+      value_type :length => 20
+      restrict 'feminine', 'masculine', 'neuter', 'personal'
+    end
+
+    class RegularExpression < String
+      value_type 
+    end
+
+    class RingType < String
+      value_type 
+    end
+
+    class RotationSetting < String
+      value_type 
+      restrict 'left', 'right'
+    end
+
+    class Scale < UnsignedInteger
+      value_type :length => 32
+    end
+
+    class Subscript < UnsignedInteger
+      value_type :length => 16
+    end
+
+    class Text < String
+      value_type :length => 256
+    end
+
+    class TransactionPhase < String
+      value_type 
+      restrict 'assert', 'commit'
+    end
+
+    class X < SignedInteger
+      value_type :length => 32
+    end
+
+    class Y < SignedInteger
+      value_type :length => 32
+    end
+
+    class Agent
+      identified_by :agent_name
+      one_to_one :agent_name, :mandatory => true  # See AgentName.agent
+    end
+
+    class Aggregate
+      identified_by :aggregate_code
+      one_to_one :aggregate_code, :mandatory => true  # See AggregateCode.aggregate
+    end
+
+    class AlternativeSet
+      identified_by :guid
+      one_to_one :guid, :mandatory => true        # See Guid.alternative_set
+      maybe :members_are_exclusive
+    end
+
+    class Coefficient
+      identified_by :numerator, :denominator, :is_precise
+      has_one :denominator, :mandatory => true    # See Denominator.all_coefficient
+      maybe :is_precise
+      has_one :numerator, :mandatory => true      # See Numerator.all_coefficient
+    end
+
+    class Component
+      identified_by :guid
+      one_to_one :guid, :mandatory => true        # See Guid.component
+      has_one :mapping, :counterpart => :member   # See Mapping.all_member
+      has_one :name                               # See Name.all_component
+    end
+
+    class Composition
+      identified_by :guid
+      one_to_one :guid, :mandatory => true        # See Guid.composition
+      one_to_one :name, :mandatory => true        # See Name.composition
+    end
+
+    class Concept
+      identified_by :guid
+      one_to_one :guid, :mandatory => true        # See Guid.concept
+      has_one :implication_rule                   # See ImplicationRule.all_concept
+      has_one :topic                              # See Topic.all_concept
+    end
+
+    class ConceptAnnotation
+      identified_by :concept, :mapping_annotation
+      has_one :concept, :mandatory => true        # See Concept.all_concept_annotation
+      has_one :mapping_annotation, :class => Annotation, :mandatory => true  # See Annotation.all_concept_annotation_as_mapping_annotation
+    end
+
+    class Constraint
+      identified_by :concept
+      one_to_one :concept, :mandatory => true     # See Concept.constraint
+      has_one :name                               # See Name.all_constraint
+      has_one :vocabulary                         # See Vocabulary.all_constraint
+    end
+
+    class ContextNote
+      identified_by :concept
+      one_to_one :concept, :mandatory => true     # See Concept.context_note
+      has_one :context_note_kind, :mandatory => true  # See ContextNoteKind.all_context_note
+      has_one :discussion, :mandatory => true     # See Discussion.all_context_note
+      has_one :relevant_concept, :class => Concept  # See Concept.all_context_note_as_relevant_concept
+    end
+
+    class Discriminator < Component
+    end
+
+    class Enforcement
+      identified_by :constraint
+      has_one :agent                              # See Agent.all_enforcement
+      one_to_one :constraint, :mandatory => true  # See Constraint.enforcement
+      has_one :enforcement_code, :mandatory => true  # See EnforcementCode.all_enforcement
+    end
+
+    class Fact
+      identified_by :concept
+      one_to_one :concept, :mandatory => true     # See Concept.fact
+      has_one :fact_type, :mandatory => true      # See FactType.all_fact
+      has_one :population, :mandatory => true     # See Population.all_fact
+    end
+
+    class FactType
+      identified_by :concept
+      one_to_one :concept, :mandatory => true     # See Concept.fact_type
+    end
+
+    class ImplicationRule
+      identified_by :implication_rule_name
+      one_to_one :implication_rule_name, :mandatory => true  # See ImplicationRuleName.implication_rule
+    end
+
+    class Indicator < Component
+      has_one :role, :mandatory => true           # See Role.all_indicator
+    end
+
+    class Instance
+      identified_by :concept
+      one_to_one :concept, :mandatory => true     # See Concept.instance
+      one_to_one :fact                            # See Fact.instance
+      has_one :object_type, :mandatory => true    # See ObjectType.all_instance
+      has_one :population, :mandatory => true     # See Population.all_instance
+      has_one :value                              # See Value.all_instance
+    end
+
+    class LinkFactType < FactType
+    end
+
+    class Location
+      identified_by :x, :y
+      has_one :x, :mandatory => true              # See X.all_location
+      has_one :y, :mandatory => true              # See Y.all_location
+    end
+
+    class Mapping < Component
+      has_one :object_type, :mandatory => true    # See ObjectType.all_mapping
+    end
+
+    class Nesting < Mapping
+    end
+
+    class PresenceConstraint < Constraint
+      maybe :is_mandatory
+      maybe :is_preferred_identifier
+      has_one :max_frequency, :class => Frequency  # See Frequency.all_presence_constraint_as_max_frequency
+      has_one :min_frequency, :class => Frequency  # See Frequency.all_presence_constraint_as_min_frequency
+      has_one :role_sequence, :mandatory => true  # See RoleSequence.all_presence_constraint
+    end
+
+    class Query
+      identified_by :concept
+      one_to_one :concept, :mandatory => true     # See Concept.query
+    end
+
+    class Reading
+      identified_by :fact_type, :ordinal
+      has_one :fact_type, :mandatory => true      # See FactType.all_reading
+      maybe :is_negative
+      has_one :ordinal, :mandatory => true        # See Ordinal.all_reading
+      has_one :role_sequence, :mandatory => true  # See RoleSequence.all_reading
+      has_one :text, :mandatory => true           # See Text.all_reading
+    end
+
+    class RingConstraint < Constraint
+      has_one :other_role, :class => "Role"       # See Role.all_ring_constraint_as_other_role
+      has_one :ring_type, :mandatory => true      # See RingType.all_ring_constraint
+      has_one :role                               # See Role.all_ring_constraint
+    end
+
+    class Role
+      identified_by :fact_type, :ordinal
+      one_to_one :concept, :mandatory => true     # See Concept.role
+      has_one :fact_type, :mandatory => true      # See FactType.all_role
+      one_to_one :link_fact_type, :counterpart => :implying_role  # See LinkFactType.implying_role
+      has_one :object_type, :mandatory => true    # See ObjectType.all_role
+      has_one :ordinal, :mandatory => true        # See Ordinal.all_role
+      has_one :role_name, :class => Name          # See Name.all_role_as_role_name
+    end
+
+    class RoleSequence
+      identified_by :guid
+      one_to_one :guid, :mandatory => true        # See Guid.role_sequence
+      maybe :has_unused_dependency_to_force_table_in_norma
+    end
+
+    class RoleValue
+      identified_by :fact, :role
+      has_one :fact, :mandatory => true           # See Fact.all_role_value
+      has_one :instance, :mandatory => true       # See Instance.all_role_value
+      has_one :population, :mandatory => true     # See Population.all_role_value
+      has_one :role, :mandatory => true           # See Role.all_role_value
+    end
+
+    class SetConstraint < Constraint
+    end
+
+    class Shape
+      identified_by :guid
+      one_to_one :guid, :mandatory => true        # See Guid.shape
+      maybe :is_expanded
+      has_one :location                           # See Location.all_shape
+      has_one :orm_diagram, :class => "ORMDiagram", :mandatory => true  # See ORMDiagram.all_shape
+    end
+
+    class Step
+      identified_by :guid
+      has_one :alternative_set                    # See AlternativeSet.all_step
+      has_one :fact_type, :mandatory => true      # See FactType.all_step
+      one_to_one :guid, :mandatory => true        # See Guid.step
+      maybe :is_disallowed
+      maybe :is_optional
+    end
+
+    class SubsetConstraint < SetConstraint
+      has_one :subset_role_sequence, :class => RoleSequence, :mandatory => true  # See RoleSequence.all_subset_constraint_as_subset_role_sequence
+      has_one :superset_role_sequence, :class => RoleSequence, :mandatory => true  # See RoleSequence.all_subset_constraint_as_superset_role_sequence
+    end
+
+    class Topic
+      identified_by :topic_name
+      one_to_one :topic_name, :class => Name, :mandatory => true  # See Name.topic_as_topic_name
+    end
+
+    class Unit
+      identified_by :concept
+      has_one :coefficient                        # See Coefficient.all_unit
+      one_to_one :concept, :mandatory => true     # See Concept.unit
+      has_one :ephemera_url, :class => EphemeraURL  # See EphemeraURL.all_unit
+      maybe :is_fundamental
+      one_to_one :name, :mandatory => true        # See Name.unit
+      has_one :offset                             # See Offset.all_unit
+      one_to_one :plural_name, :class => Name, :counterpart => :plural_named_unit  # See Name.plural_named_unit
+      has_one :vocabulary, :mandatory => true     # See Vocabulary.all_unit
+    end
+
+    class Value
+      identified_by :literal, :is_literal_string, :unit
+      maybe :is_literal_string
+      has_one :literal, :mandatory => true        # See Literal.all_value
+      has_one :unit                               # See Unit.all_value
+      has_one :value_type, :mandatory => true     # See ValueType.all_value
+    end
+
+    class ValueConstraint < Constraint
+      has_one :regular_expression                 # See RegularExpression.all_value_constraint
+      one_to_one :role, :counterpart => :role_value_constraint  # See Role.role_value_constraint
+    end
+
+    class Variable
+      identified_by :query, :ordinal
+      has_one :object_type, :mandatory => true    # See ObjectType.all_variable
+      has_one :ordinal, :mandatory => true        # See Ordinal.all_variable
+      one_to_one :projection, :class => Role      # See Role.variable_as_projection
+      has_one :query, :mandatory => true          # See Query.all_variable
+      has_one :role_name, :class => Name          # See Name.all_variable_as_role_name
+      one_to_one :step, :counterpart => :objectification_variable  # See Step.objectification_variable
+      has_one :subscript                          # See Subscript.all_variable
+      has_one :value                              # See Value.all_variable
+    end
+
+    class Vocabulary
+      identified_by :name
+      one_to_one :name, :mandatory => true        # See Name.vocabulary
+    end
+
+    class Absorption < Mapping
+      has_one :child_role, :class => Role, :mandatory => true  # See Role.all_absorption_as_child_role
+      maybe :flattens
+      has_one :index_role, :class => Role         # See Role.all_absorption_as_index_role
+      has_one :parent_role, :class => Role, :mandatory => true  # See Role.all_absorption_as_parent_role
+    end
+
+    class Aggregation
+      identified_by :aggregate, :aggregated_variable
+      has_one :aggregate, :mandatory => true      # See Aggregate.all_aggregation
+      has_one :aggregated_variable, :class => Variable, :mandatory => true  # See Variable.all_aggregation_as_aggregated_variable
+      has_one :variable, :mandatory => true       # See Variable.all_aggregation
+    end
+
+    class Agreement
+      identified_by :context_note
+      one_to_one :context_note, :mandatory => true  # See ContextNote.agreement
+      has_one :date                               # See Date.all_agreement
+    end
+
+    class Bound
+      identified_by :value, :is_inclusive
+      maybe :is_inclusive
+      has_one :value, :mandatory => true          # See Value.all_bound
+    end
+
+    class Composite
+      identified_by :mapping
+      has_one :composition, :mandatory => true    # See Composition.all_composite
+      one_to_one :mapping, :mandatory => true     # See Mapping.composite
+    end
+
+    class ConstraintShape < Shape
+      has_one :constraint, :mandatory => true     # See Constraint.all_constraint_shape
+    end
+
+    class ContextAccordingTo
+      identified_by :context_note, :agent
+      has_one :agent, :mandatory => true          # See Agent.all_context_according_to
+      has_one :context_note, :mandatory => true   # See ContextNote.all_context_according_to
+      has_one :date                               # See Date.all_context_according_to
+    end
+
+    class ContextAgreedBy
+      identified_by :agreement, :agent
+      has_one :agent, :mandatory => true          # See Agent.all_context_agreed_by
+      has_one :agreement, :mandatory => true      # See Agreement.all_context_agreed_by
+    end
+
+    class Derivation
+      identified_by :derived_unit, :base_unit
+      has_one :base_unit, :class => Unit, :mandatory => true  # See Unit.all_derivation_as_base_unit
+      has_one :derived_unit, :class => Unit, :mandatory => true  # See Unit.all_derivation_as_derived_unit
+      has_one :exponent                           # See Exponent.all_derivation
+    end
+
+    class Diagram
+      identified_by :vocabulary, :name
+      has_one :name, :mandatory => true           # See Name.all_diagram
+      has_one :vocabulary, :mandatory => true     # See Vocabulary.all_diagram
+    end
+
+    class DiscriminatedRole
+      identified_by :discriminator, :role
+      has_one :discriminator, :mandatory => true  # See Discriminator.all_discriminated_role
+      has_one :role, :mandatory => true           # See Role.all_discriminated_role
+      has_one :value, :mandatory => true          # See Value.all_discriminated_role
+    end
+
+    class FactTypeShape < Shape
+      has_one :display_role_names_setting         # See DisplayRoleNamesSetting.all_fact_type_shape
+      has_one :fact_type, :mandatory => true      # See FactType.all_fact_type_shape
+      has_one :rotation_setting                   # See RotationSetting.all_fact_type_shape
+    end
+
+    class Injection < Mapping
+    end
+
+    class ModelNoteShape < Shape
+      has_one :context_note, :mandatory => true   # See ContextNote.all_model_note_shape
+    end
+
+    class ORMDiagram < Diagram
+    end
+
+    class ObjectType
+      identified_by :vocabulary, :name
+      one_to_one :concept, :mandatory => true     # See Concept.object_type
+      maybe :is_independent
+      has_one :name, :mandatory => true           # See Name.all_object_type
+      has_one :pronoun                            # See Pronoun.all_object_type
+      has_one :vocabulary, :mandatory => true     # See Vocabulary.all_object_type
+    end
+
+    class ObjectTypeShape < Shape
+      maybe :has_expanded_reference_mode
+      has_one :object_type, :mandatory => true    # See ObjectType.all_object_type_shape
+    end
+
+    class ObjectifiedFactTypeNameShape < Shape
+      one_to_one :fact_type_shape, :mandatory => true  # See FactTypeShape.objectified_fact_type_name_shape
+    end
+
+    class Play
+      identified_by :step, :role
+      has_one :role, :mandatory => true           # See Role.all_play
+      has_one :step, :mandatory => true           # See Step.all_play
+      has_one :variable, :mandatory => true       # See Variable.all_play
+      maybe :is_input
+    end
+
+    class Population
+      identified_by :vocabulary, :name
+      one_to_one :concept, :mandatory => true     # See Concept.population
+      has_one :name, :mandatory => true           # See Name.all_population
+      has_one :vocabulary                         # See Vocabulary.all_population
+    end
+
+    class ReadingShape < Shape
+      one_to_one :fact_type_shape, :mandatory => true  # See FactTypeShape.reading_shape
+      has_one :reading, :mandatory => true        # See Reading.all_reading_shape
+    end
+
+    class RingConstraintShape < ConstraintShape
+      has_one :fact_type_shape, :mandatory => true  # See FactTypeShape.all_ring_constraint_shape
+    end
+
+    class RoleDisplay
+      identified_by :fact_type_shape, :ordinal
+      has_one :fact_type_shape, :mandatory => true  # See FactTypeShape.all_role_display
+      has_one :ordinal, :mandatory => true        # See Ordinal.all_role_display
+      has_one :role, :mandatory => true           # See Role.all_role_display
+    end
+
+    class RoleNameShape < Shape
+      one_to_one :role_display, :mandatory => true  # See RoleDisplay.role_name_shape
+    end
+
+    class RoleRef
+      identified_by :role_sequence, :ordinal
+      has_one :ordinal, :mandatory => true        # See Ordinal.all_role_ref
+      has_one :role, :mandatory => true           # See Role.all_role_ref
+      has_one :role_sequence, :mandatory => true  # See RoleSequence.all_role_ref
+      has_one :leading_adjective, :class => Adjective  # See Adjective.all_role_ref_as_leading_adjective
+      one_to_one :play                            # See Play.role_ref
+      has_one :trailing_adjective, :class => Adjective  # See Adjective.all_role_ref_as_trailing_adjective
+    end
+
+    class SetComparisonConstraint < SetConstraint
+    end
+
+    class SetComparisonRoles
+      identified_by :set_comparison_constraint, :ordinal
+      has_one :ordinal, :mandatory => true        # See Ordinal.all_set_comparison_roles
+      has_one :role_sequence, :mandatory => true  # See RoleSequence.all_set_comparison_roles
+      has_one :set_comparison_constraint, :mandatory => true  # See SetComparisonConstraint.all_set_comparison_roles
+    end
+
+    class SetEqualityConstraint < SetComparisonConstraint
+    end
+
+    class SetExclusionConstraint < SetComparisonConstraint
+      maybe :is_mandatory
+    end
+
+    class ValueConstraintShape < ConstraintShape
+      has_one :object_type_shape                  # See ObjectTypeShape.all_value_constraint_shape
+      one_to_one :role_display                    # See RoleDisplay.value_constraint_shape
+    end
+
+    class ValueRange
+      identified_by :minimum_bound, :maximum_bound
+      has_one :maximum_bound, :class => Bound     # See Bound.all_value_range_as_maximum_bound
+      has_one :minimum_bound, :class => Bound     # See Bound.all_value_range_as_minimum_bound
+    end
+
+    class AllowedRange
+      identified_by :value_constraint, :value_range
+      has_one :value_constraint, :mandatory => true  # See ValueConstraint.all_allowed_range
+      has_one :value_range, :mandatory => true    # See ValueRange.all_allowed_range
+    end
+
+    class DomainObjectType < ObjectType
+    end
+
+    class EntityType < DomainObjectType
+      one_to_one :fact_type                       # See FactType.entity_type
+    end
+
+    class TypeInheritance < FactType
+      identified_by :subtype, :supertype
+      has_one :subtype, :class => EntityType, :mandatory => true  # See EntityType.all_type_inheritance_as_subtype
+      has_one :supertype, :class => EntityType, :mandatory => true  # See EntityType.all_type_inheritance_as_supertype
+      has_one :assimilation                       # See Assimilation.all_type_inheritance
+      maybe :provides_identification
+    end
+
+    class ValueType < DomainObjectType
+      has_one :length                             # See Length.all_value_type
+      has_one :scale                              # See Scale.all_value_type
+      has_one :supertype, :class => ValueType     # See ValueType.all_value_type_as_supertype
+      has_one :transaction_phase                  # See TransactionPhase.all_value_type
+      has_one :unit                               # See Unit.all_value_type
+      one_to_one :value_constraint                # See ValueConstraint.value_type
+    end
+
+    class ValueTypeParameter
+      identified_by :value_type, :name
+      has_one :name, :mandatory => true           # See Name.all_value_type_parameter
+      has_one :value_type, :mandatory => true     # See ValueType.all_value_type_parameter
+      has_one :facet_value_type, :class => ValueType, :mandatory => true  # See ValueType.all_value_type_parameter_as_facet_value_type
+    end
+
+    class ValueTypeParameterRestriction
+      identified_by :value_type, :value_type_parameter
+      has_one :value_type, :mandatory => true     # See ValueType.all_value_type_parameter_restriction
+      has_one :value_type_parameter, :mandatory => true  # See ValueTypeParameter.all_value_type_parameter_restriction
+      has_one :value, :mandatory => true          # See Value.all_value_type_parameter_restriction
+    end
+
+    class ImplicitBooleanValueType < ValueType
+    end
+
+  end
+end