rtm 0.2.1 → 0.3.0

data/lib/rtm/io/to_rdf.rb

@@ -18,7 +18,7 @@ module RTM::IO
       #
       def to_rdf
         case self
-          when net.ontopia.topicmaps.impl.tmapi2.TopicMapImpl then to_rdf_ontopia
+          when Java::NetOntopiaTopicmapsImplTmapi2::TopicMapImpl then to_rdf_ontopia
           else raise "Not supported for #{self}"
         end
       end

data/lib/rtm/io/to_string.rb

@@ -5,6 +5,14 @@ module RTM::IO
   # Each Topic Maps Construct gets a custom to_s method which supports optional :short or :long output.
   module ToString
 
+    module Construct
+      def delocatorized(identifier_list)
+        identifier_list.map do |locator|
+          locator.value
+        end.inspect
+      end
+    end
+    
     module TopicMap
       # Returns different String representations. Try :short (default), :long, :super (original)
       def to_s(style=:short)
@@ -27,14 +35,14 @@ module RTM::IO
       def to_s(style=:short)
         case style
         when :short
-          ssid = " sids=#{subject_identifiers.to_s}" unless subject_identifiers.empty?
-          sslo = " slos=#{subject_locators.to_s}" unless subject_locators.empty?
-          siid = " iids=#{item_identifiers.to_s}" unless item_identifiers.empty?
+          ssid = " sids=#{delocatorized subject_identifiers}" unless subject_identifiers.empty?
+          sslo = " slos=#{delocatorized subject_locators}" unless subject_locators.empty?
+          siid = " iids=#{delocatorized item_identifiers}" unless item_identifiers.empty?
           "#<RTM::Topic id=#{id}#{ssid}#{sslo}#{siid}>"
         when :long
-          ssid = " sids=#{subject_identifiers.to_s}" unless subject_identifiers.empty?
-          sslo = " slos=#{subject_locators.to_s}" unless subject_locators.empty?
-          siid = " iids=#{item_identifiers.to_s}" unless item_identifiers.empty?
+          ssid = " sids=#{delocatorized subject_identifiers}" unless subject_identifiers.empty?
+          sslo = " slos=#{delocatorized subject_locators}" unless subject_locators.empty?
+          siid = " iids=#{delocatorized item_identifiers}" unless item_identifiers.empty?
           "#<RTM::Topic id=#{id}#{ssid}#{sslo}#{siid} names:#{names.size} occurrences:#{occurrences.size}>"
         when :name
           return names.first.to_s(:short) if names.first
@@ -50,11 +58,11 @@ module RTM::IO
         case style
         when :short
           r = " #{reifier.to_s(:short)}" if reifier
-          i = " iids=#{item_identifiers.to_s}" unless item_identifiers.empty?
+          i = " iids=#{delocatorized item_identifiers}" unless item_identifiers.empty?
           "#<RTM::Association id=#{id}#{i}#{r}>"
         when :long
           r = " #{reifier.to_s(:short)}" if reifier
-          i = " iids=#{item_identifiers.to_s}" unless item_identifiers.empty?
+          i = " iids=#{delocatorized item_identifiers}" unless item_identifiers.empty?
           "#<RTM::Association id=#{id}#{i}#{r} type=#{type.to_s(:short)} roles=[#{roles.entries.map { |ar| ar.to_s(:long) }.join(", ")}]>"
         else
           super() # these () are needed, otherwise the own parameters are passed in
@@ -67,12 +75,12 @@ module RTM::IO
         case style
         when :short
           r = " #{reifier.to_s(:short)}" if reifier
-          i = " iids=#{item_identifiers.to_s}" unless item_identifiers.empty?
+          i = " iids=#{delocatorized item_identifiers}" unless item_identifiers.empty?
           "#<RTM::Role id=#{id}#{i}#{r}>"
         when :long
           r = " #{reifier.to_s(:short)}" if reifier
-          i = " iids=#{item_identifiers.to_s}" unless item_identifiers.empty?
-          "#<RTM::Association id=#{id}#{i}#{r} type=#{type.to_s(:short)} player=#{player.to_s(:short)}>"
+          i = " iids=#{delocatorized item_identifiers}" unless item_identifiers.empty?
+          "#<RTM::Role id=#{id}#{i}#{r} type=#{type.to_s(:short)} player=#{player.to_s(:short)}>"
         else
           super() # these () are needed, otherwise the own parameters are passed in
         end
@@ -86,7 +94,7 @@ module RTM::IO
           value
         when :long
           r = " #{reifier.to_s(:short)}" if reifier
-          i = " iids=#{item_identifiers.to_s}" unless item_identifiers.empty?
+          i = " iids=#{delocatorized item_identifiers}" unless item_identifiers.empty?
           "#<RTM::Name id=#{id}#{i}#{r} type=#{type.to_s(:short)} value=#{value} variants:#{variants.size}>"
         else
           super() # these () are needed, otherwise the own parameters are passed in
@@ -101,7 +109,7 @@ module RTM::IO
           value
         when :long
           r = " #{reifier.to_s(:short)}" if reifier
-          i = " iids=#{item_identifiers.to_s}" unless item_identifiers.empty?
+          i = " iids=#{delocatorized item_identifiers}" unless item_identifiers.empty?
           "#<RTM::Occurrence id=#{id}#{i}#{r} type=#{type.to_s(:short)} value=#{value} datatype=#{datatype}>"
         else
           super() # these () are needed, otherwise the own parameters are passed in
@@ -116,7 +124,7 @@ module RTM::IO
           value
         when :long
           r = " #{reifier.to_s(:short)}" if reifier
-          i = " iids=#{item_identifiers.to_s}" unless item_identifiers.empty?
+          i = " iids=#{delocatorized item_identifiers}" unless item_identifiers.empty?
           "#<RTM::Variant id=#{id}#{i}#{r} value=#{value} scope=[scope.to_s]>"
         else
           super() # these () are needed, otherwise the own parameters are passed in

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

@@ -78,7 +78,7 @@ module RTM
       #   transitive_supertypes_with_self -> Array of Topics
       #
       def transitive_supertypes_with_self
-        transitive_supertypes + self
+        transitive_supertypes + [self]
       end
       
       # Returns all Topics that exist in binary supertype-subtype Associations
@@ -153,7 +153,7 @@ module RTM
       #   transitive_subtypes_with_self -> Array of Topics
       #
       def transitive_subtypes_with_self
-        transitive_subtypes + self
+        transitive_subtypes + [self]
       end
       
       alias :supertypes :transitive_supertypes

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

@@ -41,7 +41,7 @@ module RTM
       #   instances -> Set of Topics
       #
       def instances
-        type_instance_index.getTopics(self)
+        topic_map.type_instance_index.getTopics(self)
       end
       
       # Returns the instance of this Topic. It must have exactly one

data/lib/rtm/psi.rb

@@ -100,11 +100,13 @@ module RTM
   PSI1[:display] = "http://www.topicmaps.org/xtm/1.0/core.xtm#display"
 
   PREFIX = {}
-  PREFIX[:tm] = "http://psi.topicmaps.org/iso13250/model/" # This is the namespace for the concepts defined by TMDM.
+  PREFIX[:tmdm] = "http://psi.topicmaps.org/iso13250/model/" # This is the namespace for the concepts defined by TMDM.
   PREFIX[:glossary] = "http://psi.topicmaps.org/iso13250/glossary/"
   PREFIX[:xsd] = "http://www.w3.org/2001/XMLSchema#" # This is the namespace for the XML Schema Datatypes.
   PREFIX[:tmql] = "http://psi.topicmaps.org/tmql/1.0/" # Under this prefix the concepts of Axes itself are located.
   PREFIX[:fn] = "http://psi.topicmaps.org/tmql/1.0/functions"  # Under this prefix user-callable functions of the predefined Axes environment are located.
   PREFIX[:xtm1] = "http://www.topicmaps.org/xtm/1.0/core.xtm#"
   PREFIX[:language] = "http://psi.oasis-open.org/iso/639/#" # This is the namespace for the languae PSIs
+  PREFIX[:tmcl] = "http://psi.topicmaps.org/tmcl/"
+  PREFIX[:iso] = "http://psi.topicmaps.org/iso13250/"
 end

data/lib/rtm/sugar.rb

@@ -37,11 +37,16 @@ require 'rtm/sugar/reifiable/reifier'
 RTM::Reifiable.register_extension(RTM::Sugar::Reifiable::CreateReifier)
 
 require 'rtm/sugar/topic_map/query_cache'
-require 'rtm/sugar/topic_map/themes'
+require 'rtm/sugar/topic_map/scoped'
+require 'rtm/sugar/topic_map/types'
+require 'rtm/sugar/topic_map/remove'
 module RTM::TopicMap
-  include RTM::Reifiable
   @query_cache = nil #disables query caching
 end
 RTM::TopicMap.register_extension(RTM::Sugar::TopicMap::QueryCache)
-RTM::TopicMap.register_extension(RTM::Sugar::TopicMap::Themes)
+RTM::TopicMap.register_extension(RTM::Sugar::TopicMap::Scoped)
+RTM::TopicMap.register_extension(RTM::Sugar::TopicMap::Types)
+RTM::TopicMap.register_extension(RTM::Sugar::TopicMap::Remove)
 
+require "rtm/sugar/variant/topic"
+RTM::Variant.register_extension(RTM::Sugar::Variant::Topic)

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

@@ -5,70 +5,51 @@ module RTM::Sugar::Topic::BestName
 
   # Tries to find the best matching name for a given topic.
   #
-  def best_name (theme = nil)
+  def best_name(theme = nil)
     all_names = self.names
 
     # return last part of identifier if no name exist
-    return find_user_friendly_identifier(self) if all_names.empty
+    return find_user_friendly_identifier if all_names.empty
 
-    # collect name with default name type
-    default_names = []
-    all_names.each do |name|
-      type_of_name = name.getType
-
-      next if type_of_name.nil?
-      type_identifiers = type_of_name.subject_identifiers.to_a
+    resulting_names = []
 
-      type_identifiers.each do |i|
-        if i.toExternalForm == RTM::PSI[:name_type] then
-          default_names << name
-          break
-        end
+    if theme
+      resulting_names = self["- @#{theme.reference}"]
+      if resulting_names.empty?
+        resulting_names = all_names.select{|name| name.scope.include?(theme)}
       end
     end
 
-    default_names = all_names if default_names.empty?
-    default_names = default_names.select { |name| not name.scope.to_a.index(theme).nil? } if not theme.nil?
-    default_names = all_names if default_names.empty?
-
-    # get default name with the minimum number of scopes
-    min_scoped_name = default_names.sort_by{|n| n.value}.min {|n1,n2| n1.getScope.size <=> n2.getScope.size}
-    min_scoped_name.value
-  end
-
-  private
-  def find_user_friendly_identifier(topic)
-    return psi_prefix topic.
-      subject_identifiers.
-      sort_by{|sid| sid.value.length}.
-      first.
-      value unless topic.subject_identifiers.empty?
+    # collect name with default name type
+    if resulting_names.empty?
+      resulting_names = self["-"]
+    end
 
-    return topic.
-      topic_references.
-      map{|sid| sid.gsub /^[\^=]/, ''}.
-      sort_by{|sid| sid.length }.
-      first
+    # use all names
+    if resulting_names.empty?
+      resulting_names = all_names
+    end
 
-    # fallback
-    return create_shortest_topic_identifier topic
+    # get the name with the smalles scope and smallest value
+    min_scoped_name = resulting_names.sort_by{|name| [name.scope.size, name.value.length, name.value]}.first
+    return min_scoped_name.value
   end
 
-  def create_shortest_topic_identifier(topic)
-    base_iri = topic.topic_map.base_locator
-
-    topic.getItemIdentifiers.each do |item_identifier|
-      iid_iri = item_identifier.value
-      iid_iri.scan(/(file:)?\/*#{base_iri}#(.*)/) { |pair| return "^#{pair[1]}" }
-    end
+  # Returns the shortest most significant identifier in yaml-style.
+  def shortest_topic_identifier
+    return self.references(:outputstyle => :yaml, :resolve_qnames => :true, :resolve_base_iri => :true, :sort_by_length => :true).
+      first unless references.empty?
 
-    CGI::escape(topic.topic_references.sort_by { |reference| reference.length }.first.to_s)
-
-    # throw('Unable to create simplified identifier from topic.', topic)
+    raise("Runtime Exception: Topic has no identifiers.")
   end
 
-  # HACK
-  def psi_prefix(name)
-    name.gsub /^http\:\/\/psi\.topicmaps\.org\/iso13250\/model\//, 'tmdm:'
+  private
+  # Returns a subject identifier, subject locator or item identifier in this
+  # preference. Qnames will be resolved backwards.
+  def find_user_friendly_identifier
+    return self.references(:outputstyle => :blank, :resolve_qnames => :true, :resolve_base_iri => :true, :sort_by_length => :true).
+      first unless references.empty?
+
+    raise("Runtime Exception: Topic has no identifiers.")
   end
 end

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

@@ -13,7 +13,7 @@ module RTM::Sugar::Topic
     #
     def scoped
       _index = scoped_index
-      _index.get_associations(self).to_a + _index.get_names(self).to_a + _index.get_occurrences(self).to_a + _index.get_variants(self).to_a
+      _index.getAssociations(self).to_a + _index.getNames(self).to_a + _index.getOccurrences(self).to_a + _index.getVariants(self).to_a
     end
 
     # Returns the Associations whose scope contains this Topic.
@@ -21,10 +21,10 @@ module RTM::Sugar::Topic
     # The result may be empty.
     #
     # :call-seq:
-    #   scoped_associations -> Array of Associations
+    #   scoped_associations -> Collection of Associations
     #
     def scoped_associations
-      scoped_index.get_associations(self).to_a
+      scoped_index.getAssociations(self)
     end
 
     # Returns the Names whose scope contains this Topic.
@@ -32,19 +32,19 @@ module RTM::Sugar::Topic
     # The result may be empty.
     #
     # :call-seq:
-    #   scoped_names -> Array of Names
+    #   scoped_names -> Collection of Names
     #
     def scoped_names
-      scoped_index.get_names(self).to_a
+      scoped_index.getNames(self)
     end
 
     # Returns the Occurrences whose scope contains this Topic.
     #
     # :call-seq:
-    #   scoped_occurrences -> Array of Occurrences
+    #   scoped_occurrences -> Collection of Occurrences
     #
     def scoped_occurrences
-      scoped_index.get_occurrences(self).to_a
+      scoped_index.getOccurrences(self)
     end
 
     # Returns the Variants whose scope (including the scope of the parent Name)
@@ -53,10 +53,10 @@ module RTM::Sugar::Topic
     # The result may be empty.
     #
     # :call-seq:
-    #   scoped_variants -> Array of Variants
+    #   scoped_variants -> Collection of Variants
     #
     def scoped_variants
-      scoped_index.get_variants(self).to_a
+      scoped_index.getVariants(self)
     end
 
     # States if this topic occurs as theme in the scope of a scoped Construct.

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

@@ -1,86 +1,129 @@
 # Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
 # License:   Apache License, Version 2.0
 
-module RTM::Sugar
-  module Topic
-    module TopicRef
+module RTM::Sugar::Topic
+  module TopicRef
       
-      # Returns an Array including all identifiers of this Topic.
-      #
-      # This method takes a Hash as argument.
-      #
-      # The key :ouputstyle defines if the ctm style (value :ctm, this is
-      # the default), the YAML
-      # style (value :yaml) or no style (value :blank) is supported.
-      #
-      # In ctm style an item identifier starts with a "^",
-      # a subject locator starts with a "=" and
-      # a subject identifiers contains no prefix.
-      #
-      # In yaml style an item identifiers start with a "ii:",
-      # a subject locator starts with a "sl:" and
-      # a subject identifier start with a "si:".
-      #
-      # :call-seq:
-      #     references -> Array of Strings
-      #     references(params = {}) -> Array of Strings
-      #
-      def references(params = {})
-        default_hash = {:outputstyle => :ctm, :resolve_qnames => :false}
-        params = default_hash.merge(params) if params.is_a? Hash
-        
-        case params[:outputstyle]
-        when :yaml
-            identifiers = subject_identifiers.map{|si| "si:#{si.reference}"} +
-                          subject_locators.map{   |sl| "sl:#{sl.reference}"} +
-                          item_identifiers.map{   |ii| "ii:#{ii.reference}"}
-        when :blank
-            identifiers = subject_identifiers.map{|si| si.reference} +
-                          subject_locators.map{   |sl| sl.reference} +
-                          item_identifiers.map{   |ii| ii.reference}
-        else #:ctm default
-            identifiers = subject_identifiers.map{|si| si.reference} +
-                          subject_locators.map{   |sl| "=#{sl.reference}"} +
-                          item_identifiers.map{   |ii| "^#{ii.reference}"}
+    # Returns an Array including all identifiers of this Topic.
+    #
+    # This method takes a Hash as argument.
+    #
+    # The key :ouputstyle defines if the ctm style (value :ctm, this is
+    # the default), the YAML
+    # style (value :yaml) or no style (value :blank) is supported.
+    #
+    # In ctm style an item identifier starts with a "^",
+    # a subject locator starts with a "=" and
+    # a subject identifiers contains no prefix.
+    #
+    # In yaml style an item identifiers start with a "ii:",
+    # a subject locator starts with a "sl:" and
+    # a subject identifier start with a "si:".
+    #
+    # :call-seq:
+    #     references -> Array of Strings
+    #     references(params = {}) -> Array of Strings
+    #
+    def references(params = {})
+      default_hash = {:outputstyle => :ctm, :resolve_qnames => :false, :resolve_base_iri => :false, :sort_by_length => :false}
+      params = default_hash.merge(params) if params.is_a? Hash
+      prefixes = topic_map.prefixes
+
+      set_of_si = subject_identifiers.map{|si| si.reference}
+      set_of_sl = subject_locators.map{|si| si.reference}
+      set_of_ii = item_identifiers.map{|si| si.reference}
+
+      if params[:resolve_qnames] == :true
+        unless prefixes.empty?
+          prefixes.each do |identifier, reference|
+            set_of_si = set_of_si.map{|si| si.index(reference) == 0 ? si.sub(reference, identifier + ":") : si}
+            set_of_sl = set_of_sl.map{|sl| sl.index(reference) == 0 ? sl.sub(reference, identifier + ":") : sl}
+            set_of_ii = set_of_ii.map{|ii| ii.index(reference) == 0 ? ii.sub(reference, identifier + ":") : ii}
+          end
         end
-        return identifiers
       end
 
-      # Returns one identifier of this topic. If several exist, the shortest one
-      # is returned.
-      #
-      # This method takes a Hash as argument.
-      #
-      # The key :ouputstyle defines if the ctm style (value :ctm, this is
-      # the default), the YAML
-      # style (value :yaml) or no style (value :blank) is supported.
-      #
-      # In ctm style an item identifier starts with a "^",
-      # a subject locator starts with a "=" and
-      # a subject identifiers contains no prefix.
-      #
-      # In yaml style an item identifiers start with a "ii:",
-      # a subject locator starts with a "sl:" and
-      # a subject identifier start with a "si:".
-      #
-      #
-      # :call-seq:
-      #     reference -> String
-      #     reference(params = {}) -> String
-      #
-      def reference(params = {})
-        return references(params).sort_by{|identifier| identifier.size}.reverse.first
+      if params[:resolve_base_iri] == :true
+        set_of_si = set_of_si.map{|si| unresolve(si)}
+        set_of_sl = set_of_sl.map{|sl| unresolve(sl)}
+        set_of_ii = set_of_ii.map{|ii| unresolve(ii)}
+      end
+
+      if params[:sort_by_length] == :true
+        set_of_si = set_of_si.sort_by{|si| si.length}
+        set_of_sl = set_of_sl.sort_by{|sl| sl.length}
+        set_of_ii = set_of_ii.sort_by{|ii| ii.length}
       end
 
-      # Returns all identifiers of this Topic as Array of Locators.
-      #
-      # :call-seq:
-      #   references_as_locators -> Array of Locators
-      #
-      def references_as_locators
-        subject_identifiers.to_a + subject_locators.to_a + item_identifiers.to_a
+      case params[:outputstyle]
+      when :yaml
+        identifiers = set_of_si.map{  |si| "si:#{si}"} +
+          set_of_sl.map{  |sl| "sl:#{sl}"} +
+          set_of_ii.map{  |ii| "ii:#{ii}"}
+      when :blank
+        identifiers = set_of_si +
+          set_of_sl +
+          set_of_ii
+      else #:ctm default
+        identifiers = set_of_si +
+          set_of_sl.map{  |sl| "=#{sl}"} +
+          set_of_ii.map{  |ii| "^#{ii}"}
       end
+      return identifiers
+    end
+
+    # Returns one identifier of this topic. If several exist, the shortest one
+    # is returned.
+    #
+    # This method takes a Hash as argument.
+    #
+    # The key :ouputstyle defines if the ctm style (value :ctm, this is
+    # the default), the YAML
+    # style (value :yaml) or no style (value :blank) is supported.
+    #
+    # In ctm style an item identifier starts with a "^",
+    # a subject locator starts with a "=" and
+    # a subject identifiers contains no prefix.
+    #
+    # In yaml style an item identifiers start with a "ii:",
+    # a subject locator starts with a "sl:" and
+    # a subject identifier start with a "si:".
+    #
+    #
+    # :call-seq:
+    #     reference -> String
+    #     reference(params = {}) -> String
+    #
+    def reference(params = {})
+      return references(params).sort_by{|identifier| identifier.size}.reverse.first
+    end
+
+    # Returns all identifiers of this Topic as Array of Locators.
+    #
+    # :call-seq:
+    #   references_as_locators -> Array of Locators
+    #
+    def references_as_locators
+      subject_identifiers.to_a + subject_locators.to_a + item_identifiers.to_a
+    end
 
+    # Unresolves the identifier against the base_iri.
+    def unresolve(identifier)
+      raise("identifier must be a String") unless identifier.is_a?(String)
+      base_iri = topic_map.base_iri
+      if identifier.index(base_iri) == 0
+        short_form = identifier.sub(base_iri, "")
+        if topic_map.create_locator(short_form).reference == identifier
+          return short_form
+        end
+#        if short_form[0] == "/"
+#          short_form = short_form.sub("/", "")
+#
+#        end
+      else
+        return identifier #nothing happened
+      end
     end
+
   end
 end