rtm 0.1.6 → 0.2.0

data/lib/rtm/io/from_xtm2_libxml.rb

@@ -1,4 +1,5 @@
-# Ruby Topic Maps (RTM) http://rtm.rubyforge.org/
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
 
 module RTM
   def self.from_xtm2lx(*args)

data/lib/rtm/io/ontopia_io.rb

@@ -0,0 +1,25 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+
+module RTM::IO
+  # Import and Export of TMAPI Topic Maps
+  # Utilizing the Ontopia libary http://code.google.com/p/tmapix/
+  # Consequently the (de-) serializer provided here 
+  # are only Wrapper
+  
+  module Ontopia
+    module TopicMap
+      def to_cxtm(filename)
+        raise("Only supported for Ontopia.") unless self.kind_of?(net.ontopia.topicmaps.impl.tmapi2.TopicMapImpl)
+        out_file = java.io.FileOutputStream.new(filename) 
+        writer = net.ontopia.topicmaps.xml.CanonicalXTMWriter.new(out_file)
+        writer.write(self.wrapped)
+        out_file.flush
+        out_file.close      
+      end
+    end
+    
+    RTM.register_extension(self)
+  end
+end

data/lib/rtm/io/tmapix.rb

@@ -0,0 +1,234 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module RTM::IO
+# Import and Export of TMAPI Topic Maps
+# Utilizing the TMAPIX libary http://code.google.com/p/tmapix/
+# Consequently the (de-) serializer provided here 
+# are only Wrapper
+
+  module TMAPIX
+    module TopicMap
+      
+      # Reads a Topic Map from an LTM File
+      # whose location is given as String parameter
+      #
+      # :call-seq:
+      #   from_ltm(filename)
+      #
+      def from_ltm(filename)
+        raise "Only supported for TMAPI backends!!" unless self.kind_of? Java::OrgTmapiCore::TopicMap 
+        org.tmapix.io.LTMTopicMapReader.new(self,  java.io.File.new(filename)).read
+      end
+      
+      # Reads a Topic Map from an CTM File
+      # whose location is given as String parameter
+      #
+      # :call-seq:
+      #   from_ctm(filename)
+      #
+      def from_ctm(filename)
+        raise "Only supported for TMAPI backends!!" unless self.kind_of? Java::OrgTmapiCore::TopicMap 
+        org.tmapix.io.CTMTopicMapReader.new(self,  java.io.File.new(filename)).read
+      end
+      
+      # Reads a JSON Topic Maps (JTM) File
+      # whose location is given as String parameter
+      #
+      # :call-seq:
+      #   from_jtm(filename)
+      #
+      def from_jtm(filename)
+        raise "Only supported for TMAPI backends!!" unless self.kind_of? Java::OrgTmapiCore::TopicMap 
+        # seems not to acceped all files that are found to be valid by the JTM validator
+        org.tmapix.io.JTMTopicMapReader.new(self,  java.io.File.new(filename)).read
+      end
+      
+      # Reads a Friendly Topic Maps XML (TM/XML) File
+      # independent of the version
+      # whose location is given as String parameter
+      #
+      # :call-seq:
+      #   from_tmxml(filename)
+      #
+      def from_tmxml(filename)
+        raise "Only supported for TMAPI backends!!" unless self.kind_of? Java::OrgTmapiCore::TopicMap 
+        org.tmapix.io.TMXMLTopicMapReader.new(self,  java.io.File.new(filename)).read
+      end
+      
+      # Reads a XML Topic Maps (XTM) 1.0 File
+      # whose location is given as String parameter
+      #
+      # :call-seq:
+      #   from_xtm10(filename)
+      #
+      def from_xtm10(filename)
+        raise "Only supported for TMAPI backends!!" unless self.kind_of? Java::OrgTmapiCore::TopicMap 
+        org.tmapix.io.XTM10TopicMapReader.new(self,  java.io.File.new(filename)).read
+      end
+      
+      # Reads a XML Topic Maps (XTM) 2.0 File
+      # whose location is given as String parameter
+      #
+      # :call-seq:
+      #   from_xtm20(filename)
+      #
+      def from_xtm20(filename)
+        from_xtm(filename)
+      end
+      
+      # Reads a XML Topic Maps (XTM) File
+      # independent of the version
+      # whose location is given as String parameter
+      #
+      # :call-seq:
+      #   from_xtm(filename)
+      #
+      def from_xtm(filename)
+        raise "Only supported for TMAPI backends!!" unless self.kind_of? Java::OrgTmapiCore::TopicMap 
+        org.tmapix.io.XTMTopicMapReader.new(self,  java.io.File.new(filename)).read
+      end
+      
+      # Reads a Notation3 (N3) File
+      # whose location is given as String 
+      # a second parameter has to be handed over
+      # providing the mapping vocabulary.
+      # The syntax of the vocabulary is guessed.
+      #
+      # :call-seq:
+      #   from_n3(source vocabulary)
+      #
+      def from_n3(filename, vocab)
+        raise "Only supported for TMAPI backends!!" unless self.kind_of? Java::OrgTmapiCore::TopicMap 
+        reader = org.tmapix.io.N3TopicMapReader.new self,  java.io.File.new(filename)
+        reader.setMappingSource(java.io.File.new(vocab))
+        reader.read
+      end
+      
+      # Reads a RDF/XML File
+      # whose location is given as String 
+      # a second parameter has to be handed over
+      # providing the mapping vocabulary.
+      # The syntax of the vocabulary is guessed.
+      #
+      # :call-seq:
+      #   from_rdfxml(source vocabulary)
+      #
+      def from_rdfxml(filename, vocab)
+        raise "Only supported for TMAPI backends!!" unless self.kind_of? Java::OrgTmapiCore::TopicMap 
+        reader = org.tmapix.io.RDFXMLTopicMapReader.new self,  java.io.File.new(filename)
+        reader.setMappingSource(java.io.File.new(vocab))
+        reader.read
+      end
+      
+      # Serializes an RTM::TopicMap to XTM v. 2.0.
+      #
+      # The argument filename defines the absolute location of the file that is created.
+      # The argument base_iri is used to resolve IRIs against.
+      #
+      # :call-seq:
+      #   to_xtm20(filename, base_iri)
+      #
+      def to_xtm20(filename, base_iri)
+        raise("Only supported for TMAPI backends.") unless self.kind_of?(Java::OrgTmapiCore::TopicMap)
+        out_file = java.io.FileOutputStream.new(filename)
+        writer = org.tmapix.io.XTM20TopicMapWriter.new(out_file, base_iri)
+        writer.write(self)
+        out_file.flush
+        out_file.close
+      end
+      alias :to_xtm :to_xtm20
+      
+      # Serializes an RTM::TopicMap to XTM v. 1.0.
+      #
+      # The argument filename defines the absolute location of the file that is created.
+      # The argument base_iri is used to resolve IRIs against.
+      # Both arguments have to be Strings.
+      #
+      # :call-seq:
+      #   to_xtm10(filename, base_iri)
+      #
+      def to_xtm10(filename, base_iri)
+        raise("Only supported for TMAPI backends.") unless self.kind_of?(Java::OrgTmapiCore::TopicMap) 
+        out_file = java.io.FileOutputStream.new(filename) 
+        writer = org.tmapix.io.XTM10TopicMapWriter.new(out_file, base_iri)
+        writer.write(self)
+        out_file.flush
+        out_file.close
+      end
+      
+      # Serializes an RTM::TopicMap to JTM.
+      #
+      # The argument filename defines the absolute location of the file that is created.
+      # The argument base_iri is used to resolve IRIs against.
+      #
+      # :call-seq:
+      #   to_jtm(filename, base_iri)
+      #
+      def to_jtm(filename, base_iri)
+        raise("Only supported for TMAPI backends.") unless self.kind_of?(Java::OrgTmapiCore::TopicMap)
+        out_file = java.io.FileOutputStream.new(filename) 
+        writer = org.tmapix.io.JTMTopicMapWriter.new(out_file, base_iri)
+        writer.write(self)
+        out_file.flush
+        out_file.close
+      end
+      alias :to_json :to_jtm
+
+      # Serializes an RTM::TopicMap to LTM.
+      #
+      # The argument filename defines the absolute location of the file that is created.
+      # The argument base_iri is used to resolve IRIs against.
+      #
+      # :call-seq:
+      #   to_ltm(filename, base_iri)
+      #
+      def to_ltm(filename, base_iri)
+        raise("Only supported for TMAPI backends.") unless self.kind_of?(Java::OrgTmapiCore::TopicMap)
+        out_file = java.io.FileOutputStream.new(filename) 
+        writer = org.tmapix.io.LTMTopicMapWriter.new(out_file, base_iri)
+        writer.write(self)
+        out_file.flush
+        out_file.close 
+      end
+
+      # Serializes an RTM::TopicMap to TM/XML.
+      #
+      # The argument filename defines the absolute location of the file that is created.
+      # The argument base_iri is used to resolve IRIs against.
+      #
+      # :call-seq:
+      #   to_tmxml(filename, base_iri)
+      #
+      def to_tmxml(filename, base_iri)
+        raise("Only supported for TMAPI backends.") unless self.kind_of?(Java::OrgTmapiCore::TopicMap)
+        out_file = java.io.FileOutputStream.new(filename) 
+        writer = org.tmapix.io.TMXMLTopicMapWriter.new(out_file, base_iri)
+        writer.write(self)
+        out_file.flush
+        out_file.close 
+      end
+
+      # Serializes an RTM::TopicMap to CTM.
+      #
+      # The argument filename defines the absolute location of the file that is created.
+      # The argument base_iri is used to resolve IRIs against.
+      #
+      # :call-seq:
+      #   to_ctm(filename, base_iri)
+      #
+      def to_ctm(filename, base_iri)
+        raise("Only supported for TMAPI backends.") unless self.kind_of?(Java::OrgTmapiCore::TopicMap)
+        out_file = java.io.FileOutputStream.new(filename)
+        line = "writer.features.export.itemidentifier = false, " + "writer.features.prefixDetection.enabled = false, " + "writer.features.templateDetection.enabled = false, " + "writer.features.templateDetection.topicTemplates = false , " + "writer.features.templateDetection.associationTemplates = false, " + "writer.features.templateMerger.enabled = false"  
+        writer = de.topicmapslab.ctm.writer.core.CTMTopicMapWriter.new(out_file, base_iri, line)
+        writer.write(self)
+        out_file.flush
+        out_file.close
+      end
+
+    end
+
+    RTM.register_extension(self)
+  end
+end

data/lib/rtm/io/to_hash.rb

@@ -0,0 +1,116 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module RTM::IO
+  # HASH Export.
+  # Each Topic Maps Construct gets a to_hash method.
+  module TOHASH
+
+    module TopicMap
+      # Returns the Hash representation of this RTM::TopicMap
+      def to_hash
+        h={}
+        h[:reifier] = reifier.to_ref if reifier
+        h[:item_identifiers] = item_identifiers.map{|i| i.reference} unless item_identifiers.empty?
+        h[:topics] = topics.map{|i| i.to_hash} unless topics.empty?
+        h[:associations] = associations.map{|i| i.to_hash} unless associations.empty?
+        h
+      end
+    end
+    
+    
+    module Topic
+      # Returns the Hash representation of this RTM::Topic
+      def to_hash
+        h = {}
+        h[:item_identifiers] = item_identifiers.map{|i| i.reference} unless item_identifiers.empty?
+        h[:subject_identifiers] = subject_identifiers.map{|i| i.reference} unless subject_identifiers.empty?
+        h[:subject_locators] = subject_locators.map{|i| i.reference} unless subject_locators.empty?
+        h[:names] = names.map{|i| i.to_hash} unless names.empty?
+        h[:occurrences] = occurrences.map{|i| i.to_hash} unless occurrences.empty?
+        h
+      end
+      # Returns the reference to the Topic
+      def to_ref
+        if subject_identifiers.first
+          return "si:#{subject_identifiers.first.reference.to_s}"
+        end
+        if item_identifiers.first
+          return "ii:#{item_identifiers.first.reference.to_s}"
+        end
+        # "t#{id}"
+      end
+    end
+
+    module Name
+      # Returns the Hash representation of this RTM::Name
+      def to_hash
+        h={}
+        h[:reifier] = reifier.to_ref if reifier
+        h[:item_identifiers] = item_identifiers.map{|i| i.reference} unless item_identifiers.empty?
+        h[:value] = value if value
+        h[:type] = type.to_ref if type
+        h[:scope] = scope.map{|i| i.to_ref} unless scope.empty?
+        h[:variants] = variants.map{|i| i.to_hash} unless variants.empty?
+        h
+      end
+    end
+    
+    
+    module Association
+      # Returns the Hash representation of this RTM::Association
+      def to_hash
+        h={}
+        h[:reifier] = reifier.to_ref if reifier
+        h[:item_identifiers] = item_identifiers.map{|i| i.reference} unless item_identifiers.empty?
+        h[:type] = type.to_ref if type
+        h[:scope] = scope.map{|i| i.to_ref} unless scope.empty?
+        h[:roles] = roles.map{|i| i.to_hash} unless roles.empty?
+        h
+      end  
+    end
+    
+    
+    
+    module Occurrence
+      # Returns the Hash representation of this RTM::Occurrence
+      def to_hash
+        h={}
+        h[:reifier] = reifier.to_ref if reifier
+        h[:item_identifiers] = item_identifiers.map{|i| i.reference} unless item_identifiers.empty?
+        h[:value] = value if value
+        h[:datatype] = datatype.reference if datatype
+        h[:type] = type.to_ref if type
+        h[:scope] = scope.map{|i| i.to_ref} unless scope.empty?
+        h
+      end
+    end
+
+    module Role
+      # Returns the Hash representation of this RTM::Role
+      def to_hash
+        h={}
+        h[:reifier] = reifier.to_ref if reifier
+        h[:item_identifiers] = item_identifiers.map{|i| i.reference} unless item_identifiers.empty?
+        h[:player] = player.to_ref if player
+        h[:type] = type.to_ref if type
+        h
+      end
+    end
+
+    module Variant
+      # Returns the Hash representation of this RTM::Variant
+      def to_hash(*a)
+        h={}
+        h[:reifier] = reifier.to_ref if reifier
+        h[:item_identifiers] = item_identifiers.map{|i| i.reference} unless item_identifiers.empty?
+        h[:value] = value if value
+        h[:scope] = scope.map{|i| i.to_ref} unless scope.empty?
+        h
+      end
+    end
+    
+    RTM.register_extension self 
+  
+  end  
+end

data/lib/rtm/io/to_jtm.rb

@@ -1,144 +1,94 @@
-# Ruby Topic Maps (RTM) http://rtm.rubyforge.org/
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
 module RTM::IO
   # JTM Export.
   # Each Topic Maps Construct gets a to_jtm method.
- module TOJTM
+  module TOJTM
     begin
       require 'json/ext'
     rescue LoadError
       require 'json/pure'
-    end
+    end unless Object.const_defined?(:JSON)
 
     module TopicMap
-      # returns the JTM representation of this topic map
-      def to_jtm_hash(*a)
-        j={}
-        #j['base_locator'] = base_locator, # with absolute item_identifiers its not needed
-        j['reifier'] = reifier.to_jtm_ref if reifier
-        j['item_identifiers'] = item_identifiers.map{|i| i.reference} unless item_identifiers.empty?
-        j['topics'] = topics.map{|i| i.to_jtm_hash} unless topics.empty?
-        j['associations'] = associations.map{|i| i.to_jtm_hash} unless associations.empty?
-        j
+      # Returns the JTM representation of this RTM::TopicMap
+      def to_jtm_str          # only for export with no file and base_iri otherwise TMAPIX
+        h = to_hash
+        h[:version] = "1.0"
+        h[:item_type] = "topicmap"
+        h.to_json
       end
-      def to_jtm(*a)
-        to_jtm_hash.to_json(*a)
-      end
-      alias :to_json :to_jtm
+      # alias :to_json :to_jtm_str
     end
 
     module Topic
-      # returns the JTM representation of this topic
-      def to_jtm_hash(*a)
-        j={}
-        j['item_identifiers'] = item_identifiers.map{|i| i.reference} unless item_identifiers.empty?
-        j['subject_identifiers'] = subject_identifiers.map{|i| i.reference} unless subject_identifiers.empty?
-        unless j['item_identifiers'] || j['subject_identifiers']
-          j['item_identifiers'] = [to_jtm_ref]
-        end
-        j['subject_locators'] = subject_locators.map{|i| i.reference} unless subject_locators.empty?
-        j['names'] = names.map{|i| i.to_jtm_hash} unless names.empty?
-        j['occurrences'] = occurrences.map{|i| i.to_jtm_hash} unless occurrences.empty?
-        j
-      end
-      def to_jtm(*a)
-        to_jtm_hash.to_json(*a)
+      # Returns the JTM representation of this RTM::Topic
+      def to_jtm
+        h = to_hash
+        h[:version] = "1.0"
+        h[:item_type] = "topic"
+        h.to_json
       end
       alias :to_json :to_jtm
-      
-      def to_jtm_ref
-        if subject_identifiers.first
-          return subject_identifiers.first.reference
-        end
-        if item_identifiers.first
-          return item_identifiers.first.reference
-        end
-        "t#{id}"
-      end
     end
 
     module Association
-      # returns the JTM representation of this association
-      def to_jtm_hash(*a)
-        j={}
-        j['reifier'] = reifier.to_jtm_ref if reifier
-        j['item_identifiers'] = item_identifiers.map{|i| i.reference} unless item_identifiers.empty?
-        j['type'] = type.to_jtm_ref if type
-        j['scope'] = scope.map{|i| i.to_jtm_hash} unless scope.empty?
-        j['roles'] = roles.map{|i| i.to_jtm_hash} unless roles.empty?
-        j
-      end
-      def to_jtm(*a)
-        to_jtm_hash.to_json(*a)
+      # Returns the JTM representation of this RTM::Association
+      def to_jtm
+        h = to_hash
+        h[:version] = "1.0"
+        h[:item_type] = "association"
+        h.to_json
       end
       alias :to_json :to_jtm
-
     end
 
-    module TopicName
-      def to_jtm_hash(*a)
-        j={}
-        j['reifier'] = reifier.to_jtm_ref if reifier
-        j['item_identifiers'] = item_identifiers.map{|i| i.reference} unless item_identifiers.empty?
-        j['value'] = value if value
-        j['type'] = type.to_jtm_ref if type
-        j['scope'] = scope.map{|i| i.to_jtm_hash} unless scope.empty?
-        j['variants'] = variants.map{|i| i.to_jtm_hash} unless variants.empty?
-        j
-      end
-      def to_jtm(*a)
-        to_jtm_hash.to_json(*a)
+    module Name
+      # Returns the JTM representation of this RTM::Name
+      def to_jtm
+        h = to_hash
+        h[:version] = "1.0"
+        h[:item_type] = "name"
+        h.to_json
       end
       alias :to_json :to_jtm
     end
 
     module Occurrence
-      def to_jtm_hash(*a)
-        j={}
-        j['reifier'] = reifier.to_jtm_ref if reifier
-        j['item_identifiers'] = item_identifiers.map{|i| i.reference} unless item_identifiers.empty?
-        j['value'] = value if value
-        j['datatype'] = datatype if datatype
-        j['type'] = type.to_jtm_ref if type
-        j['scope'] = scope.map{|i| i.to_jtm_hash} unless scope.empty?
-        j
-      end
-      def to_jtm(*a)
-        to_jtm_hash.to_json(*a)
+      # Returns the JTM representation of this RTM::Occurrence
+      def to_jtm
+        h = to_hash
+        h[:version] = "1.0"
+        h[:item_type] = "occurrence"
+        h.to_json
       end
       alias :to_json :to_jtm
     end
 
-    module AssociationRole
-      def to_jtm_hash(*a)
-        j={}
-        j['reifier'] = reifier.to_jtm_ref if reifier
-        j['item_identifiers'] = item_identifiers.map{|i| i.reference} unless item_identifiers.empty?
-        j['player'] = player.to_jtm_ref if player
-        j['type'] = type.to_jtm_ref if type
-        j
-      end
-      def to_jtm(*a)
-        to_jtm_hash.to_json(*a)
+    module Role
+      # Returns the JTM representation of this RTM::Role
+      def to_jtm
+        h = to_hash
+        h[:version] = "1.0"
+        h[:item_type] = "role"
+        h.to_json
       end
       alias :to_json :to_jtm
     end
 
     module Variant
-      def to_jtm_hash(*a)
-        j={}
-        j['reifier'] = reifier.to_jtm_ref if reifier
-        j['item_identifiers'] = item_identifiers.map{|i| i.reference} unless item_identifiers.empty?
-        j['value'] = value if value
-        j['scope'] = scope.map{|i| i.to_jtm_hash} unless scope.empty?
-        j
-      end
-      def to_jtm(*a)
-        to_jtm_hash.to_json(*a)
+      # Returns the JTM representation of this RTM::Variant
+      def to_jtm
+        h = to_hash
+        h[:version] = "1.0"
+        h[:item_type] = "variant"
+        h.to_json
       end
       alias :to_json :to_jtm
     end
-  
-    RTM.register_extension( self )
+
+    RTM.register_extension self 
+    
   end
 end
-