rtm 0.3.0 → 0.3.1

data/DISCLAIMER

@@ -1,3 +1,5 @@
+Copyright 2006-2008 Benjamin Bock
+
 Copyright 2008-2010 Topic Maps Lab, University of Leipzig.
 
 Licensed under the Apache License, Version 2.0 (the "License"); 
@@ -10,4 +12,4 @@ Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS, 
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
 See the License for the specific language governing permissions and limitations 
-under the License.
+under the License.

data/lib/rtm.rb

@@ -37,7 +37,6 @@ module RTM
   module Reifiable; end
 
   module TopicMap
-    attr_accessor :engine
   end
 
   module TopicMapSystem; end

data/lib/rtm/axes/topic.rb

@@ -164,9 +164,6 @@ module RTM::Axes
       _res = @construct.transitive_subtypes_with_self.map{|r| r.axes}
       _res.extend(Topics)
     end
-    
-    alias reverse_subtypes supertypes
-    alias reverse_supertypes subtypes
 
     # ---- traverse-axis ---------------------------------------------------#
     

data/lib/rtm/axes/topics.rb

@@ -196,9 +196,6 @@ module RTM::Axes
       _res = _res.extend(Topics)
       _res
     end
-    
-    alias reverse_subtypes supertypes
-    alias reverse_supertypes subtypes
 
     # ---- traverse-axis ---------------------------------------------------#
     

data/lib/rtm/connection.rb

@@ -30,17 +30,17 @@ module RTM
       connection
     end
 
-    # Return all connections or a particular connection.
+    # Returns all connections or a particular connection.
     # @overload connections
     #   Returns all registered connections, keyed by their identifiers.
     #   @return [Hash]
     # @overload connections(identifier)
     #   @param [Symbol] identifier of the registered connection
     #   @return [Engine] the connection object
-    def connections(*args)
+    def connections(key=nil)
       @connections ||= {}
-      if args.size > 0
-        @connections[*args]
+      if key
+        @connections[key]
       else
         @connections
       end

data/lib/rtm/engine.rb

@@ -49,19 +49,20 @@ module RTM
       require "rtm/#{engine_gem_name}"
       self[engine_name]
     end
-
+    
+    # Changed 2010-07-29: engine_name now symbols, cause, list elements are also symbol
     def self.load!(engine_name=nil)
       engine_name = self.detect unless engine_name
-      unless list.include?(engine_name)
+      unless list.include?(engine_name.to_sym)
         warn("Requested engine '#{engine_name}' not loaded. Trying to autoload it.")
-        engine = load(engine_name)
-        if list.include?(engine_name)
+        engine = load(engine_name.to_sym)
+        if list.include?(engine_name.to_sym)
           warn("Autoloading '#{engine_name}' was successful")
         else
           raise "Autoloading '#{engine_name}' failed. Make sure rtm-#{engine_name} exists and is installed or require it manually."
         end
       end
-      engine || load(engine_name)
+      engine || load(engine_name.to_sym)
     end
 
     def self.detect(preferred=nil)

data/lib/rtm/extensions.rb

@@ -45,7 +45,7 @@ module RTM
     end
 
     # A standard Ruby hook to be notified about inclusions of this module.
-    # This normally eliminates the need to register a module as implementa
+    # This normally eliminates the need to register a module as implementation
     def included(klass)
       # super
       # puts "[RTMEXT] including #{self} into #{klass} in #{caller(1).first}"

data/lib/rtm/helpers/no_output.rb

@@ -3,7 +3,7 @@
 
 # Executes the given block while suppressing all standard output.
 def no_output
-  $stdout = File.open( PLATFORM =~ /mswin/ ? "NUL" : "/dev/null", "w" )
+  $stdout = File.open( PLATFORM =~ /mswin|mingw/ ? "NUL" : "/dev/null", "w" )
   yield if block_given?
   $stdout.close
   $stdout = STDOUT

data/lib/rtm/io/from_xtm2_libxml.rb

@@ -22,7 +22,7 @@ module RTM::IO
     def self.from_xtm2(source, base_locator, target=nil,options={})
       tm = RTM.create(base_locator) unless target
       parser = XML::SaxParser.new
-      parser.callbacks = XML::LibXMLSax2wrapper.new(FROMXTM2::XTM2Listener.new(base_locator, target || tm, options))
+      parser.callbacks = RTM::XML::LibXMLSax2wrapper.new(FROMXTM2::XTM2Listener.new(base_locator, target || tm, options))
       parser.filename = source
       parser.parse
       #true
@@ -30,7 +30,7 @@ module RTM::IO
   end
 end
 
-module XML
+module RTM::XML
   # Acts as Callback structure for the LibXML-Ruby SAX Parser and calls
   # a REXML SAX2Listener API.
   class LibXMLSax2wrapper

data/lib/rtm/io/tmapix_from.rb

@@ -38,7 +38,12 @@ module RTM::IO
           topic_map = create(base_iri)
         end
 
-        reader_class.new(topic_map, java.io.File.new(source)).read
+        # TODO catch java.io.FileNotFoundException
+        reader = reader_class.new(topic_map, java.io.File.new(source), base_iri)
+        if reader_class == Java::OrgTmapixIo::LTMTopicMapReader
+          reader.setLegacyMode(true)
+        end
+        reader.read
         topic_map
       end
 
@@ -69,7 +74,6 @@ module RTM::IO
       #   from_jtm(filename)
       #
       def from_jtm(*args)
-        # seems not to acceped all files that are found to be valid by the JTM validator
         from_anything(Java::OrgTmapixIo::JTMTopicMapReader, *args)
       end
 
@@ -84,28 +88,6 @@ module RTM::IO
         from_anything(Java::OrgTmapixIo::TMXMLTopicMapReader, *args)
       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(*args)
-        from_anything(Java::OrgTmapixIo::XTM10TopicMapReader, *args)
-      end
-      alias :from_xtm1 :from_xtm10
-
-      # Reads a XML Topic Maps (XTM) 2.0 File
-      # whose location is given as String parameter.
-      #
-      # :call-seq:
-      #   from_xtm20(filename)
-      #
-      def from_xtm20(*args)
-        from_xtm(*args)
-      end
-      alias :from_xtm2 :from_xtm20
-
       # Reads a XML Topic Maps (XTM) File
       # independent of the version
       # whose location is given as String parameter.
@@ -116,6 +98,11 @@ module RTM::IO
       def from_xtm(*args)
         from_anything(Java::OrgTmapixIo::XTMTopicMapReader, *args)
       end
+      alias :from_xtm21 :from_xtm
+      alias :from_xtm20 :from_xtm
+      alias :from_xtm2 :from_xtm
+      alias :from_xtm10 :from_xtm
+      alias :from_xtm1 :from_xtm
 
       # Reads a Notation3 (N3) File
       # whose location is given as String .

data/lib/rtm/io/tmapix_to.rb

@@ -50,6 +50,8 @@ module RTM::IO
         # Use the topic maps's base_iri if neither found.
         base_iri = args.shift || params[:base_iri] || self.base_iri
 
+        xtm_version = params[:xtm_version]
+
         # If a file was provided somehow, we wrap it with output streams
         if file
           if file.is_a?(java.io.OutputStream)
@@ -63,11 +65,16 @@ module RTM::IO
         end
 
         # create the java writer
-        writer = writer_class.new(out_stream, base_iri)
+        if xtm_version
+          writer = writer_class.new(out_stream, base_iri, xtm_version)
+        else
+          writer = writer_class.new(out_stream, base_iri)
+        end
+        
         # set params
         params.each do |k,v|
           # skip our params, as they're not of interest for the writer
-          next if k == :file || k == :base_iri
+          next if [:file, :base_iri, :xtm_version].include?(k)
           writer.setProperty(k.to_s,v.to_s)
         end if writer.respond_to?(:setProperty)
         # do the actual work
@@ -83,6 +90,29 @@ module RTM::IO
       end
 
       public
+
+      # Serializes an RTM::TopicMap to XTM v. 2.1.
+      #
+      # If no file argument is given, a String is returned.
+      #
+      # The argument file can be provided as a String
+      # (which is then interpreted as a filename) or as a java.io.OutputStream.
+      #
+      # The argument base_iri may be used to define a new base_iri, if not, the current
+      # one is used. Base_iri may be a String.
+      #
+      # :call-seq:
+      #   to_xtm21
+      #   to_xtm21(file)
+      #   to_xtm21(file, base_iri)
+      #
+      def to_xtm21(*args)
+        args.push({}) unless args.last.is_a?(Hash)
+        args.last[:xtm_version] = Java::OrgTmapixIo::XTMVersion::XTM_2_1
+        to_anything(Java::OrgTmapixIo::XTM2TopicMapWriter, *args)
+      end
+      alias :to_xtm :to_xtm21
+
       # Serializes an RTM::TopicMap to XTM v. 2.0.
       #
       # If no argument is given, a String is returned.
@@ -94,14 +124,15 @@ module RTM::IO
       # one is used. Base_iri may be a String.
       #
       # :call-seq:
-      #   to_xtm20
-      #   to_xtm20(file)
-      #   to_xtm20(file, base_iri)
+      #   to_xtm21
+      #   to_xtm21(file)
+      #   to_xtm21(file, base_iri)
       #
       def to_xtm20(*args)
-        to_anything(Java::OrgTmapixIo::XTM20TopicMapWriter, *args)
+        args.push({}) unless args.last.is_a?(Hash)
+        args.last[:xtm_version] = Java::OrgTmapixIo::XTMVersion::XTM_2_0
+        to_anything(Java::OrgTmapixIo::XTM2TopicMapWriter, *args)
       end
-      alias :to_xtm :to_xtm20
       alias :to_xtm2 :to_xtm20
 
       # Serializes an RTM::TopicMap to XTM v. 1.0.

data/lib/rtm/navigation/topic/characteristics.rb

@@ -17,15 +17,13 @@ module RTM
       #   characteristics -> Array of Names and Occurrences
       #   characteristics(identifier) -> Array of Names and Occurrences
       #
-      def characteristics(type=:any)
-        # FIXME which version of the code?
-        return names.to_a + occurrences.to_a if type == :any
-        _topic = topic_map.get(type)
-        return [] unless _topic
-        #names.select{|n| n.type.include?(_topic) || n.type.supertypes.include?(_topic)}.to_a +
-        #occurrences.select{|o| o.type.include?(_topic) || o.type.supertypes.include?(_topic)}.to_a
-        names.select{|n| n.type.supertypes.include?(_topic)}.to_a +
-        occurrences.select{|o| o.type.supertypes.include?(_topic)}.to_a
+      def characteristics(type = :any)
+        _characteristics = names.to_a + occurrences.to_a
+        return _characteristics if type == :any
+        _type = topic_map.get(type)
+        return [] unless _type
+        #_characteristics.select{|c| c.type == _topic}
+        _characteristics.select{|c| c.type.supertypes.include?(_type)}
       end
       
     end

data/lib/rtm/navigation/topic/supertypes.rb

@@ -4,7 +4,7 @@
 module RTM
   module Navigation
     module Topic
-      
+
       # Returns all Topic players that exist in binary supertype-subtype Associations
       # where this Topic playes the subtype-Role.
       #
@@ -32,7 +32,6 @@ module RTM
         asso = topic_map.create_association(RTM::PSI[:supertype_subtype])
         asso.create_role(RTM::PSI[:subtype],self)
         asso.create_role(RTM::PSI[:supertype],new_supertype)
-        asso
       end
 
       # Creates one or several binary supertype-subtype-Associations where
@@ -108,7 +107,6 @@ module RTM
         asso = topic_map.create_association(RTM::PSI[:supertype_subtype])
         asso.create_role(RTM::PSI[:supertype],self)
         asso.create_role(RTM::PSI[:subtype],new_subtype)
-        asso
       end
 
       # Creates one or several binary supertype-subtype-Associations where
@@ -158,8 +156,6 @@ module RTM
       
       alias :supertypes :transitive_supertypes
       alias :subtypes :transitive_subtypes
-      alias :reverse_subtypes :supertypes
-      alias :reverse_supertypes :subtypes
       
     end
   end

data/lib/rtm/sugar.rb

@@ -10,6 +10,7 @@ require 'rtm/sugar/topic/counterparts'
 require 'rtm/sugar/topic/scoped'
 require 'rtm/sugar/topic/typed'
 require 'rtm/sugar/topic/best_name'
+require 'rtm/sugar/topic/remove'
 RTM::Topic.register_extension(RTM::Sugar::Topic::TopicRef)
 RTM::Topic.register_extension(RTM::Sugar::Topic::HashAccess)
 RTM::Topic.register_extension(RTM::Sugar::Topic::Characteristics)
@@ -17,9 +18,15 @@ RTM::Topic.register_extension(RTM::Sugar::Topic::Counterparts)
 RTM::Topic.register_extension(RTM::Sugar::Topic::Scoped)
 RTM::Topic.register_extension(RTM::Sugar::Topic::Typed)
 RTM::Topic.register_extension(RTM::Sugar::Topic::BestName)
+RTM::Topic.register_extension(RTM::Sugar::Topic::Remove)
 
 require "rtm/sugar/association/hash_access"
+require "rtm/sugar/association/remove"
 RTM::Association.register_extension(RTM::Sugar::Association::HashAccess)
+RTM::Association.register_extension(RTM::Sugar::Association::Remove)
+
+require "rtm/sugar/name/remove"
+RTM::Name.register_extension(RTM::Sugar::Name::Remove)
 
 require "rtm/sugar/role/counterparts"
 RTM::Role.register_extension(RTM::Sugar::Role::Counterparts)
@@ -27,8 +34,10 @@ RTM::Role.register_extension(RTM::Sugar::Role::Counterparts)
 require "time"
 require "rtm/sugar/occurrence/dynamic_value"
 require "rtm/sugar/occurrence/external"
+require "rtm/sugar/occurrence/remove"
 RTM::Occurrence.register_extension(RTM::Sugar::Occurrence::DynamicValue)
 RTM::Occurrence.register_extension(RTM::Sugar::Occurrence::External)
+RTM::Occurrence.register_extension(RTM::Sugar::Occurrence::Remove)
 
 require "rtm/sugar/typed/types"
 RTM::Typed.register_extension(RTM::Sugar::Typed::Types)
@@ -40,6 +49,8 @@ require 'rtm/sugar/topic_map/query_cache'
 require 'rtm/sugar/topic_map/scoped'
 require 'rtm/sugar/topic_map/types'
 require 'rtm/sugar/topic_map/remove'
+require 'rtm/sugar/topic_map/resolve'
+require 'rtm/sugar/topic_map/readable'
 module RTM::TopicMap
   @query_cache = nil #disables query caching
 end
@@ -47,6 +58,10 @@ RTM::TopicMap.register_extension(RTM::Sugar::TopicMap::QueryCache)
 RTM::TopicMap.register_extension(RTM::Sugar::TopicMap::Scoped)
 RTM::TopicMap.register_extension(RTM::Sugar::TopicMap::Types)
 RTM::TopicMap.register_extension(RTM::Sugar::TopicMap::Remove)
+RTM::TopicMap.register_extension(RTM::Sugar::TopicMap::Resolve)
+RTM::TopicMap.register_extension(RTM::Sugar::TopicMap::Readable)
 
 require "rtm/sugar/variant/topic"
-RTM::Variant.register_extension(RTM::Sugar::Variant::Topic)
+require "rtm/sugar/variant/remove"
+RTM::Variant.register_extension(RTM::Sugar::Variant::Topic)
+RTM::Variant.register_extension(RTM::Sugar::Variant::Remove)

data/lib/rtm/sugar/association/remove.rb

@@ -0,0 +1,21 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module RTM::Sugar::Association
+  module Remove
+
+    def force_remove
+      if assoc_reifier = self.reifier
+        self.reifier = nil
+        assoc_reifier.force_remove
+      end
+      self.roles.to_a.clone.each do |role|
+        if role_reifier = role.reifier
+          role.reifier = nil
+          role_reifier.force_remove
+        end
+      end
+      remove
+    end
+  end
+end

data/lib/rtm/sugar/name/remove.rb

@@ -0,0 +1,18 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module RTM::Sugar::Name
+  module Remove
+
+    def force_remove
+      if name_reifier = self.reifier
+        self.reifier = nil
+        name_reifier.force_remove
+      end
+      self.variants.to_a.clone.each do |v|
+        v.force_remove
+      end
+      remove
+    end
+  end
+end

data/lib/rtm/sugar/occurrence/external.rb

@@ -40,6 +40,7 @@ module RTM::Sugar::Occurrence
     #
     def externalize!(*args)
       association = externalize(*args)
+      self.reifier = nil
       remove
       return association
     end

data/lib/rtm/sugar/occurrence/remove.rb

@@ -0,0 +1,15 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module RTM::Sugar::Occurrence
+  module Remove
+
+    def force_remove
+      if occ_reifier = self.reifier
+        self.reifier = nil
+        occ_reifier.force_remove
+      end
+      remove
+    end
+  end
+end