ontomde-java 2.0.0

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

@@ -0,0 +1,347 @@
+
+module Muml_Property
+  #do not generate property accessors if true
+  rdf_safe_attr_reader_many :java_noAccessors
+  rdf_safe_attr_reader_many :java_isSuggester
+  
+  #do not generate a suggester for this element
+  rdf_safe_attr_reader_many :java_noSuggester
+  
+  rdf_safe_attr_reader_many :java_createAndAddSuggester
+end
+
+module Muml_Classifier
+  # Performs a model transformation to add
+  # * attribute getter
+  # * attribute setter
+  # * attribute remover
+  # * attribute appender
+  # * attribute suggester
+  # 
+  #NOTE:
+  #* java_transform! is skipped if context[:java_transform] is false (default=true)
+  def java_transform!
+    uml_ownedAttribute.each { |oa|
+      java_addAccessorsFor!(oa)
+    }
+  end
+        
+  #Adds accessors when needed for UML properties.
+  #
+  #Reference: #java_transform!
+  def java_addAccessors!
+    java_transform!
+  end
+
+  # Adds accessors for uml property oa passed as parameter.
+  #
+  #Reference:
+  # * java_addGlobalGetter!
+  # * java_addGlobalSetter!
+  # * java_addQualifiedPutter!
+  # * java_addQualifiedGetter!
+  # * java_addAppender!
+  # * java_addCreateAndAppender!
+  # * java_addWithIndexAppender!
+  # * java_addAppenderQualifier!
+  # * java_addRemover!
+  # * java_addSuggester!
+  # * java_addSuggesterType!
+  # * java_addCreater!
+  def java_addAccessorsFor!(oa)
+    #log.debug { "-------java.transform:Accessor for #{self.uml_name}.#{oa.uml_name}" }
+    return unless context[:java_transform,true]
+    return if oa.java_noAccessors?
+
+    oa.uml_visibility=Cuml_VisibilityKind::Private
+
+    #prevent multiple accessor addition.
+    #useful when a transformation has manually launch
+    #java_addAccessorFor! (ex: to set a custom getter code)
+    return unless oa.java_getter_property_inv.empty?
+    java_addGlobalGetter!(oa)
+    java_addGlobalSetter!(oa)
+    java_addQualifiedPutter!(oa)
+    java_addQualifiedGetter!(oa)
+    java_addAppender!(oa)
+    java_addCreateAndAppender!(oa)
+    java_addWithIndexAppender!(oa)
+    java_addAppenderQualifier!(oa)
+    java_addRemover!(oa)
+    java_addSuggester!(oa)
+    java_addSuggesterType!(oa)
+    java_addCreater!(oa)
+  end
+end
+
+
+module Muml_Classifier
+  
+  # Helper method for creating an accessor method related to a property.
+  def java_createAndAddMethodFromProperty(oa,mName,withQualifier,uri_suffix="")
+    m=umlx_createAndAddOperation(oa.rdf_uri+"_#{mName}"+uri_suffix)
+    m.uml_name="#{mName}#{oa.java_NameBean}"
+    m.uml_class=self
+    m.uml_visibility=Cuml_VisibilityKind::Public
+    m.uml_isStatic=oa.uml_isStatic
+    m.java_use_Arrays=oa.java_use_Arrays
+
+    if withQualifier
+      oa.uml_qualifier.each { |qual|
+        ip_qual=m.umlx_createAndAddParameter(m.rdf_uri+qual.rdf_uri)
+        ip_qual.java_use_Arrays=oa.java_use_Arrays
+        qual.umlx_copyToAttributeProperty(ip_qual)
+        ip_qual.uml_name=qual.uml_name
+        ip_qual.uml_direction=Cuml_ParameterDirectionKind::In
+      }
+      oe=oa.umlx_otherEnd
+      if((!oe.nil?) && oe.umlx_isNavigable?)
+        oe.uml_qualifier.each { |qual|
+          ip_qual=m.umlx_createAndAddParameter(m.rdf_uri+qual.rdf_uri)
+          ip_qual.java_use_Arrays=oa.java_use_Arrays
+          qual.umlx_copyToAttributeProperty(ip_qual)
+          ip_qual.uml_name=qual.uml_name
+          ip_qual.uml_direction=Cuml_ParameterDirectionKind::In
+        }
+      end
+    end
+    return m
+  end
+
+  # returns a string containing the name of getter parameter relative to a uml parameter.
+  def getterParameterName(oa)
+    return "i#{oa.java_NameProperty}"
+
+  end
+
+  # Adds a putter for parameter oa using a model transformation. (manages addition to a hastable):
+  #
+  #NOTE:
+  # * This code is generated when a *qualifier* is defined in model.
+  # * Languages do not not handled multiple key Hastable.
+  # * A new operation is puttered to the UML model. The operation then generated using standard operation generator.
+  # * operation is only generated for multi-valued property
+  # 
+  #WARNING: 
+  # * bi-directional cannot be handled with qualifier because association key is not known.
+  # * a TODO note is added in the code in case model is bi-directional so developper knows something has to be done.
+  #
+  #EXAMPLE 1: (uml_upperValue==1)
+  #  Class3 putRoleClass3(String key) {
+  #  ...
+  #  }
+  #
+  #EXAMPLE 2 (uml_upperValue==*):
+  #  Set<Class3> putRoleClass3(String key) {
+  #  ...
+  #  }
+  def java_addQualifiedPutter!(oa)
+    return unless context[:java_addQualifiedPutter,true]
+    return if oa.uml_qualifier.empty?
+    return unless !oa.uml_isDerived?
+
+    putter=java_createAndAddMethodFromProperty(oa,"put",true,'_qual')
+    ip=putter.umlx_createAndAddParameter(putter.rdf_uri+"_in")
+    ip.java_use_Arrays=oa.java_use_Arrays
+    oa.umlx_copyToAttributeProperty(ip)
+    ip.uml_name=getterParameterName(oa)
+    ip.uml_direction=Cuml_ParameterDirectionKind::In
+    oe=oa.umlx_otherEnd
+    putter.java_code= mtk_stss { java_writeQualifiedPutterBody(oa) }
+    return putter
+  end
+
+  # Adds a suggester for parameter oa using a model transformation.
+  #
+  #NOTE:
+  # * A new operation is added to the UML model. The operation then generated using standard operation generator.
+  # * A suggester returns a set of possible value for the parameter.
+  # * Suggester is not generated for datatypes (string, int, ...)
+  # * A default suggester is generated for enum that return every enum values
+  # * A default non functional suggester is generated for objects.
+  def java_addSuggester!(oa)
+    return if oa.java_isSuggester?
+    return if oa.java_noSuggester?
+    return if oa.uml_isReadOnly?
+    #log.debug { "add suggester (#{oa}) self=#{self}" }
+    return unless context[:java_addSuggester,true]
+    return if oa.uml_type_one.kind_of?(Muml_DataType) && !oa.uml_type_one.kind_of?(Muml_Enumeration)
+
+    #sug=umlx_createAndAddProperty("#{oa.rdf_uri}_sugP","#{oa.uml_name}Sug2")
+    #sug2.uml_type=oa.uml_type
+    #sug2.uml_upperValue=umlx_literal(-1)
+    #sug2.uml_lowerValue=umlx_literal(0)
+    #sug2.uml_isOrdered=RDF_TRUE
+    #sug2.uml_isDerived=RDF_TRUE
+    #sug2.java_isSuggester=RDF_TRUE
+
+
+    sug=java_createAndAddMethodFromProperty(oa,"sug",false)
+    #suggester is a defined as a bean property so it can be used with tools such as struts.
+    sug.uml_name="get#{oa.java_NameBean}Sug"
+    #java_createAndAddMethodParameterFromProperty(oa,true)
+
+    rp=sug.umlx_createAndAddParameter(sug.rdf_uri+"_p1")
+    #rp.java_use_Arrays=oa.java_use_Arrays
+    oa.umlx_copyToAttributeProperty(rp)
+    rp.uml_name="return"
+    rp.uml_direction=Cuml_ParameterDirectionKind::Return
+    rp.uml_upperValue=umlx_literal(-1)
+    rp.uml_lowerValue=umlx_literal(0)
+    rp.uml_isOrdered=RDF_TRUE
+
+    if(oa.uml_type_one.kind_of?(Muml_Enumeration))
+      sug.java_code=mtk_stss{ java_writeSuggesterBodyEnum(oa) }
+    else
+      sug.java_code=mtk_stss{ java_writeSuggesterBody(oa) }
+    end
+    return sug
+  end
+
+  # adds a suggester for creator.
+  # Returns an enum of possible types.
+  #
+  #Reference:
+  # * #java_writeSuggesterTypeBodyEnum
+  # * #java_createAndAddMethodFromProperty
+  # * #umlx_createAndAddParameter
+  def java_addSuggesterType!(oa)
+    #log.debug { "add suggester (#{oa}) self=#{self}" }
+    return if oa.uml_isReadOnly?
+    return unless context[:withEnumAssignable]
+    return unless context[:java_addSuggester,true]
+    return if oa.uml_type_one.kind_of?(Muml_DataType) && !oa.uml_type_one.kind_of?(Muml_Enumeration)
+    return unless oa.umlx_isComposite?
+    sug=java_createAndAddMethodFromProperty(oa,"createAndAddSug",false)
+    #suggester is a defined as a bean property so it can be used with tools such as struts.
+    sug.uml_name="getCreateAndAdd#{oa.java_NameBean}Sug"
+    rp=sug.umlx_createAndAddParameter(sug.rdf_uri+"_p1")
+    #rp.java_use_Arrays=oa.java_use_Arrays
+    oa.umlx_copyToAttributeProperty(rp)
+    rp.uml_type=oa.uml_type_one.java_enumAssignableDataType
+    rp.uml_name="return"
+    rp.uml_direction=Cuml_ParameterDirectionKind::Return
+    rp.uml_upperValue=umlx_literal(-1)
+    rp.uml_lowerValue=umlx_literal(0)
+    rp.uml_isOrdered=RDF_TRUE
+
+    isCreateAndAdd=true
+    sug.java_code=mtk_stss{ java_writeSuggesterTypeBodyEnum(oa,isCreateAndAdd) }
+    oa.java_createAndAddSuggester=sug
+    return sug
+  end
+
+  # Adds a getter for parameter oa using a model transformation.
+  #
+  #NOTE:
+  # * A new operation is added to the UML model. The operation then generated using standard operation generator.
+  # * If property is part of a *bidirectional* association, code is generated to update automaticaly the other side of the association.
+  # * If property is multivalued, the operation returns a set.
+  def java_addGlobalGetter!(oa)
+    return unless context[:java_addGlobalGetter,true]
+    #return if oa.uml_isDerived?
+    #return unless oa.uml_isReadOnly?
+    return unless oa.java_AttributeGlobalGetter.empty?
+    get=java_createAndAddMethodFromProperty(oa,"get",false)
+    get.java_getter_property=oa
+    oa.java_AttributeGlobalGetter=get
+
+    rp=get.umlx_createAndAddParameter(get.rdf_uri+"_p1")
+    rp.java_use_Arrays=oa.java_use_Arrays
+    oa.umlx_copyToAttributeProperty(rp)
+    rp.uml_name="return"
+    rp.uml_direction=Cuml_ParameterDirectionKind::Return
+    rp.uml_qualifier=oa.uml_qualifier
+    get.java_code=mtk_stss {java_writeGlobalGetterBody(oa) }
+    return get
+  end
+
+  # Adds a setter for parameter oa using a model transformation.
+  #
+  #NOTE:
+  # * A new operation is added to the UML model. The operation then generated using standard operation generator.
+  # * If property is part of a *bidirectional* association, code is generated to update automaticaly the other side of the association.
+  # * If property is multivalued, the operation takes a set as an argument. For single value access use appender and remover.
+  #
+  #Reference:
+  # * #java_writeGlobalSetterBody
+  def java_addGlobalSetter!(oa)
+    return unless context[:java_addGlobalSetter,true]
+    return unless oa.java_AttributeGlobalSetter.empty?
+    # a setter is generated for derived attribute as it may be implemented.
+    #return unless !oa.uml_isDerived?
+    set=java_createAndAddMethodFromProperty(oa,"set",false)
+    set.java_setter_property=oa
+    oa.java_AttributeGlobalSetter=set
+
+    ip=set.umlx_createAndAddParameter(set.rdf_uri+"_in")
+    ip.java_use_Arrays=oa.java_use_Arrays
+    oa.umlx_copyToAttributeProperty(ip)
+    ip.uml_name=getterParameterName(oa)
+    ip.uml_direction=Cuml_ParameterDirectionKind::In
+    ip.uml_qualifier=oa.uml_qualifier
+    oe=oa.umlx_otherEnd
+    set.java_code=mtk_stss{java_writeGlobalSetterBody(oa)}
+    return set
+  end
+
+  # adds a qualified getter for uml property oa.
+  #
+  #Reference:
+  # * #java_writeQualifiedGetterBody
+  def java_addQualifiedGetter!(oa)
+    return unless context[:java_addQualifiedGetter,true]
+    return if oa.uml_qualifier.empty?
+    return unless !oa.uml_isDerived?
+
+    getter=java_createAndAddMethodFromProperty(oa,"get",true,'_qual')
+
+    rp=getter.umlx_createAndAddParameter(getter.rdf_uri+"_p1")
+    rp.java_use_Arrays=oa.java_use_Arrays
+    oa.umlx_copyToAttributeProperty(rp)
+    rp.uml_name="return"
+    rp.uml_direction=Cuml_ParameterDirectionKind::Return
+
+    getter.java_code=mtk_stss{java_writeQualifiedGetterBody(oa)}
+    return getter
+  end
+
+  # adds a indexed appender method for uml property oa.
+  #
+  #Example:
+  # * void addYourProperty( keyType key, valueObject)
+  # 
+  #Reference:
+  # * #java_addWithIndexAppenderBody
+  def java_addWithIndexAppender!(oa)
+    return unless context[:java_addAppender,true]
+    return if oa.umlx_upperValueIsOne?
+    #return unless oa.uml_qualifier.empty?
+    return unless oa.uml_isOrdered?
+    return if oa.java_isSuggester?
+    return if oa.uml_isReadOnly?
+    #return if oa.umlx_isComposite?
+    add=java_createAndAddMethodFromProperty(oa,"add",true,"wi")
+
+    ip2=Cuml_Parameter.new(rdf_Repository,add.rdf_uri+"_in")
+    ip2.uml_name="_index"
+    ip2.uml_direction=Cuml_ParameterDirectionKind::In
+    ip2.uml_upperValue=umlx_literal(1);
+    ip2.uml_lowerValue=umlx_literal(1);
+    ip2.uml_type=umlx_dataType_integer
+    add.uml_ownedParameter_add(ip2)
+    oe=oa.umlx_otherEnd
+
+    ip=Cuml_Parameter.new(rdf_Repository,add.rdf_uri+"_in")
+    ip.uml_name=getterParameterName(oa)
+    ip.uml_direction=Cuml_ParameterDirectionKind::In
+    ip.uml_upperValue=umlx_literal(1);
+    ip.uml_lowerValue=umlx_literal(1);
+    ip.uml_type=oa.uml_type
+    add.uml_ownedParameter_add(ip)
+
+    add.java_code = mtk_stss{java_addWithIndexAppenderBody(oa,oe,ip,ip2)}
+    return add
+  end
+end
+

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

@@ -0,0 +1,88 @@
+
+module Muml_Element
+  JAVA_ANNO_ONTOMDE_QNAME="xmda.annotationOntoMDE.OntoMDE"
+end
+
+
+module Mrdf_Repository
+
+  def java_addJavaAnnotationOntoMDE!
+    uml_Class_all.each {|c|
+      c.java_getJavaAnnotationOntoMDE
+    }
+  end
+end
+
+
+
+module Muml_Classifier
+        
+  def java_getJavaAnnotationOntoMDE
+    anno=umlx_getOrCreateClass(JAVA_ANNO_ONTOMDE_QNAME)
+    if(anno.java_customCode.empty?)
+      anno.umlx_createAndAddComment(anno.rdf_uri+"comment", %{
+ Annotation used to specify which code sections should be overridden or preserved by OntoMDE MDA code generator.<p/>
+ <p/>For example, &nbsp;@OntoMDE(reverse = { imports,javadoc } , uri="..." ) tells OntoMDE to preserve import and javadoc sections. Sections <b>not</b> listed in reverse list are <b>overwritten</b> by generator. 
+ <p/>Annotation may be used on class,interface, enum inner-class, methods and attributes.
+ <p/>Reverse zones types are: <b>imports</b> for class imports, <b>javadoc</b>, <b>annotations</b> and <b>code</b> for function code body.
+ <p/>Please note that uri contains a unique key used by generator to identify the element that should never be modified.
+ })
+      anno.umlx_external=RDF_FALSE
+      anno.uml_appliedStereotype_add(anno.umlx_getOrCreateStereotype("JavaAnnotation"))
+      anno.java_customCode= <<ENDCODE
+	public enum ZoneCode {
+		/*
+		 * This annotation is used to instruct ontoMDE code generator that none
+		 * of the section related to this code construct must be preserve.
+		 */
+		nothing,
+		/*
+		 * This annotation is used to instruct ontoMDE code generator to
+		 * preserve the import section related to this code construct, instead
+		 * of overwriting it.
+		 */
+		imports,
+		/*
+		 * This annotation is used to instruct ontoMDE code generator to
+		 * preserve the javadoc section related to this code construct, instead
+		 * of overwriting it
+		 */
+		javadoc,
+		/*
+		 * This annotation is used to instruct ontoMDE code generator to
+		 * preserve the annotation section related to this code construct,
+		 * instead of overwriting it
+		 */
+		annotations,
+		/*
+		 * This annotation is used to instruct ontoMDE code generator to
+		 * preserve the annotation section related to all the parameter of 
+		 * this code construct, instead of overwriting it.
+		 */
+		anno_param,
+		/*
+		 * This annotation is used to instruct ontoMDE code generator to
+		 * preserve the code body section related to this code construct,
+		 * instead of overwriting it
+		 */
+		code
+	}
+
+	/*
+	 * List of code section type that ontoMDE code will preserve on next
+	 * generation. If empty, no element will be preserved. In other word, if
+	 * empty, every element will be overwritten.
+	 */
+	ZoneCode[] reverse();
+
+	/*
+	 * URI used to identify uniquely model element related to this java
+	 * construct.
+	 */
+	String uri();
+ENDCODE
+
+    end
+    return anno;
+  end
+end

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

@@ -0,0 +1,34 @@
+
+module Muml_Class
+	def apaCom_addLogger!
+		log=umlx_createAndAddProperty(rdf_uri+"log","log");
+		log.java_noAccessors=RDF_TRUE
+		log.uml_isStatic=RDF_TRUE
+		#log.jpa_transient=RDF_TRUE
+		log.db_isTransient=RDF_TRUE
+		log.java_isTransient=RDF_TRUE
+		log.uml_type=umlx_getOrCreateClass("org.apache.commons.logging.Log");
+		log.uml_type_one.db_isTransient=RDF_TRUE
+
+		#log.java_code="org.apache.commons.logging.LogFactory.getFactory().getInstance(this.getClass().getName())"
+		log.java_code=%{org.apache.commons.logging.LogFactory.getFactory().getInstance("#{java_qualifiedName}")}
+
+
+	end
+end
+
+module Muml_Element
+	def java_warn(msg)
+		return "if(log.isWarnEnabled()){log.warn(#{msg});}"
+	end
+	def java_debug(msg)
+		return "if(log.isDebugEnabled()){log.debug(#{msg});}"
+	end
+	def java_error(msg)
+		return "if(log.isErrorEnabled()){log.error(#{msg});}"
+	end
+	def java_info(msg)
+		return "if(log.isInfoEnabled()){log.info(#{msg});}"
+	end
+end
+