ontomde-uml2-java 1.0.4

data/lib/ontomde-uml2-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-uml2-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-uml2-java/javaMapping.rb

@@ -0,0 +1,420 @@
+#Template used for jsp input field generation
+
+#wrapper to easylly create a new datatype mapping
+#* umlDataTypeName is the name of the data type in source uml model
+#* baseMapping is the base definition mapping to derive from
+#* regexp is the string regexp used for display
+def addDataTypeMapping(umlDataTypeName,baseMapping,regexp=nil,&block)
+  if !baseMapping.kind_of?(Class)
+    raise Exception.new(%{Bad parameter type used for baseMapping got "#{baseMapping.class}" and expected "Class"})
+  end
+
+  rubyName=umlDataTypeName.tr('^a-zA-Z0-9','_')
+  s=%{
+	class JavaMapping#{rubyName} < #{baseMapping.name}
+		include Singleton
+		def appliesTo?(datatype)
+			return datatype.uml_name.to_s=="#{umlDataTypeName}"
+		end
+		#{regexp.nil? ? ""  : %{
+  def getValidationRegexp
+  return /#{regexp.source}/
+  end
+  }
+		}
+	end
+	JavaMapping#{rubyName}.class_eval( &block ) unless block.nil?
+
+	JavaMapping#{rubyName}.instance #register
+  }
+  t=eval s
+
+
+end
+
+class JavaMapping
+  include Singleton
+  def getMappings
+    return @@types
+  end
+  @@types=Array.new
+  def initialize
+    return if self.class==JavaMapping
+    @@types << self
+    #log.debug { %{registered(##{@@types.size}): #{self.class}} }
+  end
+  #returns true if this templates applies to datatype
+  def appliesTo?(datatype)
+    # inheriting class should redefine this method
+    log.error %{appliesTo? not implemented for #{self.class}}
+    return false
+  end
+  def getTemplate(datatype)
+    @@types.each {|t|
+      next unless t.appliesTo?(datatype)
+      return t
+    }
+    if !datatype.context[:silentlyForceUnknownDatatypeToString,false]
+      msg= %{No template #{self.class} found for datatype "#{datatype}"}
+      log.error msg unless log_already_displayed?(msg)
+    end
+
+    return JavaMappingText.instance
+    #return JavaMappingerror.instance
+  end
+
+  def getJavaType
+    # inheriting class should redefine this method
+    log.error %{getJavaType not implemented for #{self.class}}
+    return %{/* TODO: implement ruby getJavaType for #{self.class}*/}
+  end
+
+  # max length of this element represented as a string
+  attr :maxStringLength
+  attr_writer :maxStringLength
+  @maxStringLength=nil
+
+  def getValidationRegexp
+    #log.error %{getValidationRegexp not implemented for #{self.class}}
+    return nil #%{/* TODO: implement ruby getValidationRegexp for #{self.class}*/}
+  end
+end
+class JavaMappingText < JavaMapping
+  include Singleton
+
+  #default string length
+  @maxStringLength=10
+
+  MATCHING_UML_NAME=["String","string"]
+  #MATCHING_JAVA_NAME=["String","java.lang.String"]
+  def appliesTo?(datatype)
+    return true if MATCHING_UML_NAME.include?(datatype.uml_name_one)
+    #return true if MATCHING_JAVA_NAME.include?(datatype.java_qualifiedName)
+    return false
+  end
+
+  def getJavaType
+    return "java.lang.String"
+  end
+end
+
+class JavaMappingLargeText < JavaMappingText
+  include Singleton
+  MATCHING_UML_NAME=["LargeText"]
+  def appliesTo?(datatype)
+    return true if MATCHING_UML_NAME.include?(datatype.uml_name_one)
+    return false
+  end
+end
+
+
+class JavaMappingMimeType < JavaMappingText
+  include Singleton
+  MATCHING_UML_NAME=["MimeType"]
+  def appliesTo?(datatype)
+    return true if MATCHING_UML_NAME.include?(datatype.uml_name_one)
+  end
+end
+
+class JavaMappingOrdinal < JavaMappingText
+  include Singleton
+end
+
+class JavaMappingInteger < JavaMappingOrdinal
+  include Singleton
+  MATCHING_UML_NAME=["integer","Integer","int"]
+  #MATCHING_JAVA_NAME=[]
+  def appliesTo?(datatype)
+    return true if MATCHING_UML_NAME.include?(datatype.uml_name_one)
+    #	return true if MATCHING_JAVA_NAME.include?(datatype.java_qualifiedName)
+    return false
+  end
+
+
+  def getJavaType
+    return "int"
+  end
+
+end
+class JavaMappingLong < JavaMappingOrdinal
+  include Singleton
+  MATCHING_UML_NAME=["long"]
+  #MATCHING_JAVA_NAME=[]
+  def appliesTo?(datatype)
+    return true if MATCHING_UML_NAME.include?(datatype.uml_name_one)
+    #	return true if MATCHING_JAVA_NAME.include?(datatype.java_qualifiedName)
+    return false
+  end
+  def getJavaType
+    return "long"
+  end
+end
+class JavaMappingLongObject < JavaMappingOrdinal
+  include Singleton
+  MATCHING_UML_NAME=["Long"]
+  #MATCHING_JAVA_NAME=[]
+  def appliesTo?(datatype)
+    return true if MATCHING_UML_NAME.include?(datatype.uml_name_one)
+    # return true if MATCHING_JAVA_NAME.include?(datatype.java_qualifiedName)
+    return false
+  end
+  def getJavaType
+    return "Long"
+  end
+end
+class JavaMappingFile < JavaMapping
+  include Singleton
+  MATCHING_UML_NAME=["file"]
+  def appliesTo?(datatype)
+    return false unless datatype.kind_of?(Muml_DataType)
+    return true if MATCHING_UML_NAME.include?(datatype.uml_name_one)
+    #return datatype.struts_isBlob?
+    #return ["image"].include?(datatype.java_qualifiedName)
+  end
+  def getJavaType
+    return "java.lang.Object"
+  end
+end
+
+class JavaMappingBoolean < JavaMapping
+  include Singleton
+  MATCHING_UML_NAME=["Boolean","boolean"]
+  #MATCHING_JAVA_NAME=[]
+  def appliesTo?(datatype)
+    return true if MATCHING_UML_NAME.include?(datatype.uml_name_one)
+    #	return true if MATCHING_JAVA_NAME.include?(datatype.java_qualifiedName)
+    return false
+  end
+
+  #name of the key used by struts to referece
+  #current bean in session.
+  STRUTS_BEAN_KEY= "org.apache.struts.taglib.html.BEAN";
+
+
+  def getJavaType
+    return "boolean"
+  end
+
+end
+
+#struts jsp template for a timestamp datatype.
+#A timestamp is a precise periode in time, including date,hours,minutes and seconds.
+#NOTE:
+#   "Date" datatype name is discourage because it is ambiguous.
+#   (a java date is a timestamp)
+#   Calendar and TimeStamp should be prefered.
+class JavaMappingTimeStamp < JavaMapping
+  include Singleton
+  MATCHING_UML_NAME=["TimeStamp","Date"]
+  #MATCHING_JAVA_NAME=[]
+  def appliesTo?(datatype)
+    return true if MATCHING_UML_NAME.include?(datatype.uml_name_one)
+    #return true if MATCHING_JAVA_NAME.include?(datatype.java_qualifiedName)
+    return false
+  end
+  def getValidationRegexp
+    return nil
+  end
+  def getJavaType
+    return "java.util.Date"
+  end
+
+end
+
+#struts jsp template for a Calendar datatype.
+#A Calendar datatype is a calendar date, not including hours,minutes and seconds
+#A Calendar is not to be mistaken for a TimeStamp
+#NOTE:
+#   "Date" datatype name is not used because it is ambiguous.
+#   Calendar and TimeStamp are used instead
+class JavaMappingCalendar < JavaMapping
+  include Singleton
+  MATCHING_UML_NAME=["Calendar"]
+  #MATCHING_JAVA_NAME=[]
+  def appliesTo?(datatype)
+    return true if MATCHING_UML_NAME.include?(datatype.uml_name_one)
+    #return true if MATCHING_JAVA_NAME.include?(datatype.java_qualifiedName)
+    return false
+  end
+
+  def getValidationRegexp
+    return nil
+  end
+  def getJavaType
+    return "java.util.Date"
+  end
+
+end
+
+
+
+
+class JavaMappingGenericClass < JavaMapping
+  include Singleton
+  def appliesTo?(datatype)
+    return false if datatype.kind_of?(Muml_Enumeration)
+    return false if datatype.kind_of?(Muml_DataType)
+    #return true if datatype.kind_of?(Muml_Class)
+    return true
+  end
+
+  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 getJavaType
+    return "java.lang.Object"
+  end
+
+end
+
+class JavaMappingGenericEnum < JavaMapping
+  include Singleton
+  def appliesTo?(datatype)
+    return true if datatype.kind_of?(Muml_Enumeration)
+    return false
+  end
+
+
+  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 getJavaType
+    return "java.lang.Object"
+  end
+
+end
+
+
+class JavaMappingURL < JavaMappingText
+  include Singleton
+  MATCHING_UML_NAME=["URL","URI"]
+  #MATCHING_JAVA_NAME=[]
+  def appliesTo?(datatype)
+    return true if MATCHING_UML_NAME.include?(datatype.uml_name_one)
+    #return true if MATCHING_JAVA_NAME.include?(datatype.java_qualifiedName)
+    return false
+  end
+end
+
+class JavaMappingBLOB < JavaMapping
+  include Singleton
+  MATCHING_UML_NAME=["Blob"]
+  def appliesTo?(datatype)
+    return true if MATCHING_UML_NAME.include?(datatype.uml_name_one)
+    return false
+  end
+  def getJavaType
+    return "byte[]"
+  end
+end
+class JavaMappingIMG < JavaMappingBLOB
+  include Singleton
+  MATCHING_UML_NAME=["Img","Image"]
+  def appliesTo?(datatype)
+    return true if MATCHING_UML_NAME.include?(datatype.uml_name_one)
+    return false
+  end
+end
+
+class JavaMappingGRAPHVIZ < JavaMappingLargeText
+  include Singleton
+  MATCHING_UML_NAME=["Graphviz"]
+  def appliesTo?(datatype)
+    return true if MATCHING_UML_NAME.include?(datatype.uml_name_one)
+    return false
+  end
+end
+
+class JavaMappingPassword < JavaMappingText
+  include Singleton
+  MATCHING_UML_NAME=["Password"]
+  def appliesTo?(datatype)
+    return true if MATCHING_UML_NAME.include?(datatype.uml_name_one)
+    return false
+  end
+end
+
+class JavaMappingEmailAddress < JavaMappingText
+  include Singleton
+  MATCHING_UML_NAME=["EmailAdress"]
+  def appliesTo?(datatype)
+    return true if MATCHING_UML_NAME.include?(datatype.uml_name_one)
+    return false
+  end
+
+  # EMAIL address regexp
+  # cf : http://www.regular-expressions.info/email.html
+  def getValidationRegexp
+    return /[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,4}/
+  end
+end
+
+
+
+JavaMappingGenericEnum.instance #register
+
+JavaMappingCalendar.instance #register
+JavaMappingText.instance #register
+JavaMappingLargeText.instance #register
+JavaMappingPassword.instance #register
+JavaMappingEmailAddress.instance #register
+JavaMappingURL.instance #register
+JavaMappingFile.instance #register
+JavaMappingBoolean.instance #register
+JavaMappingTimeStamp.instance #register
+JavaMappingGenericClass.instance #register
+JavaMappingLong.instance #register
+JavaMappingLongObject.instance #register
+JavaMappingInteger.instance #register
+JavaMappingBLOB.instance #register
+JavaMappingIMG.instance #register
+JavaMappingGRAPHVIZ.instance #register
+JavaMappingMimeType.instance #register
+
+

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

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