ontomde-uml2 1.0.6 → 2.0.0

data/Manifest.txt

@@ -2,39 +2,55 @@ History.txt
 Manifest.txt
 README.txt
 Rakefile
+bin/ontomde-umlToProtege
 lib/ontomde-uml2.rb
-lib/ontomde-uml2/uml2.rdfs.nt.completion.rb
-lib/ontomde-uml2/version.rb
+lib/ontomde-uml2/UMLdatatypeMapping.rb
+lib/ontomde-uml2/autoImplement.rb
 lib/ontomde-uml2/cardinality.rb
 lib/ontomde-uml2/check.rb
-lib/ontomde-uml2/uml2.rdfs.nt
-lib/ontomde-uml2/dotDiagram.rb
-lib/ontomde-uml2/nt_old_to_nt_new.sh
+lib/ontomde-uml2/component.rb
 lib/ontomde-uml2/createAndAdd.rb
-lib/ontomde-uml2/enumerated.rb
-lib/ontomde-uml2/select.rb
-lib/ontomde-uml2/salvageErrors.rb
-lib/ontomde-uml2/multipleInheritance.rb
-lib/ontomde-uml2/uml2.rb
-lib/ontomde-uml2/owner.rb
-lib/ontomde-uml2/versionSignature.rb
 lib/ontomde-uml2/depencies.rb
+lib/ontomde-uml2/dotDiagram.rb
+lib/ontomde-uml2/enumerated.rb
 lib/ontomde-uml2/extension.rb
-lib/ontomde-uml2/umlx.rb
-lib/ontomde-uml2/autoImplement.rb
-lib/ontomde-uml2.rb
 lib/ontomde-uml2/helper.rb
+lib/ontomde-uml2/kb.rb
+lib/ontomde-uml2/kb/MYMODEL_kb.pprj
+lib/ontomde-uml2/kb/MYMODEL_kb.rdf
+lib/ontomde-uml2/kb/MYMODEL_kb.rdfs
+lib/ontomde-uml2/kb/MYMODEL_meta.pprj
+lib/ontomde-uml2/kb/command.rb
+lib/ontomde-uml2/kb/datatypeMapping.rb
+lib/ontomde-uml2/kb/protege.rb
+lib/ontomde-uml2/multipleInheritance.rb
+lib/ontomde-uml2/nt_old_to_nt_new.sh
+lib/ontomde-uml2/owner.rb
+lib/ontomde-uml2/salvageErrors.rb
+lib/ontomde-uml2/select.rb
 lib/ontomde-uml2/shortcut.rb
+lib/ontomde-uml2/uml2.pprj
+lib/ontomde-uml2/uml2.rb
+lib/ontomde-uml2/uml2.rdf
+lib/ontomde-uml2/uml2.rdfs
+lib/ontomde-uml2/uml2.rdfs.nt
+lib/ontomde-uml2/uml2.rdfs.nt.completion.rb
+lib/ontomde-uml2/umlx.rb
+lib/ontomde-uml2/version.rb
+lib/ontomde-uml2/versionSignature.rb
+lib/ontomde-uml2/xsd.pprj
+lib/ontomde-uml2/xsd.rdf
+lib/ontomde-uml2/xsd.rdfs
+test/_test_dot.rb
 test/_test_perf.rb
-test/test_misc.rb
-test/test_base.rb
-test/test_ontomde-uml2.rb
+test/model/.project
 test/model/SID.emx
 test/model/SID.emx.nt
-test/model/simple2WithProfile.emx
-test/model/simple2.emx
 test/model/SID.uml2
-test/model/.project
+test/model/simple2.emx
 test/model/simple2.emx.nt
+test/model/simple2WithProfile.emx
+test/test_base.rb
 test/test_clone.rb
-test/_test_dot.rb
+test/test_misc.rb
+test/test_ontomde-uml2.rb

data/README.txt

@@ -5,7 +5,9 @@ ontomde-uml2
 == DESCRIPTION:
 
 ontoMDE-uml2 contains UML2 meta-model and helper files to manipulate a UML2 model.   
-ontoMDE-uml2 uses ontoMDA-core which provides core fonctionalities for loading a model in RDF/RDFS format. ontoMDE-UML2 is used by ontoMDE-java which contains rules for generating java Code.
+ontoMDE-uml2 uses ontoMDE-core which provides core fonctionalities for loading a model in RDF/RDFS format. ontoMDE-UML2 is used by ontoMDE-java which contains rules for generating java Code.
+
+ontoMDE contains primitives for converting a UML2 model into a Prot�g� 2000 RDF/RDFS model. UML2 classes are converted into RDFS classes to allow data instances to be created. This feature is used heavily for providing editors for creating tests data for programs.
 
 == FEATURES/PROBLEMS:
   
@@ -16,6 +18,21 @@ ontoMDE-uml2 uses ontoMDA-core which provides core fonctionalities for loading a
 * UML model manipulations helpers (add interface implementations, transform multiple inheritance into single inheritance, ...)
 
 
+UML2 to Protege 2000 features:
+* single and incremental use.
+* transparent update of name changes from source to target mode.
+* class 
+* abstract class
+* interface
+* enumerated types
+* generalization links
+* implementation links
+* property, association, composition and aggregation
+* single and multivalued properties
+* mandatory fields (cardinaly=0 or >0)
+* UML documentation notes export to Protege 2000 for easy reference. 
+
+
 == SYNOPSIS:
 
   require 'ontomde-uml2'
@@ -48,7 +65,9 @@ ontoMDE-uml2 uses ontoMDA-core which provides core fonctionalities for loading a
 
 == REQUIREMENTS:
 
-* requires ontomde-core
+* ontomde-core gem
+* ontomde-redland-win gem under windows. (REDLAND library is used to convert from Prot�g� 2000 RDF/XML and ontoMDE RDF/ntriples formats. ontoMDE is bundled with REDLAND for windows. 
+* redland rapper binary command installed and available in for path for Linux.
 
 == INSTALL:
 

data/Rakefile

@@ -6,7 +6,7 @@ require './lib/ontomde-uml2/version.rb'
 
 OntomdeHoe.new('ontomde-uml2', Ontomde::Uml2::VERSION) do |p|
   p.rubyforge_name = 'ontomde'
-  p.author = 'Stephane (Pierre) Carrie'
+  p.author = 'Orange-labs BIZZ/CIL/SAM'
   p.email = 'stephanepierre.carrie -nospam- @orange-ftgroup.com'
   p.summary = 'OntoMDE UML2 handling cartridge'
   p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")

data/bin/ontomde-umlToProtege

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'ontomde-uml2/kb'
+require 'ontomde-uml2/kb/command.rb'

data/lib/ontomde-uml2.rb

@@ -10,22 +10,24 @@ require "#{__FILE__[0..-4]}/version.rb"
 
 UML2_RDFS_NT_FILE="#{here}/uml2.rdfs.nt"
 require 'ontomde-core'
-require "#{here}/extension.rb"
-require "#{here}/enumerated.rb"
-require "#{here}/umlx.rb"
-require "#{here}/cardinality.rb"
-require "#{here}/uml2.rb"
-require "#{here}/dotDiagram.rb"
-require "#{here}/createAndAdd.rb"
-require "#{here}/autoImplement.rb"
-require "#{here}/owner.rb"
-require "#{here}/select.rb"
-require "#{here}/depencies.rb"
-require "#{here}/multipleInheritance.rb"
-require "#{here}/salvageErrors.rb"
-require "#{here}/check.rb"
-require "#{here}/versionSignature.rb"
-require "#{here}/helper.rb"
-require "#{here}/shortcut.rb"
+require 'ontomde-uml2/extension.rb'
+require 'ontomde-uml2/enumerated.rb'
+require 'ontomde-uml2/umlx.rb'
+require 'ontomde-uml2/cardinality.rb'
+require 'ontomde-uml2/uml2.rb'
+require 'ontomde-uml2/dotDiagram.rb'
+require 'ontomde-uml2/createAndAdd.rb'
+require 'ontomde-uml2/autoImplement.rb'
+require 'ontomde-uml2/owner.rb'
+require 'ontomde-uml2/select.rb'
+require 'ontomde-uml2/depencies.rb'
+require 'ontomde-uml2/multipleInheritance.rb'
+require 'ontomde-uml2/salvageErrors.rb'
+require 'ontomde-uml2/check.rb'
+require 'ontomde-uml2/versionSignature.rb'
+require 'ontomde-uml2/helper.rb'
+require 'ontomde-uml2/shortcut.rb'
+require 'ontomde-uml2/UMLdatatypeMapping.rb'
+require 'ontomde-uml2/component.rb'
 
 

data/lib/ontomde-uml2/UMLdatatypeMapping.rb

@@ -0,0 +1,441 @@
+#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 DatatypeMapping#{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
+	DatatypeMapping#{rubyName}.class_eval( &block ) unless block.nil?
+
+	DatatypeMapping#{rubyName}.instance #register
+  }
+  t=eval s
+  puts "Added datatype '#{umlDataTypeName}'"
+end
+
+class DatatypeMapping
+  include Singleton
+  def getMappings
+    return @@types
+  end
+  @@types=Array.new
+  def initialize
+    return if self.class==DatatypeMapping
+    @@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 getMapping(datatype)
+    @@types.each {|t|
+      next unless t.appliesTo?(datatype)
+      return t
+    }
+    if !datatype.context[:silentlyForceUnknownDatatypeToString,false]
+      msg= <<END
+      
+ERROR: OntoMDE generator encountered in your UML model
+ERROR:    an unknown datatype named "#{datatype}".
+HELP: 
+HELP: OntoMDE should be provided a datatype mapping 
+HELP:    definition in order to map your custom datatype
+HELP:    to target code (java conversion, jsp code,
+HELP:    ..., validation code, ...)
+HELP: This mapping definition should be placed in a
+HELP:    file that is loaded by your ontomde generation script.
+HELP:    (ontomde-java script uses --load option 
+HELP:     to load configuration files)
+HELP: 
+HELP: Sample1: 
+HELP:    restriction of DatatypeMappingText for string mapping 
+HELP:    a particular regexp:
+HELP:    addDataTypeMapping("#{datatype}",
+HELP:        DatatypeMappingText, 
+HELP:        /[a-zA-Z][a-zA-Z][a-zA-Z][a-zA-Z][0-9][0-9][0-9][0-9]/ )
+HELP: 
+HELP: Sample2:
+HELP:    restriction of DatatypeMappingText for string mapping a particular regexp.
+HELP:    addDataTypeMapping("#{datatype}",
+HELP:        DatatypeMappingText, 
+HELP:        /[a-zA-Z][a-zA-Z][a-zA-Z][a-zA-Z][0-9][0-9][0-9][0-9]/ ) {
+HELP:            # a datatype mapping definition is a set 
+HELP:            #   of method called by generator.
+HELP:            # Any method may be redefined :
+HELP:            def java_getType
+HELP:              return "java.lang.String"
+HELP:            end
+HELP:            #def getFormCopyTo(field)   
+HELP:              # (...)
+HELP:            #end
+HELP:            #def getFormInitFrom(field)
+HELP:              # (...)
+HELP:            #end
+HELP:        }
+HELP: 
+HELP: Available datatypes mapping in current running instance are:
+#{@@types.collect {|t| "HELP:    "+"#{t.class} : #{t.getHelp} \n"}}.
+
+
+End of help on adding custom datatype mapping definition.
+END
+      log.error msg unless log_already_displayed?(msg)
+    end
+       
+    return DatatypeMappingText.instance
+    #return DatatypeMappingerror.instance
+  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
+  
+  #return a help message on this datatype mapping definition.
+  def getHelp
+    return "No help available for datatype mapping #{self.class}"
+  end
+end
+class DatatypeMappingText < DatatypeMapping
+  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 getHelp
+    return "any string of any length and any content displayable on one line."
+  end
+end
+
+class DatatypeMappingLargeText < DatatypeMappingText
+  include Singleton
+  HELPMSG=" "
+  MATCHING_UML_NAME=["LargeText"]
+  def appliesTo?(datatype)
+    return true if MATCHING_UML_NAME.include?(datatype.uml_name_one)
+    return false
+  end
+  
+  def getHelp
+    return "any string of any length and any content displayable on many line"
+  end
+end
+
+
+class DatatypeMappingMimeType < DatatypeMappingText
+  include Singleton
+  MATCHING_UML_NAME=["MimeType"]
+  def appliesTo?(datatype)
+    return true if MATCHING_UML_NAME.include?(datatype.uml_name_one)
+  end
+   
+  def getHelp
+    return "string defining a mime type"
+  end
+end
+
+class DatatypeMappingOrdinal < DatatypeMappingText
+  include Singleton
+  
+  def getHelp
+    return "any ordinal type (this in an abstract mapping meant to be derived)"
+  end
+end
+
+class DatatypeMappingInteger < DatatypeMappingOrdinal
+  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 getHelp
+    return "any valid integer"
+  end
+
+end
+class DatatypeMappingLong < DatatypeMappingOrdinal
+  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 getHelp
+    return "any valid long"
+  end
+end
+class DatatypeMappingLongObject < DatatypeMappingOrdinal
+  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 getHelp
+    return "any valid long value or null"
+  end
+  
+end
+class DatatypeMappingFile < DatatypeMapping
+  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 getHelp
+    super 
+  end
+end
+
+class DatatypeMappingBoolean < DatatypeMapping
+  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
+
+  def getHelp
+    return "boolean true or false"
+  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 DatatypeMappingTimeStamp < DatatypeMapping
+  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 getHelp
+    return "An absolute precise moment in time (independent of timezone)"
+  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 DatatypeMappingCalendar < DatatypeMapping
+  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 getHelp
+    return "a day "
+  end
+  
+end
+
+
+
+
+class DatatypeMappingGenericClass < DatatypeMapping
+  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 getHelp
+    return "Any object reference"
+  end
+  
+end
+
+class DatatypeMappingGenericEnum < DatatypeMapping
+  include Singleton
+  def appliesTo?(datatype)
+    return true if datatype.kind_of?(Muml_Enumeration)
+    return false
+  end
+  
+  def getHelp
+    return "Any enumerated value"
+  end
+
+end
+
+
+class DatatypeMappingURL < DatatypeMappingText
+  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
+  
+  def getHelp
+    return "Any URL"
+  end
+end
+
+class DatatypeMappingBLOB < DatatypeMapping
+  include Singleton
+  MATCHING_UML_NAME=["Blob"]
+  def appliesTo?(datatype)
+    return true if MATCHING_UML_NAME.include?(datatype.uml_name_one)
+    return false
+  end
+  def getHelp
+    return "Any BLOB"
+  end
+end
+class DatatypeMappingIMG < DatatypeMappingBLOB
+  include Singleton
+  MATCHING_UML_NAME=["Img","Image"]
+  def appliesTo?(datatype)
+    return true if MATCHING_UML_NAME.include?(datatype.uml_name_one)
+    return false
+  end
+  def getHelp
+    return "Any image"
+  end
+end
+
+class DatatypeMappingGRAPHVIZ < DatatypeMappingLargeText
+  include Singleton
+  MATCHING_UML_NAME=["Graphviz"]
+  def appliesTo?(datatype)
+    return true if MATCHING_UML_NAME.include?(datatype.uml_name_one)
+    return false
+  end
+  def getHelp
+    return "Any graphivz dot file"
+  end
+end
+
+class DatatypeMappingPassword < DatatypeMappingText
+  include Singleton
+  MATCHING_UML_NAME=["Password"]
+  def appliesTo?(datatype)
+    return true if MATCHING_UML_NAME.include?(datatype.uml_name_one)
+    return false
+  end
+  
+  def getHelp
+    return "any String of any length meant to be used as passowrd"
+  end
+end
+
+class DatatypeMappingEmailAddress < DatatypeMappingText
+  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
+  
+  def getHelp
+    return "any e-mail address"
+  end
+end
+
+
+
+DatatypeMappingGenericEnum.instance #register
+
+DatatypeMappingCalendar.instance #register
+DatatypeMappingText.instance #register
+DatatypeMappingLargeText.instance #register
+DatatypeMappingPassword.instance #register
+DatatypeMappingEmailAddress.instance #register
+DatatypeMappingURL.instance #register
+DatatypeMappingFile.instance #register
+DatatypeMappingBoolean.instance #register
+DatatypeMappingTimeStamp.instance #register
+DatatypeMappingGenericClass.instance #register
+DatatypeMappingLong.instance #register
+DatatypeMappingLongObject.instance #register
+DatatypeMappingInteger.instance #register
+DatatypeMappingBLOB.instance #register
+DatatypeMappingIMG.instance #register
+DatatypeMappingGRAPHVIZ.instance #register
+DatatypeMappingMimeType.instance #register
+
+