ontomde-java 2.0.0

data/lib/ontomde-java/java/java.rdoc

@@ -0,0 +1,78 @@
+This tool is a java code generator for UML2 model.
+
+=Main advantages
+* Open Source
+* Case tool independant
+* Very low maintenance (<5000 lines of code and no dependency)
+* High perenity (no dependency on external tools and library) 
+* Very fast and scalable for large UML models
+* Generator is fully object oriented
+* Does not use tool specific template or extension language 
+
+=Required skills to generate java code from uml2 model
+* None, just lauch the generator command line (uml2java)
+
+=Required skills to customize the standard java code
+* UML2 model structure
+* Standard Ruby knowledge 
+* Read this documentation
+* No tool specific language (template, extension, ...)
+
+=Currently supported UML case tools are 
+* IBM Rational RSM 6.0 (full export, *incremental* export)
+* Magic Draw 11.5 (full export)
+
+=Standard features
+* Generates Java Enum for UML Enum
+* Generates Java Class for UML Class 
+* Generates Java inner Class for UML inner Class 
+* Generates Java interface for UML interface 
+* Generates Java operation squeleton for UML operation
+* Generates Java Attribute getter for java attribute (using a model transformation)
+* Generates Java Attribute setter for java attribute (using a model transformation)
+* Generates Java Attribute remover for java attribute (using a model transformation)
+* Generates UML exception for methods
+
+=Extended features
+* Model tranformation is used extensively for model enhancement (addition of getter/setter)
+* Generates Java accessors handling bi-directionnal associations (other end is updated)
+* Requires *no* external java library 
+* Requires *no* internal java library  (that would be provided by this tool)
+* Every accessor/getter/... may be modified in Java file and preserved by subsequent generation.
+* Generator has access to every UML2 model element (class model, state model, ...)
+* Performant model traversal. Every UML2 model element may be navigated both ways, unlike tools such as EMF/UML2 or Objecteering for example who require expensive full model lookup (to find out who inherits from me)
+* CodeSave feature. (When a method is deleted from UML model, Java code is saved in a file) (also works with any hand written code).
+
+=Eclipse Integration
+* Imports can be modified inline (in java file) by Eclipse
+* Imports generate by Eclipse "organize imports" are preserved by subsequent generations.
+
+* Java operation squeleton can be modified inline (in java file) using Eclipse.
+* Eclipse Ruby editor can be used to customize Java code generator.
+
+=Performance features
+* Model loading time is *linear* unlike MDR based products (such as AndroMDA)
+* Model loading time is similar to JAVA/EMF loading time
+* *Incremental* model update allow nearly instantaneous generation time even on very large models.
+
+=High end features
+* Model transformation are fully redefinable
+* Code generation is fully redefinable
+* Generator is fully object oriented
+
+=Agile Programming Feature
+* Generation runtime is independant of GUI and can be executed by daily builds on servers. 
+
+=Versionning features
+* Several versions of ontomde may be installed simultaneously on one machine.
+* Project may request one version of ontomde or a range (>=1, >=1 <2, ...)
+
+=Near zero dependency 
+This tool relies on  
+* UML2 specification 
+* Ruby 1.8
+* itself (<
+* and *nothing* else
+This tool lifecycle is independant of case tools and Eclipse continous evolution.
+You will never be forced to upgrade all of your generation scripts because you chose to change or upgrade your UML case tool.
+

data/lib/ontomde-java/java/javaDatatypeMapping.rb

@@ -0,0 +1,156 @@
+class DatatypeMapping
+    def java_getType
+    # inheriting class should redefine this method
+    log.error %{java_getType not implemented for #{self.class}}
+    return %{/* TODO: implement ruby java_getType for #{self.class}*/}
+  end
+end
+class DatatypeMappingText < DatatypeMapping
+  def java_getType
+    return "java.lang.String"
+  end
+end
+
+class DatatypeMappingLargeText < DatatypeMappingText
+end
+
+class DatatypeMappingMimeType < DatatypeMappingText
+end
+
+class DatatypeMappingOrdinal < DatatypeMappingText
+end
+
+class DatatypeMappingInteger < DatatypeMappingOrdinal
+  def java_getType
+    return "int"
+  end
+end
+
+class DatatypeMappingLong < DatatypeMappingOrdinal
+  def java_getType
+    return "long"
+  end
+end
+
+class DatatypeMappingLongObject < DatatypeMappingOrdinal
+  def java_getType
+    return "Long"
+  end
+end
+class DatatypeMappingFile < DatatypeMapping
+  def java_getType
+    return "java.lang.Object"
+  end
+end
+
+class DatatypeMappingBoolean < DatatypeMapping
+  #name of the key used by struts to referece
+  #current bean in session.
+  STRUTS_BEAN_KEY= "org.apache.struts.taglib.html.BEAN";
+  
+  def java_getType
+    return "boolean"
+  end
+end
+
+class DatatypeMappingTimeStamp < DatatypeMapping
+  def java_getType
+    return "java.util.Date"
+  end
+end
+
+class DatatypeMappingCalendar < DatatypeMapping
+  def java_getType
+    return "java.util.Date"
+  end
+end
+
+
+
+
+class DatatypeMappingGenericClass < DatatypeMapping
+    def getFormCopyTo(field)
+    a=field
+    return "/* #{a.java_NameBean} is transient */\n" if a.uml_type_one.java_DAOClass.empty?
+    if a.umlx_oneSide?
+      return %{_to.set#{a.java_NameBean}(this.get#{a.java_NameBean}().compareTo("nil")==0 ? null : #{a.uml_type_one.java_DAOClass_one.java_qualifiedName}.find(Long.parseLong(this.get#{a.java_NameBean}())));\n}
+    else # many
+      cm=a.java_getCollectionMapping
+      return <<END333
+{ // UML: #{field.uml_name}
+	String[] src=this.get#{a.java_NameBean}();
+	#{cm.addCollectionInterface(a.uml_type_one.java_qualifiedName)} newCol= #{cm.addNew(a.uml_type_one.java_qualifiedName)};
+	int max=src==null ? 0 : src.length;
+	#{a.uml_type_one.java_qualifiedName} item=null;
+	for(int i=0; i<max;i++) {
+		//log.error("loading : "+src[i]);
+		if(src[i]==null) continue;
+		item=#{a.uml_type_one.java_DAOClass_one.java_qualifiedName}.find(Long.parseLong(src[i]));
+		newCol.add(item);
+		}
+	_to.set#{a.java_NameBean}(newCol);
+}
+END333
+    end
+  end
+  def getFormInitFrom(field)
+    a=field
+    if a.umlx_oneSide?
+      return %{this.set#{a.java_NameBean}(_from.get#{a.java_NameBean}()==null? "nil" : Long.toString(_from.get#{a.java_NameBean}().getId()));\n}
+    else
+      return %{
+	{ /*STRUTS:2001*/
+	this.set#{a.java_NameBean}(null);
+      java.util.Iterator<?> iter=_from.get#{a.java_NameBean}().iterator();
+      #{a.uml_type_one.java_qualifiedName} item=null;
+      while(iter.hasNext()){
+      item=(#{a.uml_type_one.java_qualifiedName})iter.next();
+      this.add#{a.java_NameBean}(Long.toString(item.getId()));
+      }
+	}
+      }
+    end
+  end
+  def java_getType
+    return "java.lang.Object"
+  end
+end
+
+class DatatypeMappingGenericEnum < DatatypeMapping
+    NULL_ENUM_VALUE_AS_STRING="nil"
+  def getFormCopyTo(field)
+    a=field
+    return %{_to.set#{a.java_NameBean}(this.get#{a.java_NameBean}().compareTo("#{NULL_ENUM_VALUE_AS_STRING}")!=0 ? Enum.valueOf(#{a.uml_type_one.java_qualifiedName}.class,this.get#{a.java_NameBean}()):null);\n}
+  end
+  def getFormInitFrom(field)
+    #return "this.set#{field.java_NameBean}(_from.get#{field.java_NameBean}()==null ? -1 :_from.get#{field.java_NameBean}().ordinal());\n"
+    return %{this.set#{field.java_NameBean}(_from.get#{field.java_NameBean}()==null ? "#{NULL_ENUM_VALUE_AS_STRING}" :_from.get#{field.java_NameBean}().name());\n}
+  end
+  def java_getType
+    return "java.lang.Object"
+  end
+end
+
+
+class DatatypeMappingURL < DatatypeMappingText
+end
+
+class DatatypeMappingBLOB < DatatypeMapping
+  def java_getType
+    return "byte[]"
+  end
+end
+
+class DatatypeMappingIMG < DatatypeMappingBLOB
+end
+
+class DatatypeMappingGRAPHVIZ < DatatypeMappingLargeText
+end
+
+class DatatypeMappingPassword < DatatypeMappingText
+end
+
+class DatatypeMappingEmailAddress < DatatypeMappingText
+end
+
+

data/lib/ontomde-java/java/javaHelper.rb

@@ -0,0 +1,25 @@
+class JHelper
+  def JHelper.to_firstUpper(name)
+    result = String.new(name)
+    if !result.empty?
+      result[0] = result[0, 1].upcase
+    end
+    return result
+  end
+  def JHelper.to_NameProperty(name)
+    result = String.new(name)
+    if !result.empty?
+      result[0] = result[0, 1].downcase
+    end
+    return result
+  end
+  # remove the last caracter if 's'
+  def JHelper.to_SingleName(name)
+    result = String.new(name)
+    if !result.empty? && result[result.size-1]==115 #'s'
+      result = result[0, result.size - 1]
+    end
+    return result
+  end
+end
+

data/lib/ontomde-java/java/java_todo.rdoc

@@ -0,0 +1,3 @@
+TODO:
+* Handle manual constructors 
+* Implement hashcode (pour hashtable)

data/lib/ontomde-java/java/javadoc.rb

@@ -0,0 +1,254 @@
+
+
+class String
+  JAVA_ESCAPEJAVADOC_RE=/\*\\/
+  #write string as javadoc
+  #NOTE: source strings should not include javadoc comments open/close
+  #      (javadoc comments open/closed are removed)
+  def java_writeJavadoc(res)
+    # replace escaped carriage return by true carriage return
+    # remove java comments (we are already inside a javadoc)
+    self.gsub(/\\r\\n/,"\n").gsub(/\*\//,'--').gsub(/\/\*/,'--').each { |line|
+      res.write("   * #{line}".tr("\n"," ").rstrip)
+      res.write("\n")
+    }
+  end
+end
+
+module Muml_Classifier
+  #write classifier javadoc comment.
+  def java_writeJavadoc
+    return unless context[:javadoc]
+   
+    c=""
+    sep=""
+    uml_ownedComment.each { |comment|
+      c="#{c}#{sep}#{comment.uml_body_one}"
+      sep="\n"
+    }
+    mtk_protected(Mrdf_Resource::NOREVERSE,"javadoc",context[:hasGlobalReverse]||context[:hideJavadocReverseTag]) {
+      write("    /**\n");
+      c.java_writeJavadoc(self)
+      #Note: RSM exports adds an extraneous http://
+      #Note: TODO: This code is RSM 6 specific
+      %{@see <a href="#{context[:rsm6WebDocURI]}#{UriNamespace.instance.unalias(rdf_uri).gsub(/http:\/\/kb#/,"")}-content.html">UML documentation.</a>}.java_writeJavadoc(self) unless context[:rsm6WebDocURI].empty?
+
+      write("    */\n")
+    }
+  end
+end
+
+
+module Muml_Property
+  #returns a javadoc link suitable for @see and @link.
+  def java_javadocLink(location=nil)
+    o=umlx_owner_one
+    if location==o
+      #same class
+      return "##{java_Name}"
+    else
+      #different class
+      return "#{o.java_qualifiedName}##{java_Name}"
+    end
+
+  end
+  
+  #write property javadoc comment.
+  def java_writeJavadoc
+    return unless context[:javadoc]
+   
+    c=""
+    sep=""
+    uml_ownedComment.each { |comment|
+      c="#{c}#{sep}#{comment.uml_body_one}"
+      sep="\n"
+    }
+    mtk_protected(Mrdf_Resource::NOREVERSE,"javadoc",context[:hasGlobalReverse]||context[:hideJavadocReverseTag]) {
+      write("    /**\n");
+      c.java_writeJavadoc(self)
+      #Note: RSM exports adds an extraneous http://
+      #Note: TODO: This code is RSM 6 specific
+      %{@see <a href="#{context[:rsm6WebDocURI]}#{UriNamespace.instance.unalias(rdf_uri).gsub(/http:\/\/kb#/,"")}-content.html">UML documentation.</a>}.java_writeJavadoc(self) unless context[:rsm6WebDocURI].empty?
+
+      write("    */\n")
+    }
+  end
+end
+
+
+module Muml_Operation
+  #returns a javadoc link suitable for @see and @link.
+  def java_javadocLink(location=nil)
+    o=umlx_owner_one
+    if location==o
+      #same class
+      return "##{java_Name}"
+    else
+      #different class
+      return "#{o.java_qualifiedName}##{java_Name}"
+    end
+  end
+
+
+  #write operation javadoc comment.
+  def java_writeJavadoc
+    return unless context[:javadoc]
+    mtk_protected(Mrdf_Resource::NOREVERSE,"javadoc",context[:hasGlobalReverse]||context[:hideJavadocReverseTag]) {
+      java_writeJavadoc_internal
+    }
+  end
+  
+  #internal write javadoc
+  def java_writeJavadoc_internal
+    write("    /**\n");
+    hasDoc=false
+
+    #	if !java_getter_property.empty? && !java_getter_property_one.uml_isDerived?
+    #		"getter for property {@link #{java_getter_property_one.java_javadocLink}}".java_writeJavadoc(self)
+    #	end
+    #	if !java_setter_property.empty? && !java_setter_property_one.uml_isDerived?
+    #		"setter for property {@link #{java_setter_property_one.java_javadocLink}}".java_writeJavadoc(self)
+    #	end
+
+    p=java_getter_property_one0
+    if !p.nil?
+      oe=p.umlx_otherEnd
+      if !oe.nil? && oe.umlx_isNavigable?
+        g=oe.java_AttributeGlobalGetter_one0
+        if !g.nil?
+          "This property is part of a bi-navigable association {@link #{g.java_javadocLink(self)}}<br/>".java_writeJavadoc(self)
+        end
+      end
+    end
+
+
+    if !uml_ownedComment.empty?
+      #write("* @return the \n");
+      uml_ownedComment.each { |comment|
+        hasDoc=true
+        comment.uml_body_one.java_writeJavadoc(self)
+      }
+
+    elsif !java_getter_property.empty?
+      java_getter_property_one.uml_ownedComment.each { |comment|
+        hasDoc=true
+        comment.uml_body_one.java_writeJavadoc(self)
+      }
+    else
+      #nop
+    end
+    #if(!hasDoc)
+    #	"TODO: document this element in source UML model".java_writeJavadoc(self)
+    #end
+
+    uml_ownedParameter.each { |p|
+      c=""
+      p.uml_ownedComment.each { |comment|
+        c="#{c} #{comment.uml_body_one}"
+      }
+      c=" self-explanatory"
+      #next if c.empty? &&  p.uml_direction_one.isReturn?
+      "#{p.uml_direction_one.isReturn? ? %{@return} : %{@param}} #{p.java_Name unless p.uml_direction_one.isReturn?}#{c}".java_writeJavadoc(self)
+    }
+
+    if !java_setter_property.empty?
+      hasDoc=true
+      p=java_setter_property_one
+      if !p.java_AttributeGlobalGetter.empty?
+        "@see #{p.java_AttributeGlobalGetter_one.java_javadocLink}".java_writeJavadoc(self)
+      end
+    end
+
+    write("    */\n")
+  end
+end
+
+module Muml_EnumerationLiteral
+  def java_writeJavadoc
+    return unless context[:javadoc]
+    c=""
+    uml_ownedComment.each { |comment|
+      c="#{c} #{comment.uml_body_one}"
+    }
+    mtk_protected(Mrdf_Resource::NOREVERSE,"javadoc",context[:hasGlobalReverse]||context[:hideJavadocReverseTag]) {
+      unless c.empty?
+        write("    /**\n");
+        c.java_writeJavadoc(self)
+        write("    */\n")
+      end
+    }
+  end
+end
+
+
+module Mrdf_Repository
+
+  #returns a hash of package sets for which a javadoc should be generated.
+  #hash key is the qualifiedName of the packages
+  #(several uml packages may have the same name in different UML models)
+  #
+  #A package is included if :
+  #* it contains a generated class/interface/enum
+  #* it contains a uml comment
+  def java_getUsedPackages
+
+    ps=Hash.new
+    uml_Class_all.each  { |e|
+      p=e.umlx_owner_one
+      next unless p.kind_of?(Muml_Package)
+      next if p.umlx_isARootNamespace?
+      next if e.umlx_external?
+      pn=p.java_qualifiedName.to_s
+      s=ps[pn]
+      if s.nil?
+        s=Set.new
+        ps[pn]=s
+      end
+      s.add(p)
+    }
+
+    each { |k,p|
+      next unless p.kind_of?(Muml_Package)
+      next if p.kind_of?(Muml_Model)
+      next if p.uml_ownedComment.empty?
+      pn=p.java_qualifiedName.to_s
+      s=ps[pn]
+      if s.nil?
+        s=Set.new
+        ps[pn]=s
+      end
+      s.add(p)
+    }
+    return ps
+  end
+
+  #generates java documentation files (package-info.java) for
+  #packages directly containing elements (class, enum, interface)
+  #cf: http://java.sun.com/docs/books/jls/third_edition/html/packages.html
+  def java_generatePackageDoc
+    return unless context[:javadoc]
+    return unless context[:javadocForDir,false]
+    java_getUsedPackages.each { |packageName,packageSet|
+      fn=nil
+      packageSet.each { |package|
+        fn="#{package.java_FilePath}/#{package.java_Name}/package-info.java"
+        break
+      }
+      mtk_writeSession(fn) {
+        write("/**\n")
+        packageSet.each { |package|
+          package.uml_ownedComment.each { |comment|
+            comment.uml_body_one.java_writeJavadoc(self)
+          }
+        }
+        write("**/\n\n")
+        write("package #{packageName};\n")
+      }
+    }
+  end
+end
+
+
+
+
+