ontomde-uml2-jpa 1.0.4

data/lib/ontomde-uml2-jpa/mapping.rb

@@ -0,0 +1,277 @@
+#
+#
+
+module Muml_Operation
+  #true  puts annotation on getter
+  #false puts annotation on attribute
+  JPA_ANNOTATE_GETTER=false
+
+
+  def jpa_addPersistence!
+    # java_AttributeGlobalSetter
+    # java_getter_property
+    if java_getter_property.empty?
+      return if(umlx_hasStereotype?("Create"))
+      #java_annotation_add("@Transient")
+      return
+    end
+
+    p=java_getter_property_one
+    return unless p.jpa_isPersistent?
+
+    if p.uml_type_one.kind_of?(Cuml_Class) && !p.uml_type_one.jpa_isPersistent?
+      p.java_annotation_add("/* not persistent */")
+      return
+    end
+
+    if(JPA_ANNOTATE_GETTER)
+      p.jpa_addPersistenceTo!(self)
+      # HACK
+      p.jpa_addPersistenceTo!(p) #TODO: remove
+      #p.java_annotation_add("@Transient")
+    else
+      p.jpa_addPersistenceTo!(p)
+    end
+  end
+end
+
+module Muml_Property
+  def jpa_isPersistent?
+    return true
+  end
+  def jpa_addPersistenceUnidirOneToOne!(ah)
+    #TODO: unicity constraint
+    ah.java_annotation_add("@OneToOne(cascade=CascadeType.ALL) /*TPL: 101*/")
+    #TODO: affiner cascadeType pour les delete
+  end
+
+  def jpa_addPersistenceUnidirOneToMany!(ah)
+    ah.java_annotation_add(%{@OneToMany(cascade=CascadeType.ALL,fetch=FetchType.EAGER) /*TPL:102*/})
+    jpa_addJoinTable(ah)
+  end
+  DEFAULT_CASCADE="(cascade=CascadeType.ALL)"
+  DEFAULT_CASCADE_I=",cascade=CascadeType.ALL"
+  def jpa_addPersistenceUnidirManyToOne!(ah)
+    ah.java_annotation_add("@ManyToOne #{DEFAULT_CASCADE} /*TPL:104*/")
+    jpa_addJoinColumn!(ah)
+  end
+
+  def jpa_addPersistenceUnidirManyToMany!(ah)
+    ah.java_annotation_add("@ManyToMany #{DEFAULT_CASCADE} /*TPL:105*/")
+    jpa_addJoinTable(ah)
+    jpa_addJoinColumn!(ah)
+  end
+  def jpa_addPersistenceBidirManyToManyMaster!(ah)
+    ah.java_annotation_add("@ManyToMany #{DEFAULT_CASCADE}/*TPL:106*/")
+    jpa_addJoinColumn!(ah)
+    jpa_addJoinTable(ah)
+  end
+  def jpa_addPersistenceBidirManyToManySlave!(ah)
+    ah.java_annotation_add("@ManyToMany #{DEFAULT_CASCADE}/*TPL:107*/")
+    jpa_addJoinColumn!(ah)
+    #Do not add join column !
+    #(or you will get 2 join tables)
+    #jpa_addJoinTable(ah)
+  end
+
+  def jpa_addPersistenceBidirOneToOneMaster!(ah)
+    ah.java_annotation_add(%{@OneToOne #{DEFAULT_CASCADE}/*TPL:108*/})
+    jpa_addJoinColumn!(ah)
+  end
+  def jpa_addPersistenceBidirOneToOneSlave!(ah)
+    ah.java_annotation_add(%{@OneToOne(mappedBy="#{umlx_otherEnd.java_NameProperty}" #{DEFAULT_CASCADE_I}) /*TPL:109*/})
+  end
+
+  def jpa_addPersistenceBidirOneToManyMaster!(ah)
+    ah.java_annotation_add(%{@OneToMany (mappedBy="#{umlx_otherEnd.java_NameProperty}"#{DEFAULT_CASCADE_I}) /*TPL:110*/})
+  end
+  def jpa_addPersistenceBidirOneToManySlave!(ah)
+    ah.java_annotation_add(%{@OneToMany (mappedBy="#{umlx_otherEnd.java_NameProperty}"#{DEFAULT_CASCADE_I}) /*TPL:111*/})
+    #jpa_addJoinColumn!(ah)
+  end
+
+  def jpa_addPersistenceBidirManyToOneMaster!(ah)
+    #ah.java_annotation_add(%{@ManyToOne(mappedBy="#{umlx_otherEnd.java_NameProperty}") /*TPL:112*/})
+    ah.java_annotation_add(%{@ManyToOne #{DEFAULT_CASCADE} /*TPL:112*/})
+    #ah.java_annotation_add(%{@JoinColumn(name="#{java_NameProperty}_fk"})
+    jpa_addJoinColumn!(ah)
+  end
+  def jpa_addPersistenceBidirManyToOneSlave!(ah)
+    #ah.java_annotation_add(%{@ManyToOne(mappedBy="#{umlx_otherEnd.java_NameProperty}") /*TPL:113*/})
+    ah.java_annotation_add(%{@ManyToOne #{DEFAULT_CASCADE} /*TPL:113*/})
+    #ah.java_annotation_add(%{@JoinColumn(name="#{java_NameProperty}_fk"})
+    jpa_addJoinColumn!(ah)
+  end
+
+  # adds a java annotation to specify the name of the join table.
+  #
+  #Note:
+  #  Explicitely naming join colums and join table is required whenever multiple associations exists between two classes and also with reflexive associations.
+  #
+  #Examples:
+  # Object A (rolea)-->(roleb) Object B
+  # Table A_roleb
+  #   field : A_id
+  #   field : B_id
+  #
+  # Object A (rolea)-->(roleb) Object A
+  #  Table A_roleb
+  #    field : A_id
+  #    field : A_self_id
+  #
+  def jpa_addJoinTable(ah)
+    postfix=(uml_ownedAttribute_inv_one==uml_type_one) ? "_self" : ""
+    ah.java_annotation_add %{	@JoinTable(
+		name="#{uml_ownedAttribute_inv_one.java_Name}_#{java_NameProperty}",
+		joinColumns={@JoinColumn( name="#{uml_ownedAttribute_inv_one.java_Name}_id")},
+		inverseJoinColumns={@JoinColumn(name="#{uml_type_one.java_Name}#{postfix}_id")}
+	) /*TPL:116*/}
+  end
+
+  # adds JPA annotation for an attribute with a cardinality 0..1 or 1
+  def jpa_addPersistenceOneAttribute!(ah)
+    ml=JavaMapping.instance.getTemplate(self.uml_type_one).maxStringLength
+    if ml.nil?
+      ah.java_annotation_add(%{@Basic /*TPL:114*/})
+    else
+      ah.java_annotation_add(%{@Column(length=#{ml}) /*TPL:114b*/})
+    end
+  end
+
+  # adds JPA annotation for an attribute with a cardinality *
+  def jpa_addPersistenceManyAttribute!(ah)
+    ah.java_annotation_add(%{@Transient //TODO: standard JPA cannot handle this case. Hibernate extension @CollectionOfElements is required/*TPL:115*/})
+  end
+
+  def jpa_addJoinColumn!(ah)
+    ah.java_annotation_add(%{@JoinColumn(name="#{java_NameProperty}_fk") /*TPL:103*/})
+  end
+
+  #adds property persistence annotation to annotationHolder.
+  #
+  #annotationHolder may be depending on annotation style:
+  #* property itself self
+  #* getter for the property
+  def jpa_addPersistenceTo!(ah)
+    if umlx_isAttribute?
+      jpa_addPersistenceToAttribute!(ah)
+    else
+      jpa_addPersistenceToAssociation!(ah)
+    end
+  end
+
+  def jpa_addPersistenceToAttribute!(ah)
+    jpa_addPersistenceToAttribute_TypeModificator!(ah)
+    if  umlx_upperValueIsOne?
+      jpa_addPersistenceOneAttribute!(ah)
+    else
+      jpa_addPersistenceManyAttribute!(ah)
+    end
+    return
+  end
+
+  def jpa_addPersistenceToAttribute_TypeModificator!(ah)
+    tpl=JavaMapping.instance.getTemplate(self.uml_type_one)
+    tpl.jpa_addTypeModificator(ah)
+  end
+
+  def jpa_addPersistenceToAssociation!(ah)
+    oe=umlx_otherEnd
+    binav=(!oe.nil?) && oe.umlx_isNavigable?
+    if  binav
+      jpa_addPersistenceToAssociationBidir!(ah)
+    else
+      jpa_addPersistenceToAssociationUnidir!(ah)
+    end
+  end
+
+  def jpa_addPersistenceToAssociationUnidir!(ah)
+    toOne=umlx_upperValueIsOne?
+    fromOne=umlx_otherEnd.nil? ? true : umlx_otherEnd.umlx_upperValueIsOne?
+    if    fromOne && toOne
+      jpa_addPersistenceUnidirOneToOne!(ah)
+    elsif fromOne && !toOne
+      jpa_addPersistenceUnidirOneToMany!(ah)
+    elsif !fromOne && toOne
+      jpa_addPersistenceUnidirManyToOne!(ah)
+    elsif !fromOne && !toOne
+      jpa_addPersistenceUnidirManyToMany!(ah)
+    else
+      raise Warning.new("Internal error")
+    end
+  end
+  def jpa_addPersistenceToAssociationBidir!(ah)
+    toOne=umlx_upperValueIsOne?
+    fromOne=umlx_otherEnd.nil? ? true : umlx_otherEnd.umlx_upperValueIsOne?
+    master=umlx_masterEnd?
+
+    if fromOne && toOne && (master)
+      jpa_addPersistenceBidirOneToOneMaster!(ah)
+    elsif fromOne && toOne && (!master)
+      jpa_addPersistenceBidirOneToOneSlave!(ah)
+    elsif fromOne && !toOne && (master)
+      jpa_addPersistenceBidirOneToManyMaster!(ah)
+    elsif fromOne && !toOne && (!master)
+      jpa_addPersistenceBidirOneToManySlave!(ah)
+    elsif !fromOne && toOne && (master)
+      jpa_addPersistenceBidirManyToOneMaster!(ah)
+    elsif !fromOne && toOne && (!master)
+      jpa_addPersistenceBidirManyToOneSlave!(ah)
+    elsif !fromOne && !toOne && (master)
+      jpa_addPersistenceBidirManyToManyMaster!(ah)
+    elsif !fromOne && !toOne && (!master)
+      jpa_addPersistenceBidirManyToManySlave!(ah)
+    else
+      raise Warning.new("Internal error")
+    end
+
+    return
+
+    #		if umlx_oneToOne?
+    #			if umlx_otherEnd.nil? || !umlx_otherEnd.umlx_isNavigable?
+    #				jpa_addPersistenceUnidirOneToOne!(ah)
+    #				#ah.java_annotation_add("@OneToOne")
+    #
+    #			elsif	umlx_masterEnd?
+    #				ah.java_annotation_add("@OneToOne(cascade = {CascadeType.MERGE, CascadeType.REFRESH, CascadeType.PERSIST, CascadeType.REMOVE})")
+    #		 		ah.java_annotation_add("@JoinColumn(name=\"#{umlx_otherEnd.java_NameBean}_fk\")")
+    #			elsif
+    #				ah.java_annotation_add("@OneToOne(mappedBy=\"#{umlx_otherEnd.java_NameProperty}\")")
+    #			end
+    #		end
+    #		if umlx_manyToOne?
+    #			if umlx_unidirectionnel?
+    #				ah.java_annotation_add("//TOFIX MANY TO ONE Unideirectionnel NOT IMPLEMENTED")
+    #			elsif
+    #				ah.java_annotation_add("@ManyToOne")
+    #				ah.java_annotation_add("@JoinColumn(name=\"#{umlx_otherEnd.java_NameBean}_fk\")")
+    #			end
+    #		end
+
+  end
+end
+
+class JavaMapping
+  def jpa_addTypeModificator(ah)
+    #nop
+  end
+end
+class JavaMappingCalendar < JavaMapping
+  def jpa_addTypeModificator(ah)
+    ah.java_annotation_add("@Temporal(TemporalType.DATE)")
+  end
+end
+
+class JavaMappingBLOB < JavaMapping
+  def jpa_addTypeModificator(ah)
+    ah.java_annotation_add("@Lob")
+    #mysql: MEDIUMBLOB LONGBLOB TINYBLOB BLOB
+    ah.java_annotation_add(%{@Column(columnDefinition="LONGBLOB")}) if ah.context[:mysql]
+    #cf: http://db.apache.org/derby/docs/10.1/ref/rrefblob.html
+    ah.java_annotation_add(%{@Column(columnDefinition="BLOB(4M)")}) if ah.context[:derby]
+  end
+end
+#class JavaMappingIMG < JavaMappingBLOB
+#end
+
+

data/lib/ontomde-uml2-jpa/redefined.rb

@@ -0,0 +1,75 @@
+# This file includes methods redefinitions
+#
+module Muml_Interface
+  #returns implementing class dao name (if only one exists)
+  #def db_daoClassName
+  #	jpa_daoClassName
+  #end
+  def jpa_daoClass
+    #log.debug { "Muml_Interface::jpa_daoClassName #{self}" }
+    found=nil
+    ext_isReferencedBy.each { |i|
+      next unless i.kind_of?(Muml_Implementation)
+      s=i.uml_supplier_one
+      next if s!=self
+      c=i.uml_client_one
+      raise Warning.new,"Too many jpa_daoClassName found for interface #{self}" unless found.nil? || found==c
+      found=c
+    }
+    raise Warning.new,"No jpa_daoClassName found for interface #{self}" if found.nil?
+    return found #.jpa_daoClassName
+  end
+end
+
+module Muml_Class
+  #def db_daoClassName
+  #jpa_daoClassName
+  #end
+  #def jpa_daoClassName
+  #	return "#{java_qualifiedName}Dao"
+  #end
+
+  def db_getFindAllCall
+    param=context[:db_useExtraTypeParameterForFindAll] ? "(#{self.java_qualifiedName})null" : ""
+    return "#{java_DAOClass_one.java_qualifiedName}.findAll(#{param})"
+  end
+
+  #Method redefined from ontomde-uml2-java
+  #alias :original_java_writeSuggesterBody :java_writeSuggesterBody
+  def java_writeSuggesterBody(oa)
+    #log.debug {"adding suggester to #{self} for #{oa}"}
+    if oa.uml_type_one.jpa_isPersistent?
+      #TODO: recherche du composite commun
+      #TODO: transient object do not have a valid uniq id
+
+      #if oa.umlx_oneSide?
+      if !oa.umlx_manySide?
+        write( %{
+/* TPL:0001jpa_one #{oa.umlx_oneSide?} */
+java.util.List<#{oa.uml_type_one.java_qualifiedName}> ret=#{oa.uml_type_one.db_getFindAllCall};
+#{oa.uml_type_one.java_qualifiedName} elt=get#{oa.java_NameBean}();
+if(elt!=null && !ret.contains(elt)) {
+	ret.add(elt);
+}
+return ret;\n})
+      else
+        write( %{
+/* TPL:0001jpa_many #{oa.umlx_oneSide?} */
+java.util.List<#{oa.uml_type_one.java_qualifiedName}> ret=#{oa.uml_type_one.db_getFindAllCall};
+
+#{oa.uml_type_one.java_qualifiedName} item=null;
+java.util.Iterator<?> iter=get#{oa.java_NameBean}().iterator();
+while(iter.hasNext()){
+	item=(#{oa.uml_type_one.java_qualifiedName}) iter.next();
+          if(!ret.contains(item)) {
+          ret.add(item);
+          }
+	}
+return ret;\n})
+
+      end
+    else
+      super(oa)#original_java_writeSuggesterBody(oa)
+    end
+  end
+end

data/lib/ontomde-uml2-jpa/simulationAutoImplement.rb

@@ -0,0 +1,54 @@
+
+
+#automatically populate methods with simulated code.
+#Methods will return an element or a liste of element
+#of the specified type.
+module Mrdf_Model
+  def db_addTestImplementations!
+    jpa_addTestImplementations!
+  end
+  def jpa_addTestImplementations!
+    each { |k,m|
+      next unless m.kind_of?(Muml_Operation)
+      m.jpa_addTestImplementation!
+    }
+  end
+end
+
+module Muml_Operation
+  JPA_TEST_CODE_TOP=%{
+		//TODO: replace this test code by real implementation
+		//log.error("test method called");\n}
+  def jpa_addTestImplementation!
+    return unless java_code.empty?
+    owner=umlx_owner_one
+    return if owner.kind_of?(Muml_Interface)
+    return if owner.uml_isAbstract?
+    #log.debug { "adding test implementation for #{self.umlx_owner_one}.#{self}" }
+    fp=nil
+    (uml_returnResult+uml_ownedParameter).each { |p|
+      next unless p.uml_direction_one.isReturn?
+      fp=p
+    }
+    if fp.nil?
+      self.java_code=JPA_TEST_CODE_TOP
+      return
+    elsif fp.uml_type_one.kind_of?(Muml_DataType)
+      #TODO: create test code
+      return
+    elsif (!fp.uml_type_one.jpa_isPersistent?) || (fp.uml_type_one.db_isTransient?) || (fp.uml_type_one.java_ignoreMe?)
+      #not a persistent class
+      return
+    elsif fp.umlx_oneSide?
+      self.java_code=%{#{JPA_TEST_CODE_TOP}\nreturn #{fp.uml_type_one.db_getFindAllCall}.get(0);}
+    elsif fp.uml_isOrdered?
+      self.java_code=%{#{JPA_TEST_CODE_TOP}\nreturn #{fp.uml_type_one.db_getFindAllCall};}
+    else
+      self.java_code=%{
+#{JPA_TEST_CODE_TOP}
+#{fp.java_propertyAssociationConcreteType} ret=new #{fp.java_propertyAssociationConcreteType}();
+ret.addAll(#{fp.uml_type_one.db_getFindAllCall});
+return ret;}
+    end
+  end
+end

data/lib/ontomde-uml2-jpa/version.rb

@@ -0,0 +1,8 @@
+module Ontomde
+  module Uml2
+    module Jpa
+      VERSION = '1.0.4'
+    end
+  end
+end
+

data/lib/ontomde-uml2-jpa.rb

@@ -0,0 +1,21 @@
+
+#:include: ontomde-uml2-jpa/jpa.rdoc
+
+# this constant is defined in every db module
+# multiple db module inclusion will trigger a warning
+DB_PERSISTENCE_MODULE="ontomde-uml2_jpa"
+
+require 'ontomde-uml2-java'
+require 'ontomde-uml2-apaCom'
+
+h="#{File.dirname(__FILE__)}/ontomde-uml2-jpa"
+
+require "#{h}/version.rb"
+require "#{h}/jpa.rb"
+require "#{h}/finder.rb"
+require "#{h}/configuration.rb"
+require "#{h}/mapping.rb"
+require "#{h}/redefined.rb"
+require "#{h}/simulationAutoImplement.rb"
+require "#{h}/locking.rb"
+

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: ontomde-uml2-jpa
+version: !ruby/object:Gem::Version 
+  version: 1.0.4
+platform: ruby
+authors: 
+- Stephane (Pierre) Carrie
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-03-03 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ontomde-uml2-java
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.0.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.0
+    version: 
+description: "JPA annotation generator library.  Most users will used this library trough ontomde-java-frontend command line utility options.  == FEATURES/PROBLEMS:  == SYNOPSIS:  == REQUIREMENTS:"
+email: stephanepierre.carrie@orange-ftgroup.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/ontomde-uml2-jpa.rb
+- lib/ontomde-uml2-jpa/version.rb
+- lib/ontomde-uml2-jpa/configuration.rb
+- lib/ontomde-uml2-jpa/redefined.rb
+- lib/ontomde-uml2-jpa/locking.rb
+- lib/ontomde-uml2-jpa/mapping.rb
+- lib/ontomde-uml2-jpa/finder.rb
+- lib/ontomde-uml2-jpa/simulationAutoImplement.rb
+- lib/ontomde-uml2-jpa/jpa.rb
+- lib/ontomde-uml2-jpa/jpa.rdoc
+- test/test_ontomde-uml2-jpa.rb
+has_rdoc: true
+homepage: http://ontomde.rubyforge.org
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.6
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.0.0
+  version: 
+requirements: []
+
+rubyforge_project: ontomde
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: OntoMDE JPA cartridge
+test_files: 
+- test/test_ontomde-uml2-jpa.rb