ontomde-uml2 1.0.4

data/lib/ontomde-uml2/umlx.rb

@@ -0,0 +1,638 @@
+module Muml_Element
+  #defines wether the associated element is external to the model and should not trigger code generation.
+  rdf_safe_attr_reader_many :umlx_external
+end
+
+module Muml_Classifier
+  #defines wether this element comes from business model.
+  rdf_safe_attr_reader_many :umlx_businessMethod
+end
+module Muml_Operation
+  #defines wether this element comes from business model.
+  rdf_safe_attr_reader_many :umlx_businessMethod
+end
+
+module Mrdf_Model
+  def umlx_MarkAllAsbusinessMethod!
+    each { |k,m|
+      next unless m.kind_of?(Muml_Operation) || m.kind_of?(Muml_Classifier)
+      #do not force value if already set
+      next unless m.umlx_businessMethod.empty?
+      m.umlx_businessMethod=RDF_TRUE
+    }
+  end
+end
+
+
+module Muml_Property
+  # returns true if property is navigable
+  def umlx_isNavigable?
+    o=umlx_owner_one(true)
+    return false if o.nil?
+    return o.uml_ownedAttribute.include?(self)
+  end
+
+  # returns true if this property is not part of an association.
+  # An attribute whose type is a class is considered an association.
+  def umlx_isAttribute?
+    t=uml_type_one
+    ret=(uml_association.to_s.empty?) && (t.kind_of?(Muml_DataType)||t.kind_of?(Muml_Enumeration))
+    return ret
+  end
+
+  # returns true if this property is part of an association.
+  def umlx_isAssociation?
+    return (!umlx_isAttribute?) && (!uml_aggregation_one0.nil?) && (uml_aggregation_one.isNone?)
+  end
+
+  # returns true if this property is part of an shared association.
+  def umlx_isShared?
+    return (!umlx_isAttribute?) && (uml_aggregation_one.isShared?)
+  end
+  # returns true if this property is part of composite association
+  def umlx_isComposite?
+    return (!umlx_isAttribute?) && (!uml_aggregation_one0.nil?) && (uml_aggregation_one.isComposite?)
+  end
+
+  # copy elements to the attribute property in Muml_Classifier module
+  def umlx_copyToAttributeProperty(oa)
+    oa.uml_upperValue=self.uml_upperValue
+    oa.uml_lowerValue=self.uml_lowerValue
+    oa.uml_type=self.uml_type
+    oa.uml_isOrdered=self.uml_isOrdered
+    oa.uml_isUnique=self.uml_isUnique
+  end
+end
+
+module Muml_Parameter
+  # copy elements to the attribute property in Muml_Classifier module
+  def umlx_copyToAttributeProperty(oa)
+    oa.uml_upperValue=self.uml_upperValue
+    oa.uml_lowerValue=self.uml_lowerValue
+    oa.uml_type=self.uml_type
+    oa.uml_isOrdered=self.uml_isOrdered
+    oa.uml_isUnique=self.uml_isUnique
+  end
+end
+
+
+# Both Muml_Class and Muml_Interface
+module Muml_Classifier
+  # returns true if this class directly carries
+  # associations, compositions or aggregations.
+  def umlx_hasRelation?
+    uml_ownedAttribute.each { |o|
+      return true unless o.umlx_isAttribute?
+    }
+    return false
+  end
+end
+
+
+module Muml_LiteralString
+  #Returns true if value is equal one
+  #NOTE:
+  #* IBM RSM uses   LiteralUnlimitedNatural
+  #* Magicdraw uses LiteralInteger and LiteralString
+  def umlx_equalOne?
+    #log.debug { "not used ???" }
+    #log.debug { "LS=#{uri} #{uml_value_one}" }
+    return uml_value_one==1
+  end
+  def umlx_equalZero?
+    #log.debug { "not used ???" }
+    #log.debug { "LS=#{uri} #{uml_value_one}" }
+    return uml_value_one==0
+  end
+end
+
+
+module Muml_LiteralInteger
+  #Returns true if value is equal 1 (one)
+  #NOTE:
+  #* IBM RSM uses   LiteralUnlimitedNatural
+  #* Magicdraw uses LiteralInteger and LiteralString
+  def umlx_equalOne?
+    return uml_value_one.to_i==1
+  end
+
+  #Returns true if value is equal 0 (zero)
+  #NOTE:
+  #* IBM RSM uses   LiteralUnlimitedNatural
+  #* Magicdraw uses LiteralInteger and LiteralString
+  def umlx_equalZero?
+    return uml_value_one.to_i==0
+  end
+end
+
+
+module Muml_LiteralUnlimitedNatural
+  #Returns true if value is equal one
+  #NOTE:
+  #* IBM RSM uses   LiteralUnlimitedNatural
+  #* Magicdraw uses LiteralInteger and LiteralString
+  def umlx_equalOne?
+    return uml_value_one.to_i==1
+  end
+
+  #Returns true if value is equal 0 (zero)
+  #NOTE:
+  #* IBM RSM uses   LiteralUnlimitedNatural
+  #* Magicdraw uses LiteralInteger and LiteralString
+  def umlx_equalZero?
+    return uml_value_one.to_i==0
+  end
+end
+
+
+module Muml_TypedElement
+  #Returns true if upperValue is equal to one
+  #NOTE:
+  #* returns true if upperValue is undefined or empty
+  def umlx_upperValueIsOne?
+    return true if uml_upperValue.empty? # 1 is assumed to be defaut
+    return uml_upperValue_one.umlx_equalOne?
+    #return (uml_upperValue.empty? || uml_upperValue.to_s=="1")
+  end
+
+  #returns true if lowerValue is equal to zero
+  #NOTE:
+  #* returns true if lowerValue is undefined or empty
+  def umlx_lowerValueIsZero?
+    return true if uml_lowerValue.empty? # 0 is assumed to be defaut
+    return uml_lowerValue_one.umlx_equalZero?
+    #return (uml_lowerValue.empty? || uml_lowerValue.to_s=="0")
+  end
+end
+
+
+module Mrdf_Model
+  #TO BE DONE
+  def umlx_computeIsAnException
+  end
+end
+
+
+module Muml_Class
+  #TO BE DONE
+  #Returns true if this class is used as an exception
+  #
+  #NOTE:
+  #* Is a class meant to be an exception is *not* used in a throws clause, it will *not* be detected
+  def umlx_isAnException?
+  end
+
+  #TO BE DONE
+  def umlx_isARootException?
+  end
+end
+
+
+module Muml_Element
+  #returns true if element has an applied stereotype named stereotype_name
+  #test is not case sensitive
+  def umlx_hasStereotype?(stereotype_name)
+    uml_appliedStereotype.each { |s|
+      next unless s.uml_name.to_s.casecmp(stereotype_name.to_s)==0
+      return true
+    }
+    return false
+  end
+end
+
+module Muml_Element
+  #returns nil or element with the proper name in the current namespace
+  def umlx_getElementNamed(name)
+    return nil
+  end
+
+end
+
+module Muml_Classifier
+  #returns nil or element with the proper name in the current namespace
+  def umlx_getElementNamed(name)
+    uml_ownedAttribute.each { |om|
+      return om if om.uml_name.to_s==name
+    }
+    uml_ownedOperation.each { |om|
+      return om if om.uml_name.to_s==name
+    }
+    return super(name)
+  end
+end
+module Muml_Package
+  #returns nil or element with the proper name in the current namespace
+  def umlx_getElementNamed(name)
+    uml_ownedMember.each { |om|
+      return om if om.uml_name.to_s==name
+    }
+    return super(name)
+  end
+end
+
+module Mrdf_Model
+
+  #Model name to be ignored
+  #Typicaly containing metamodels
+  UMLX_IGNORE_MODELS=["UML2"]
+
+  #flag used to display found multiple models message only once
+  @@message_umlx_model_not_found_displayed=false
+
+  #return first uml model found in model
+  def umlx_model
+    ret=[]
+    each { |k,c|
+      #next unless c.kind_of?(Muml_Class)
+      #p=c.umlx_model
+      #next if p.kind_of?(Muml_Profile)
+      #next if c.umlx_model.uml_name=="UML2"
+      #return p
+      next unless c.kind_of?(Muml_Model)
+      next if c.kind_of?(Muml_Profile)
+      next if UMLX_IGNORE_MODELS.include?(c.uml_name.to_s)
+      ret<< c
+    }
+    if ret.empty?
+      log.error { "umlx_model:no model found in rdf_model" }
+      return nil
+    elsif ret.length > 1
+      ms=""; ret.each { |m| ms=ms+m.uml_name.to_s+"," }
+      if !@@message_umlx_model_not_found_displayed
+        #log.debug { "umlx_model:found multiple models: #{ms}. Returning first one found.(#{ret[0]})" }
+        @@message_umlx_model_not_found_displayed=true
+      end
+    end
+    return ret[0]
+  end
+end
+module Muml_Classifier
+  #Returns UML Model containing self.
+  def umlx_model
+    p=umlx_package
+    return p.umlx_model unless p.nil?
+
+    #(uml_nestedClassifier_inv).each { |o|
+    #	puts "o=#{o}"
+    #}
+
+    log.error { "umlx_model:no model found for #{self.class.name} #{self}" }
+    return rdf_model.umlx_model
+  end
+end
+
+
+module Muml_Package
+  #Returns UML Model containing self.
+  def umlx_model
+    p=umlx_owner_one
+    return p.umlx_model unless p.nil?
+    return self
+  end
+end
+
+
+module Muml_Namespace
+  #returns a boolean datatype
+  def umlx_dataType_boolean 
+    return umlx_getOrCreateDataType("boolean")
+  end
+  # returns a string datatype
+  def umlx_dataType_string
+    return umlx_getOrCreateDataType("string")
+  end
+  # returns an integer datatype
+  def umlx_dataType_integer
+    return umlx_getOrCreateDataType("int")
+  end
+  # returns an long integer datatype
+  def umlx_dataType_long
+    return umlx_getOrCreateDataType("long")
+  end
+
+  # datatypes are created and looked up in umlx_reserved_model.
+  def umlx_getOrCreateDataType(m_name)
+    mod=umlx_reserved_model
+    p=mod.umlx_getElementNamed(m_name)
+    return p unless p.nil?
+    return mod.umlx_createAndAddDataType(m_name,m_name)
+  end
+
+  # stereotype are created and looked up in umlx_reserved_model.
+  def umlx_getOrCreateStereotype(m_name)
+    mod=umlx_reserved_model
+    p=mod.umlx_getElementNamed(m_name)
+    return p unless p.nil?
+    return mod.umlx_createAndAddStereotype(m_name,m_name)
+  end
+
+
+  #special token used to force umlx_getOrCreateProc to search every model
+  UMLX_SEARCH_EVERY_MODEL=13579
+
+  # For internal use.
+  # Lookup element name qual_name.
+  # Returns element if found, yields otherwise.
+  def umlx_getOrCreateProc(qual_name,startpoint=nil,&create)
+    #TODO Patch pour la gestion des génériques : A faire mieux qd gestion complète
+    #Ne marche pas si plusiuers génériques encastrées
+    if !qual_name.nil? && qual_name.include?("<")
+      beforeGen = qual_name.split("<")
+      s=beforeGen[0].split(".")
+      if beforeGen.length > 1
+        generic = "<#{beforeGen[1]}"
+        s[s.length-1] += generic
+      end
+    else
+      s=qual_name.split(".")
+    end
+    i=s.size
+    c_name=s[i-1]
+    s.delete_at(i-1)
+
+    searchPath=[]
+    if startpoint==UMLX_SEARCH_EVERY_MODEL
+      rdf_model.each { |k,c|
+        if c.kind_of?(Muml_Model)
+          searchPath<< c
+        end
+      }
+      searchPath<< umlx_reserved_model
+    elsif startpoint.nil?
+      searchPath<< umlx_reserved_model
+    else
+      searchPath=[startpoint]
+    end
+
+    c=nil
+    # make cur global
+    cur=nil
+    searchPath.each { |cur|
+      creationOK=(cur==startpoint) || (cur==umlx_reserved_model)
+      s.each { |m_name|
+        p=cur.umlx_getElementNamed(m_name)
+        break if p.nil? && !creationOK
+        #puts "---> #{cur.rdf_uri}/#{m_name}"  if (p.nil?)
+        cur=(!p.nil?) ? p : cur.umlx_createAndAddPackage("#{cur.rdf_uri}/#{m_name}",m_name)
+      }
+      c=cur.umlx_getElementNamed(c_name)
+      break unless c.nil?
+    }
+    c=yield(cur,qual_name,c_name) if c.nil?
+    return c
+  end
+
+  # Retrieves a package from its qualified name.
+  # Package will be created if not present in model.
+  # Example:
+  # 	umlx_getOrCreatePackage("com.mycompany")
+  def umlx_getOrCreatePackage(qual_name,startpoint=nil)
+    return umlx_getOrCreateProc(qual_name,startpoint) { |owner,qual_name,c_name|
+      owner.umlx_createAndAddPackage("#{owner.rdf_uri}/#{qual_name}",c_name)
+    }
+  end
+
+
+  # Retrieves an interface from its qualified name.
+  # Class will be created if not present in model.
+  # Example:
+  # 	umlx_getOrCreateInterface("java.util.Set")
+  def umlx_getOrCreateInterface(qual_name,startpoint=nil)
+    return umlx_getOrCreateProc(qual_name,startpoint) { |owner,qual_name,c_name|
+      ret=owner.umlx_createAndAddInterface(qual_name,c_name)
+      ret.umlx_external=RDF_TRUE
+      ret
+    }
+  end
+
+  # Retrieves an enumeration from its qualified name.
+  # Class will be created if not present in model.
+  # Example:
+  # 	umlx_getOrCreateEnumeration("com.mycompany.myEnum")
+  def umlx_getOrCreateEnumeration(qual_name,startpoint=nil)
+    return umlx_getOrCreateProc(qual_name,startpoint) { |owner,qual_name,c_name|
+      owner.umlx_createAndAddEnumeration(qual_name,c_name)
+    }
+  end
+
+  # Retrieves a class from its qualified name.
+  # Class will be created if not present in model.
+  # Example:
+  # 	umlx_getOrCreateClass("java.util.HashSet")
+  def umlx_getOrCreateClass(qual_name,startpoint=nil)
+    ret=umlx_getOrCreateProc(qual_name,startpoint){ |owner,qual_name,c_name|
+      c=owner.umlx_createAndAddClass(qual_name,c_name)
+      c.umlx_external=RDF_TRUE
+      c.db_isTransient=RDF_TRUE
+      c
+    }
+
+    if ! ret.kind_of?(Cuml_Class)
+      log.error {  <<END
+**** ERROR NAME CLASH DETECTED ****
+Creating a class named #{qual_name} failed
+because an element of the same name was found
+**** ERROR NAME CLASH DETECTED ****
+END
+      }
+      return nil
+    end
+    return ret
+  end
+
+end
+
+module Mrdf_Model
+  # A properly behaved model should not have inheritance from non abstract class.
+  # This transformation enforces that inheritance is always from an abstract class
+
+  def umlx_sanitizeAbstractsInHierarchy!
+    each { |k,gen|
+      next unless gen.kind_of?(Muml_Generalization)
+      g=gen.uml_general_one
+      sp=gen.uml_specific_one
+      next if g.uml_isAbstract?
+      next unless g.kind_of?(Muml_Class)
+      g.umlx_sanitizeAbstractsInHierarchy!
+    }
+  end
+
+  #Modify every composition so navigability is enabled from composante to composite.
+  #Composition between interface is not made navigable
+  def umlx_makeCompositionNavigable!
+    return unless context[:makeCompositionBiNavigable,true]
+
+    each  { |k,p|
+      next unless p.kind_of?(Muml_Association)
+      ce=nil #composante
+      ci=nil  #composite
+      p.uml_memberEnd.each {|a|
+        if a.uml_aggregation_one.isComposite?
+          ci=a
+        else
+          ce=a
+        end
+      }
+      next if ci.nil? || ce.nil?
+      next if ci.uml_type_one.kind_of?(Muml_Stereotype)
+      next if ce.uml_type_one.kind_of?(Muml_Stereotype)
+      #next if ce.uml_type_one.kind_of?(Muml_Interface)
+      return if ce.umlx_isNavigable?
+
+      #log.debug { "making composition bi-navigable #{p}"}
+      if ce.uml_name.empty?
+        #replace blank name with default name for composite.
+        ce.uml_name=context[:defaultBiNavigableCompositionName,"owner"]
+      end
+      #ce.uml_ownedAttribute_inv=ci.uml_type
+      #ce.uml_ownedAttribute_inv_one.uml_ownedAttribute_add(ce)
+      ci.uml_type_one.uml_ownedAttribute_add(ce)
+    }
+  end
+
+
+
+end
+
+module Muml_Class
+  # Suppose A derives from B and B is not abstract
+  # This transformater will
+  # 1) rename B to Babstract
+  # 2) mark Babstract as abstract
+  # 3) Create a new class B that derives from Babstract
+  # 4) (TBD) create facade constructors in (new) B.
+  def umlx_sanitizeAbstractsInHierarchy!
+    #log.debug { "sanitize #{uml_name} #{uml_isAbstract}==#{uml_isAbstract?}" }
+    self.uml_isAbstract=RDF_TRUE
+    c=umlx_package.umlx_createAndAddClass(rdf_uri+"_concret","_concrete")
+    c.uml_name="#{uml_name}"
+    self.uml_name="#{uml_name}Abstract"
+    c.umlx_createAndAddGeneralization(self)
+  end
+end
+
+module Muml_Operation
+  #uml_ownedAttribute_inv_one is sometime broken
+  #(RSM does not consistently populate this field)
+  #umlx_class_one figures out the correct value of uml_ownedAttribute_inv_one
+  def umlx_class_one
+    return uml_ownedOperation_inv_one
+    ##
+    ##  		ret=uml_class_one
+    ##  		#ret=uml_ownedAttribute_inv_one0
+    ##  		return ret unless ret.nil?
+    ##
+    ##  		#use ext_isReferencedBy
+    ##  		ext_isReferencedBy.each { |o|
+    ##  			next unless o.respond_to?(:uml_ownedOperation)
+    ##  			o.uml_ownedOperation.each { |c|
+    ##  				return o if c==self
+    ##  				}
+    ##  			}
+    ##  		log.error("umlx_class_one not found in model for #{self}:#{self.class}")
+    ##  		return nil
+  end
+end
+module Muml_Property
+  #uml_ownedAttribute_inv_one is sometime broken
+  #(RSM does not consistently populate this field)
+  #umlx_class_one figures out the correct value of uml_ownedAttribute_inv_one
+  def umlx_class_one
+    #	return uml_ownedAttribute_inv_one
+
+    #ret=uml_ownedAttribute_inv_one0
+    ret=uml_class_one0
+    return ret unless ret.nil?
+
+    #use association other end
+    oe=umlx_otherEnd
+    ret=oe.uml_type_one if !oe.nil?
+    return ret unless ret.nil?
+
+    #use ext_isReferencedBy
+    ext_isReferencedBy.each { |o|
+      next unless o.respond_to?(:uml_ownedAttribute)
+      o.uml_ownedAttribute.each { |c|
+        return o if c==self
+      }
+    }
+    log.error("umlx_class_one not found in model for #{self}:#{self.class}")
+    return nil
+  end
+end
+
+module Muml_Operation
+  #Returns true if operation is a constructor
+  #NOTE: RSM stereotype is "Create", MagicDraw "create"
+  def umlx_isConstructor?
+    return umlx_hasStereotype?("Create")
+  end
+end
+
+
+module Muml_Classifier
+  #returns every type assignable to this classifier
+  #(this includes self and any class deriving from it)
+  def umlx_assignableClassifier(ret=Set.new)
+    return ret if ret.include?(self)
+    ret<< self
+    uml_general_inv.each { |g|
+      g.uml_generalization_inv.each {|c|
+        c.umlx_assignableClassifier(ret)
+      }}
+    return ret
+  end
+end
+module Muml_Interface
+  #returns every type assignable to this classifier
+  #(this includes self and any class deriving from it)
+  def umlx_assignableClassifier(ret=Set.new)
+    return ret if ret.include?(self)
+    super(ret)
+    uml_supplier_inv.each { |g|
+      g.uml_implementation_inv.each {|c|
+        c.umlx_assignableClassifier(ret)
+      }}
+    return ret
+
+  end
+end
+
+module Muml_Class
+  #return true if uml_ownedAttribute_inv is a "regular" class
+  def umlx_isReallyAClass?
+    ret=kind_of?(Cuml_Class)
+    #ret=!(
+    #	 kind_of?(Muml_Stereotype)||
+    #	 kind_of?(Muml_StateMachine)||
+    #	 kind_of?(Muml_Activity)||
+    #	 kind_of?(Muml_Interaction)
+    #	 kind_of?(Muml_Component)||
+    #	 kind_of?(Muml_Device)||
+    #	 kind_of?(Muml_ExecutionEnvironment)||
+    #	 kind_of?(Muml_Node)
+    #	)
+    #log.debug { "umlx_isReallyAClass #{ret}::#{self.class.name}" }
+    return ret
+  end
+end
+
+
+module Mrdf_Resource
+  def umlx_reserved_model
+    return rdf_model.umlx_reserved_model
+  end
+end
+
+module Mrdf_Model
+  UMLX_RESERVED_MODEL_URI="http://xmda-reserved"
+  def umlx_reserved_model
+    r=self[UMLX_RESERVED_MODEL_URI]
+    return r unless r.nil?
+    r=self
+    r=Cuml_Model.new(self,UMLX_RESERVED_MODEL_URI)
+    #log.debug { "Creating reserved model (uri=#{r.uri})" }
+    return r
+  end
+end
+