ontomde-core 1.0.2 → 1.0.4

data/History.txt

@@ -1,5 +1,10 @@
-== 1.0.0 / 2007-10-27
-
-* 1 major enhancement
-  * Birthday!
-
+
+== / 2007-12-27
+* added rdfs range handling. 
+* rdf attribute type is now check on assignement. 
+
+== 1.0.0 / 2007-10-27
+
+* 1 major enhancement
+  * First public release 
+

data/Manifest.txt

@@ -1,12 +1,11 @@
 History.txt
 Manifest.txt
 README.txt
+Manual.txt
 Rakefile
-bin/ontomde-core
 lib/ontomde-core.rb
 lib/ontomde-core/version.rb
 lib/ontomde-core/context.rb
-lib/ontomde-core/loader.rb
 lib/ontomde-core/bootstrap_rdfs.rb
 lib/ontomde-core/delayed.rb
 lib/ontomde-core/profil.rb

data/Manual.txt

@@ -0,0 +1,88 @@
+== ontoMDE-core stand-alone usage
+
+basic usage of ontoMDE implies the following steps:
+* create or use an existing ontology (a RDF model)
+* create methods an ruby classes to do whatever you want (generate Java/C++ code, transform your model, whatever).
+* load the ontology model into Ruby
+* load an ontology instance (data) into ruby
+ 
+
+== RDFS class loading 
+When invoking loadMetaModelFromFile, ontoMDE does the following things:
+* Create a class for every RDFS class prefixed by C 
+  (ex: RDFS class with uri uml:DataType produces a ruby class Cuml_DataType)
+* Create a module for every RDFS class prefixed by M
+  (ex: RDFS class with uri uml:DataType produces a ruby module Muml_DataType)
+* Map RDFS generalization into module imports
+  (ex: ruby class Cuml_DataType includes module Muml_DataType and Muml_NamedElement because RDFS class with uri uml:DataType inherits from uml:NamedElement)
+* Creates Ruby property in module class for every RDF property
+  (ex: Muml_NamedElement has a uml_name property)
+
+Note:examples are taken from UML MetaModel included in ontomde-uml library
+
+== Property accessors
+ontoMDE offers several accessor methods for accessing a property. Accessors name derive from property name. If a property name is for example, uml_name, accessors will be uml_name, uml_name_one, uml_name_one0, ...  
+
+=== <prop>
+ returns a list of elements.
+ example: uml_name, uml_ownedElement
+
+=== <prop>_one
+ returns  <prop> first element.
+ Fails if <prop> list does not contain exactly one element.
+ example: uml_name_one
+
+=== <prop>_one0
+ returns <prop> first element or nil if <prop> list is empty
+ Fails if uml_name list contains more than one element.
+ example: uml_name_one0
+
+=== <prop>?
+ returns true or false
+ Because RDF stores string literal "true" or "false" this method must be used instead of <prop>_one if a boolean value is expected. 
+ example: uml_isOrdered? , uml_isAbstract?
+
+=== <prop>_inv
+ returns elements 
+ important note: <prop>_inv is *not* ordered. 
+ example: uml_ownedElement_inv?
+
+=== <prop>_inv_one
+ returns first and only element in <prop>_inv.
+ Throws an exception if <prop>_inv does not contain exactly one element.
+ example:
+
+=== <prop>_inv_one0
+ returns first and only element in <prop>_inv, null if empty.
+ Throws an exception if <prop>_inv contains more than one element.
+ example:
+
+
+==Code generator facilities
+
+ ontoMDE-core provides facilities for writing into a file without carrying around file descriptors. A write method is defined on every ontoMDE-core model object that can be used anywhere in code, as long as it is called from inside a writeSession.
+
+ mtk_writeSession("yourFileName.java") {
+	write("Package\n)
+	(...)
+ }
+
+ File generated by ontoMDE-core are in fact separated into blocks. Certain blocks can be preserved on subsequent generation. This is usefull if a file is meant to be customized, by for example, providing an implementation for a java method.
+
+ Generated code will be in a protected block if it is inside a mtk_protected clause. 
+
+ mtk_writeSession("yourFileName.java") {
+	write("Package\n)
+	(...)
+	mtk_protected {
+		write ("this is inside protected zone")
+	}
+	write ("this is *not* inside protected zone")
+ }
+
+
+
+
+
+==Context handling facilities
+

data/README.txt

@@ -1,48 +1,79 @@
-ontomde-core
-    by FIX (your name)
-    FIX (url)
-
-== DESCRIPTION:
-  
-FIX (describe your package)
-
-== FEATURES/PROBLEMS:
-  
-* FIX (list of features or problems)
-
-== SYNOPSIS:
-
-  FIX (code sample of usage)
-
-== REQUIREMENTS:
-
-* FIX (list of requirements)
-
-== INSTALL:
-
-* FIX (sudo gem install, anything else)
-
-== LICENSE:
-
-(The MIT License)
-
-Copyright (c) 2007 FIX
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ontomde-core 
+    by Stephane (Pierre) Carrie 2005-2007
+    http://ontomde.rubyforge.org 
+
+== DESCRIPTION:
+
+ontoMDE-core is basically a library for loading a RDFS model in ruby memory and process it to do something usefull such as generating Java or C++ code.
+
+ontoMDE-core is used by ontoMDE-uml2 which adds UML2 meta-model definitions and some helper methods. ontoMDE-uml2 is in turn used by ontoMDE-uml2-java which adds methods and rules to generate java5 code.
+
+But ontoMDE-core is *not* *UML* *specific* and can be used with *any* RDF[http://en.wikipedia.org/wiki/Resource_Description_Framework] / RDFS[http://en.wikipedia.org/wiki/RDF_Schema] model such as those created with Protege_2000[http://protege.stanford.edu]. This opens to ontoMDE-core users the ability to generate code from custom DSL[http://en.wikipedia.org/wiki/Domain_Specific_Language] models, or join different models.
+
+== FEATURES/PROBLEMS:
+RDF handling library
+* RDF/ntriples native ruby file reader
+* RDFS to Ruby class file converter
+* RDF data reader
+Code generator helper library
+* file write library helper with protected zone handling
+* tag based code reverse library
+
+== SYNOPSIS:
+
+  (example extracted from test/model)
+
+  require 'ontomde-core'
+
+  # create a new model instance
+  model=Crdf_Model.new
+
+  # loads metamodel and creates Ruby classes
+  model.loadMetaModelFromFile("etatCivil.rdfs",true)
+
+  # load data from file and creates Ruby objects
+  model.loadModelFromFile("etatCivil.rdf",true)
+
+  # very basic browsing of loaded data 
+  model.each { |k,c|
+	puts "#{c} #{k} #{c.rdf_uri"
+  } 
+== Manual
+Please refer to MANUAL.txt for additional information on ontoMDE-core.
+
+== REQUIREMENTS:
+
+* UNIX users should install redland[http://librdf.org/] if they wish to process RDF files not in N-TRIPLES format such as Protege 2000 XML/RDF files.
+
+== INSTALL:
+
+* (UNIX) sudo gem install ontomde-core
+* (WIN ) gem install ontomde-core
+
+Additional information is available on ontoMDE web site :
+http://ontomde.rubyforge.org/website/download.html
+== LICENSE:
+
+Copyright (C) 2008 Orange-labs 
+38 rue General Leclerc
+92130 ISSY LES MOULINEAUX, France
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see http://www.gnu.org/licenses/.
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -8,12 +8,13 @@ Hoe.new('ontomde-core', Ontomde::Core::VERSION) do |p|
   p.rubyforge_name = 'ontomde'
   p.author = 'Stephane (Pierre) Carrie'
   p.email = 'stephanepierre.carrie@orange-ftgroup.com'
-  p.summary = 'OntoMDE core cartridge (RDF/RDFS handling,helpers)'
-  # p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
-  # p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.summary = 'OntoMDE core cartridge (RDF/RDFS handling,code generation helpers)'
+  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  p.url="http://ontomde.rubyforge.org"
   p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
   p.spec_extras[:required_ruby_version] = '>= 1.8.4'
   p.extra_deps=[ ['ontomde-redland-win','= 1.0.3'] ]
+  p.spec_extras={ :required_ruby_version => '>=1.8.6',:required_rubygems_version => '>=1.0.0' }
 end
 
 # vim: syntax=Ruby

data/lib/ontomde-core/bootstrap_rdfs.rb

@@ -1,37 +1,36 @@
-# Bootstrap of rdfs metamodel
-#:include: ../shared/license.rdoc
-
-module Mrdfs_Resource
-end
-
-module Mrdfs_Class
-end
-
-class Crdfs_Class < Crdf_Resource
-  include Mrdfs_Class
-  attr_reader :ClassGenerated
-  attr_writer :ClassGenerated
-  def initialize(model,uri)
-    super(model,uri)
-    @mtk_rubyClassGenerated=false
-  end
-end
-module Mrdf_Property
-end
-
-class Crdf_Property < Crdf_Resource
-  include Mrdf_Property
-  attr_reader :rdfs_domain, :rdfs_range
-  attr_reader :sys_inverseProperty
-  @rdfs_domain=ArrayOrSingleElement.new()
-  #attr_writer :rdfs_domain, :rdfs_range
-end
-
-module Mrdfs_Literal
-end
-
-class Crdfs_Literal < Crdf_Resource
-  include Mrdfs_Literal
-  attr_reader :rdfs_domain, :rdfs_range
-  #attr_writer :rdfs_domain, :rdfs_range
-end
+# Bootstrap of rdfs metamodel
+
+module Mrdfs_Resource
+end
+
+module Mrdfs_Class
+end
+
+class Crdfs_Class < Crdf_Resource
+  include Mrdfs_Class
+  attr_reader :ClassGenerated
+  attr_writer :ClassGenerated
+  def initialize(model,uri)
+    super(model,uri)
+    @mtk_rubyClassGenerated=false
+  end
+end
+module Mrdf_Property
+end
+
+class Crdf_Property < Crdf_Resource
+  include Mrdf_Property
+  attr_reader :rdfs_domain, :rdfs_range
+  attr_reader :sys_inverseProperty
+  @rdfs_domain=ArrayOrSingleElement.new()
+  #attr_writer :rdfs_domain, :rdfs_range
+end
+
+module Mrdfs_Literal
+end
+
+class Crdfs_Literal < Crdf_Resource
+  include Mrdfs_Literal
+  attr_reader :rdfs_domain, :rdfs_range
+  #attr_writer :rdfs_domain, :rdfs_range
+end

data/lib/ontomde-core/clone.rb

@@ -1,73 +1,72 @@
-#Model transformation methods
-#:include: ../shared/license.rdoc
-
-class String
-	# Clones a string
-	# return self by default.(String are not cloned)
-	def rdfx_clone
-		return self
-	end
-end
-
-module Mrdf_Resource
-	# Clones a uml resource.
-	# Referenced objects are cloned if rdfx_copyOnClone says so.
-	def rdfx_clone
-		c=self.clone
-		c.rdf_uri="_transient_#{c.object_id}"
-		c.rdf_model[c.rdf_uri]=c
-
-		instance_variables.each { |v| 
-			ivg=instance_variable_get(v)
-			next if (!ivg.kind_of?(ArrayOrSingleElement)) ||
-				(!isResetable?(v)) || 
-				(!rdfx_copyOnClone?(v)) 
-
-			newVal=createEmptyAttributeValue
-			#puts "clone v=#{v}"
-			self.instance_variable_get(v).each { | res|
-				newVal.push(res.rdfx_clone)
-				c.instance_variable_set(v,newVal)
-				}
-			}
-		return c	
-	end
-	
-	# Returns true if object should be copied on clone for this property.
-	# NOTE:
-	#   returns true if property name contains "_owned". (works for UML)
-	def rdfx_copyOnClone?(prop)
-		return prop.include?('_owned')
-		#copyOrClone=copyOnCloneProperties[prop]
-		#if copyOrClone.nil?
-			#puts "WARNING: unspecified copy on clone for #{prop} on #{self.class.name}"
-		#end
-		#return copyOrClone 
-	end
-end
-#module Mrdf_Resource
-#	#CopyOnCloneProperties={ }
-#	def copyOnCloneProperties
-#		#CopyOnCloneProperties
-#	end
-#end
-#module Muml_Class
-#	CopyOnCloneProperties={ '@uml_packageableElement_packageableElement_visibility' => true,
-#		'@uml_structuredClassifier_ownedAttribute' => true,
-#		'@mtk_rubyClassGenerated' => true,
-#		'@uml_classifier_generalization' => true,
-#		'@uml_namedElement_visibility' => true,
-#		'@uml_namedElement_clientDependency' => true,
-#		'@umlx_packageableElement_owner' => true,
-#		'@ext_isReferencedBy' => true,
-#		'@uml_class_ownedOperation' => true,
-#		'@uml_behavioredClassifier_implementation' => true,
-#		'@uml_namedElement_name' => true }
-#	#def copyOnCloneProperties
-#	#	CopyOnCloneProperties #_class
-#	#end
-#end
-
-
-
-
+#
+
+class String
+  # Clones a string
+  # return self by default.(String are not cloned)
+  def rdfx_clone
+    return self
+  end
+end
+
+module Mrdf_Resource
+  # Clones a uml resource.
+  # Referenced objects are cloned if rdfx_copyOnClone says so.
+  def rdfx_clone
+    c=self.clone
+    c.rdf_uri="_transient_#{c.object_id}"
+    c.rdf_model[c.rdf_uri]=c
+
+    instance_variables.each { |v|
+      ivg=instance_variable_get(v)
+      next if (!ivg.kind_of?(ArrayOrSingleElement)) ||
+        (!isResetable?(v)) ||
+        (!rdfx_copyOnClone?(v))
+
+      newVal=createEmptyAttributeValue
+      #puts "clone v=#{v}"
+      self.instance_variable_get(v).each { | res|
+        newVal.push(res.rdfx_clone)
+        c.instance_variable_set(v,newVal)
+      }
+    }
+    return c
+  end
+
+  # Returns true if object should be copied on clone for this property.
+  # NOTE:
+  #   returns true if property name contains "_owned". (works for UML)
+  def rdfx_copyOnClone?(prop)
+    return prop.include?('_owned')
+    #copyOrClone=copyOnCloneProperties[prop]
+    #if copyOrClone.nil?
+    #puts "WARNING: unspecified copy on clone for #{prop} on #{self.class.name}"
+    #end
+    #return copyOrClone
+  end
+end
+#module Mrdf_Resource
+#	#CopyOnCloneProperties={ }
+#	def copyOnCloneProperties
+#		#CopyOnCloneProperties
+#	end
+#end
+#module Muml_Class
+#	CopyOnCloneProperties={ '@uml_packageableElement_packageableElement_visibility' => true,
+#		'@uml_structuredClassifier_ownedAttribute' => true,
+#		'@mtk_rubyClassGenerated' => true,
+#		'@uml_classifier_generalization' => true,
+#		'@uml_namedElement_visibility' => true,
+#		'@uml_namedElement_clientDependency' => true,
+#		'@umlx_packageableElement_owner' => true,
+#		'@ext_isReferencedBy' => true,
+#		'@uml_class_ownedOperation' => true,
+#		'@uml_behavioredClassifier_implementation' => true,
+#		'@uml_namedElement_name' => true }
+#	#def copyOnCloneProperties
+#	#	CopyOnCloneProperties #_class
+#	#end
+#end
+
+
+
+