rtm 0.3.0 → 0.3.1

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

@@ -0,0 +1,23 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module RTM::Sugar::Topic
+  module Remove
+
+  # Forcibly removes this topic from the topic map:
+  #
+  # * Forcibly removes all associations in which this topic is a player.
+  # * Forcibly removes all names and occurrences of this topic.
+  # * Removes the type-instance relations this topic occurrs in.
+  def force_remove
+    # TODO extend this, maybe allow for a removal of any topic no matter how important
+    # it may be for the whole topic map
+    self.roles_played.to_a.clone.each{ |role| role.parent.force_remove}
+    self.names.to_a.clone.each{ |name| name.force_remove}
+    self.occurrences.to_a.clone.each{ |occ| occ.force_remove}
+    self.types.each{ |type| self.remove_type(type) }
+    self.remove
+  end
+
+  end
+end

data/lib/rtm/sugar/topic/topic_ref.rb

@@ -25,7 +25,7 @@ module RTM::Sugar::Topic
     #     references(params = {}) -> Array of Strings
     #
     def references(params = {})
-      default_hash = {:outputstyle => :ctm, :resolve_qnames => :false, :resolve_base_iri => :false, :sort_by_length => :false}
+      default_hash = {:outputstyle => :ctm, :resolve_qnames => :false, :resolve_base_iri => :false, :sort_by_length => :true}
       params = default_hash.merge(params) if params.is_a? Hash
       prefixes = topic_map.prefixes
 
@@ -56,7 +56,7 @@ module RTM::Sugar::Topic
       end
 
       case params[:outputstyle]
-      when :yaml
+      when :yaml, :jtm
         identifiers = set_of_si.map{  |si| "si:#{si}"} +
           set_of_sl.map{  |sl| "sl:#{sl}"} +
           set_of_ii.map{  |ii| "ii:#{ii}"}
@@ -95,7 +95,7 @@ module RTM::Sugar::Topic
     #     reference(params = {}) -> String
     #
     def reference(params = {})
-      return references(params).sort_by{|identifier| identifier.size}.reverse.first
+      return references(params).first
     end
 
     # Returns all identifiers of this Topic as Array of Locators.
@@ -116,14 +116,118 @@ module RTM::Sugar::Topic
         if topic_map.create_locator(short_form).reference == identifier
           return short_form
         end
-#        if short_form[0] == "/"
-#          short_form = short_form.sub("/", "")
-#
-#        end
+        #        if short_form[0] == "/"
+        #          short_form = short_form.sub("/", "")
+        #
+        #        end
       else
         return identifier #nothing happened
       end
     end
 
+    # Returns true if this topic has a subject identifer equal to the
+    # given identifier. Returns false otherwise.
+    #
+    # A relative identifier is resolved against the base_iri of the topic map.
+    # QNames are resolved beforehand.
+    #
+    # Identifier may be a String or Locator.
+    #
+    # :call-seq:
+    #   has_si?(identifier) -> true or false
+    #
+    def has_si?(identifier)
+      identifier = topic_map.create_locator(identifier)
+      return subject_identifiers.include?(identifier)
+    end
+
+    # Returns true if this topic has an item identifer equal to the
+    # given identifier. Returns false otherwise.
+    #
+    # A relative identifier is resolved against the base_iri of the topic map.
+    # QNames are resolved beforehand.
+    #
+    # Identifier may be a String or Locator.
+    #
+    # :call-seq:
+    #   has_ii?(identifier) -> true or false
+    #
+    def has_ii?(identifier)
+      identifier = topic_map.create_locator(identifier)
+      return item_identifiers.include?(identifier)
+    end
+
+    # Returns true if this topic has a subject locator equal to the
+    # given identifier. Returns false otherwise.
+    #
+    # A relative identifier is resolved against the base_iri of the topic map.
+    # QNames are resolved beforehand.
+    #
+    # Identifier may be a String or Locator.
+    #
+    # :call-seq:
+    #   has_sl?(identifier) -> true or false
+    #
+    def has_sl?(identifier)
+      identifier = topic_map.create_locator(identifier)
+      return subject_locators.include?(identifier)
+    end
+
+    # Returns true if this topic is instance of another topic,
+    # that has a subject identifer equal to the
+    # given identifier. Returns false otherwise.
+    #
+    # A relative identifier is resolved against the base_iri of the topic map.
+    # QNames are resolved beforehand.
+    #
+    # Identifier may be a String or Locator.
+    #
+    # :call-seq:
+    #   has_type_with_si?(identifier) -> true or false
+    #
+    def has_type_with_si?(identifier)
+      types.each do |type|
+        return true if type.has_si?(identifier)
+      end
+      return false
+    end
+
+    # Returns true if this topic is instance of another topic,
+    # that has an item identifer equal to the
+    # given identifier. Returns false otherwise.
+    #
+    # A relative identifier is resolved against the base_iri of the topic map.
+    # QNames are resolved beforehand.
+    #
+    # Identifier may be a String or Locator.
+    #
+    # :call-seq:
+    #   has_type_with_ii?(identifier) -> true or false
+    #
+    def has_type_with_ii?(identifier)
+      types.each do |type|
+        return true if type.has_ii?(identifier)
+      end
+      return false
+    end
+
+    # Returns true if this topic is instance of another topic,
+    # that has a subject locator equal to the
+    # given identifier. Returns false otherwise.
+    #
+    # A relative identifier is resolved against the base_iri of the topic map.
+    # QNames are resolved beforehand.
+    #
+    # Identifier may be a String or Locator.
+    #
+    # :call-seq:
+    #   has_type_with_sl?(identifier) -> true or false
+    #
+    def has_type_with_sl?(identifier)
+      types.each do |type|
+        return true if type.has_sl?(identifier)
+      end
+      return false
+    end
   end
 end

data/lib/rtm/sugar/topic_map/readable.rb

@@ -0,0 +1,19 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module RTM::Sugar
+  module TopicMap
+    module Readable
+
+    def read_only?
+      begin
+        answer = engine.feature("http://tmapi.org/features/readOnly")
+      rescue org.tmapi.core.FeatureNotRecognizedException
+        answer = false
+      end
+      return answer
+    end
+
+    end
+  end
+end

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

@@ -7,28 +7,37 @@ module RTM::Sugar::TopicMap
     # Removes all variants, names, occurrences, roles, asssociations and
     # topics (esp. reifier) from this topic map.
     def clear
+      # This is supported by some backends (e.g. Ontopia) and should be faster than the procedure below.
+      if self.respond_to?(:wrapped) && self.wrapped.respond_to?(:clear)
+        self.wrapped.clear
+        return
+      end
+
+      raise("should not be called on majortom topic maps") if self.respond_to?(:store)
+      
       set_reifier(nil)
-        
+
       variants.to_a.each do |v|
         v.set_reifier(nil)
         v.remove
       end
-               
+
       names.to_a.each do |n|
         n.set_reifier(nil)
         n.remove
       end
-        
+
       occurrences.to_a.each do |o|
         o.set_reifier(nil)
         o.remove
       end
-           
+
       roles.to_a.each do |r|
         r.set_reifier(nil)
-        r.remove
+        # Roles should not be removed here! They are removed when the association is removed
+        #r.remove
       end
-             
+
       associations.to_a.each do |a|
         a.set_reifier(nil)
         a.remove

data/lib/rtm/sugar/topic_map/resolve.rb

@@ -0,0 +1,44 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module RTM::Sugar::TopicMap
+  module Resolve
+
+    def deresolve(iri)
+      if iri.is_a?(RTM::Locator)
+        iri = iri.reference
+      elsif iri.is_a?(String)
+        iri = strip_identifier(iri)
+      else
+        raise("iri should be a String or Locator")
+      end
+      prefixes.each do |identifier, reference|
+        if iri.index(reference) == 0 && iri.length > reference.length
+          return iri.sub(reference, identifier + ":")
+        elsif iri.index(base_iri) == 0
+          _iri = iri.sub(base_iri, "")
+          return _iri if locator.resolve(_iri) == create_locator(iri)
+        end
+      end
+      return iri
+    end
+
+    private
+
+    def strip_identifier(identifier)
+      case identifier
+      when /^(si:|sl:|ii:|=|\^)$/
+        return ""
+      when /^(\^|ii:)\s*(.*)/ #identifiers starts with ^ or ii:
+        return $2
+      when /^(=|sl:)\s*(.+)/ #identifier starts with = or sl:
+        return $2
+      when /^(si:)\s*(.+)/ #identifier starts with si:
+        return $2
+      else #identifier does not start with a special character
+        return identifier.lstrip #lstrip: leading whitespace chars removed
+      end
+    end
+
+  end
+end

data/lib/rtm/sugar/topic_map/scoped.rb

@@ -17,6 +17,18 @@ module RTM::Sugar
         scoped_index.getAssociationThemes
       end
 
+      # Returns all topics in the topic map used
+      # in the scope property of Associations sorted by their best names.
+      #
+      # The result may be empty.
+      #
+      # :call-seq:
+      #   association_themes -> Array of Topics sorted by their best_name
+      #
+      def association_themes_sorted(by_what = :best_name)
+        scoped_index.getAssociationThemes.sort_by(&by_what)
+      end
+
       # Returns all topics in the topic map used
       # in the scope property of Names.
       #
@@ -27,6 +39,16 @@ module RTM::Sugar
         scoped_index.getNameThemes
       end
 
+      # Returns all topics in the topic map used
+      # in the scope property of Names sorted by their best names.
+      #
+      # :call-seq:
+      #   name_themes -> Array of Topics sorted by their best_name
+      #
+      def name_themes_sorted(by_what = :best_name)
+        scoped_index.getNameThemes.sort_by(&by_what)
+      end
+
       # Returns all topics in the topic map used
       # in the scope property of Occurrences.
       #
@@ -37,6 +59,16 @@ module RTM::Sugar
         scoped_index.getOccurrenceThemes
       end
 
+      # Returns all topics in the topic map used
+      # in the scope property of Occurrences sorted by their best names.
+      #
+      # :call-seq:
+      #   occurrence_themes -> Array of Topics sorted by their best_name
+      #
+      def occurrence_themes_sorted(by_what = :best_name)
+        scoped_index.getOccurrenceThemes.sort_by(&by_what)
+      end
+
       # Returns all topics in the topic map used
       # in the scope property of Variants.
       #
@@ -47,6 +79,16 @@ module RTM::Sugar
         scoped_index.getVariantThemes
       end
 
+      # Returns all topics in the topic map used
+      # in the scope property of Variants sorted by their best names.
+      #
+      # :call-seq:
+      #   variant_themes -> Array of Topics sorted by their best_name
+      #
+      def variant_themes_sorted(by_what = :best_name)
+        scoped_index.getVariantThemes.sort_by(&by_what)
+      end
+
     end
   end
 end

data/lib/rtm/sugar/topic_map/types.rb

@@ -15,6 +15,16 @@ module RTM::Sugar
         type_instance_index.getAssociationTypes
       end
 
+      # Returns all topics in this topic map that are used
+      # as types of associations sorted by their best names.
+      #
+      # :call-seq:
+      #   association_types -> Array of Topics sorted by their best names
+      #
+      def association_types_sorted(by_what = :best_name)
+        type_instance_index.getAssociationTypes.sort_by(&by_what)
+      end
+
       # Returns the all Topics in this TopicMap that are used
       # as types of Roles.
       #
@@ -25,6 +35,16 @@ module RTM::Sugar
         type_instance_index.getRoleTypes
       end
 
+      # Returns the all Topics in this TopicMap that are used
+      # as types of Roles sorted by their best names.
+      #
+      # :call-seq:
+      #   role_types -> Array of Topics sorted by their best names
+      #
+      def role_types_sorted(by_what = :best_name)
+        type_instance_index.getRoleTypes.sort_by(&by_what)
+      end
+
       # Returns all Topics in this TopicMap that are used
       # as types of Names.
       #
@@ -35,6 +55,16 @@ module RTM::Sugar
         type_instance_index.getNameTypes
       end
 
+      # Returns all Topics in this TopicMap that are used
+      # as types of Names sorted by their best names.
+      #
+      # :call-seq:
+      #   name_types -> Array of Topics sorted by their best names
+      #
+      def name_types_sorted(by_what = :best_name)
+        type_instance_index.getNameTypes.sort_by(&by_what)
+      end
+
       # Returns all Topics in this TopicMap that are used
       # as types of Occurrences.
       #
@@ -45,6 +75,22 @@ module RTM::Sugar
         type_instance_index.getOccurrenceTypes
       end
 
+      # Returns all Topics in this TopicMap that are used
+      # as types of Occurrences sorted by their best names.
+      #
+      # :call-seq:
+      #   occurrence_types -> Array of Topics sorted by their best names
+      #
+      def occurrence_types_sorted(by_what = :best_name)
+        type_instance_index.getOccurrenceTypes.sort_by(&by_what)
+      end
+
+      # Returns all Topics that are no type of any kind
+      def individuals
+        all_types = types.to_a + association_types.to_a + role_types.to_a + name_types.to_a + occurrence_types.to_a
+        topics.to_a - all_types
+      end
+
     end
   end
 end

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

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

data/lib/rtm/version.rb

@@ -23,10 +23,9 @@ module RTM # :nodoc:
 
       MAJOR  = 0
       MINOR  = 3
-      TINY   = 0
+      TINY   = 1
       BUILD  = ENV['BUILD_NUMBER'] || COMPACTDATE
 
-      #STRING = [MAJOR, MINOR, TINY, BUILD].compact.join('.')
       STRING = [MAJOR, MINOR, TINY].compact.join('.')
 
       SUMMARY = "rtm #{STRING}"