rtm 0.1.6 → 0.2.0

data/lib/rtm/axes/topics.rb

@@ -0,0 +1,280 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module RTM::Axes
+  module Topics
+
+    def self.extended(k)
+      k.extend ArrayProxy
+    end
+
+    def result
+      self.map{|i| i.construct}
+    end
+    alias :tmapi :result
+
+    # ---- characteristics-axis ----------------------------------------------#
+    
+    # Returns all Names and Occurrences of these Topics.
+    # If an identifier is given, only those Names and Occurrences are returned,
+    # whose type or supertypes include the identifier.
+    #
+    # Identifier may be a Topic or Topic-Reference.
+    #
+    # The result may be empty.
+    #
+    # :call-seq:
+    #   characteristics -> Array of Names and Occurrences
+    #   characteristics(identifier) -> Array of Names and Occurrences
+    #
+    def characteristics(type=:any)
+      _res = self.inject([]){|all,containee| all << containee.send(:characteristics,type)}.flatten
+      ### NO UNIQUE NEEDED
+      _res = _res.extend(Characteristics)
+      _res
+    end
+
+    # ---- indicators-axis ---------------------------------------------------#
+    
+    # Returns all indicators (subject identifiers) of these Topics.
+    #
+    # The result may be empty.
+    #
+    # :call-seq:
+    #   indicators -> Array of Strings
+    #
+    def indicators
+      #self = Array of TopicProxies
+      #containee: RTM::Axes::Topic
+      #send -> Array of Strings
+      self.inject([]){|all,containee| all << containee.send(:indicators)}.flatten
+      ### NO UNIQUE NEEDED
+    end
+
+    # ---- item-axis ---------------------------------------------------------#
+    
+    # Returns one item identifier for each of these Topics, only if
+    # if the Topic has an item identifier.
+    #
+    # The result may be an empty Array.
+    # 
+    # :call-seq:
+    #   item -> Array of Strings
+    #
+    def item
+      #self = Array of TopicProxies
+      #containee: RTM::Axes::Topic
+      #send -> Array of (String or nil)s
+      _res = self.inject([]){|all,containee| all << containee.send(:item)}.flatten
+      _res = _res.select{|i| i}
+      ### NO UNIQUE NEEDED
+    end
+
+    # ---- locators-axis -----------------------------------------------------#
+    
+    # Returns all subject locators of these Topics.
+    #
+    # The result may be empty.
+    #
+    # :call-seq:
+    #   locators -> Array of Strings
+    #
+    def locators
+      self.inject([]){|all,containee| all << containee.send(:locators)}.flatten
+      ### NO UNIQUE NEEDED
+    end
+
+    # ---- players-axis ------------------------------------------------------#
+    
+    # Returns all Associations in which these Topics play a Role.
+    #
+    # The optional
+    # identifier specifies the type of the Roles to be considered.
+    # The identifier may be a Topic or Topic-Reference.
+    #
+    # Multiple instances of the same Association are possible.
+    # The result may be empty.
+    #
+    # :call-seq:
+    #   reverse_players -> Array of Associations
+    #   reverse_players(identifier) -> Array of Associations
+    #
+    def reverse_players(type=:any)
+      _res = self.inject([]){|all,containee| all << containee.send(:reverse_players,type)}.flatten
+      ### NO UNIQUE ###
+      _res = _res.extend(Associations)
+      _res
+    end
+
+    # ---- reifier-axis ------------------------------------------------------#
+    
+    # Returns the Constructs which are reified by one of these Topics
+    # only if such Constructs exist.
+    #
+    # :call-seq:
+    #   reifier -> Array of Associations, Names and Occurrences
+    #
+    def reifier
+      _res = self.inject([]){|all,containee| all << containee.send(:reifier)}.flatten
+      _res = _res.select{|i| i} #reject nil
+      ### NO UNIQUE NEEDED
+      _res = _res.extend(AssocsNamesOccs)
+      _res
+    end
+
+    # ---- roles-axis --------------------------------------------------------#
+    
+    # Returns all Associations that have Roles that have one of
+    # these Topics as Roletype. Multiple instances of the same
+    # Association are possible.
+    #
+    # The result may be empty.
+    #
+    # :call-seq:
+    #   reverse_roles -> Array of Associations
+    #
+    def reverse_roles
+      _res = self.inject([]){|all,containee| all << containee.send(:reverse_roles)}.flatten
+      ### NO UNIQUE ###
+      _res = _res.extend(Associations)
+      _res
+    end
+
+    # ---- scope-axis --------------------------------------------------------#
+    
+    # Returns all Associations, Names and Occurrences that include at least one of these
+    # Topics (themes) in their scope.
+    #
+    # The result may be empty.
+    #
+    # :call-seq:
+    #   reverse_scope -> Array of Names, Associations and Occurrences
+    #
+    def reverse_scope
+      _res = self.inject([]){|all,containee| all << containee.send(:reverse_scope)}.flatten
+      ### FLAG UNIQUE ###
+      _res = _res.map{|i| i.construct}.uniq.map{|i| i.axes}
+       ###             ###
+      _res = _res.extend(AssocsNamesOccs)
+      _res
+    end
+
+    # ---- supertypes-axis ---------------------------------------------------#
+    
+    # Returns all supertypes of all of these Topics. The result includes 
+    # all direct supertypes
+    # and the supertypes of these direct supertypes.
+    #
+    # The result may be an empty Array.
+    #
+    # :call-seq:
+    #   supertypes -> Array of Topics
+    #
+    def supertypes
+      _res = self.define_helper(:supertypes)
+      #_res = self.inject([]){|all,containee| all << containee.send(:supertypes)}.flatten
+      ### FLAG UNIQUE ###
+      _res = _res.map{|i| i.construct}.uniq.map{|i| i.axes}
+      ###             ###
+      _res = _res.extend(Topics)
+      _res
+    end
+
+    # Returns all subtypes of all of these Topics. The result includes the direct subtypes
+    # and the subtypes of these direct subtypes.
+    #
+    # The result may be an empty Array.
+    #
+    # :call-seq:
+    #   subtypes -> Array of Topics
+    #
+    def subtypes
+      _res = self.inject([]){|all,containee| all << containee.send(:subtypes)}.flatten
+       ### FLAG UNIQUE ###
+      _res = _res.map{|i| i.construct}.uniq.map{|i| i.axes}
+       ###             ###
+      _res = _res.extend(Topics)
+      _res
+    end
+    
+    alias reverse_subtypes supertypes
+    alias reverse_supertypes subtypes
+
+    # ---- traverse-axis ---------------------------------------------------#
+    
+    # First computes all Associations where these Topics play a Role.
+    # There, the optional identifier filters the Associations for their type.
+    # 
+    # Returns all Players of all Roles in these Associations.
+    # Each Topic is deducted ones from the returned Array.
+    # The result may be empty.
+    #
+    # The identifier may be a Topic or Topic-Reference.
+    #
+    # :call-seq:
+    #   traverse(identifier) -> Array of Topics
+    #
+    def traverse(type=:any)
+      _res = self.inject([]){|all,containee| all << containee.send(:traverse,type)}.flatten
+      ### NO UNIQUE ###
+      _res = _res.extend(Topics)
+      _res
+    end
+    
+    # Always returns an empty Array
+    #
+    # :call-seq:
+    #   reverse_traverse -> Array of Topics
+    #
+    def reverse_traverse
+      _res = [] #HARDCODED
+      _res.extend(Topics)
+    end
+
+    # ---- types-axis --------------------------------------------------------#
+    
+    # Returns the Topics these Topics are instances of. Calls
+    # the TMAPI getTypes method.
+    #
+    # The result may be empty.
+    #
+    # :call-seq:
+    #   types -> Array of Topics
+    #
+    def types
+      #self = Array of TopicProxies
+      #containee: RTM::Axes::Topic
+      #send -> Array of TopicProxies
+      #uniq -> Topics in Array, call unique on Array
+      #convert to TopicProxies again
+      #extend result-Array
+      _res = self.inject([]){|all,containee| all << containee.send(:types)}.flatten
+       ### FLAG UNIQUE ###
+      _res = _res.map{|i| i.construct}.uniq.map{|i| i.axes}
+       ###             ###
+      _res.extend(Topics)
+      _res
+    end
+    
+    # Returns the Topics which are instances of these Topics.
+    # Uses the TMAPI TypeInstanceIndex.
+    #
+    # The result may be empty.
+    #
+    # :call-seq:
+    #   instances -> Array of Topics
+    #
+    def instances
+      _res = self.inject([]){|all,containee| all << containee.send(:instances)}.flatten
+       ### FLAG UNIQUE ###
+      _res = _res.map{|i| i.construct}.uniq.map{|i| i.axes}
+       ###             ###
+      _res.extend(Topics)
+      _res
+    end
+    
+    alias reverse_types instances
+    alias reverse_instances types
+
+  end  
+end

data/lib/rtm/{backward_compatibility.rb → deprecated/index_property_set.rb}

@@ -1,3 +1,6 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
 class RTM::AR::Topic
   extend RTM::AR::TraverseAssociations
   def self.index_property_set(*args)

data/lib/rtm/engine.rb

@@ -0,0 +1,58 @@
+module RTM
+  class Engine    
+    def self.abstract?
+      self == Engine
+    end
+
+    def self.inherited(subclass)
+      Engine.add(subclass) # this MUST be Engine and not self! Otherwise every intermediate class in the inheritance chain will have it's own list
+    end
+    
+    def self.add(engine)
+      @engines ||= []
+      @engines << engine
+    end
+    
+    def self.identifier(i=nil)
+      if i
+        # setter / declaration
+        @identifier = i
+      else
+        # getter
+        @identifier
+      end
+    end
+    
+    def self.all
+      @engines ||= []
+      @engines.reject!{|e| e.abstract?} # this needs to be done here because in the inherited hook the method is not yet available.
+      @engines
+    end
+    
+    def self.list
+      all.map{|e| e.identifier}
+    end
+    
+    def self.[](identifier)
+      all.find {|e| e.identifier == identifier}
+    end
+    
+    def self.load(engine_name)
+      begin
+        require "rtm/#{engine_name}"
+      rescue LoadError
+        engine_path = File.expand_path(File.join(File.dirname(__FILE__), "../../../rtm-#{engine_name}/lib"))
+        if File.directory?(engine_path)
+          $:.unshift engine_path
+          require "rtm/#{engine_name}"
+        end
+      end
+    end
+    
+    attr_reader :connections
+    def initialize(params={})
+      @params = params
+    end
+    
+  end
+end

data/lib/rtm/extensions.rb

@@ -1,3 +1,6 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
 module RTM
   # Register a module as extension.
   # 
@@ -16,4 +19,11 @@ module RTM
       const_get(const).send(:include, plugin_mod.const_get(const) ) if const_defined?(const)
     end
   end
-end
+  module AR
+    def self.register_extension(plugin_mod)
+      plugin_mod.constants.each do |const|
+        const_get(const).send(:include, plugin_mod.const_get(const) ) if const_defined?(const)
+      end
+    end
+  end
+end

data/lib/rtm/{locator_helpers.rb → helpers/locator.rb}

@@ -1,3 +1,6 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
 module RTM
   # Some helpers for locators which could ideally mixed into String and Locator.
   # Anyway, they are not here to not clutter up the namespace too much.
@@ -5,7 +8,9 @@ module RTM
     # removes "=" (and possible whitespace thereafter) from the beginning of a String or Locator if it is there
     def self.slo2iri(slo)
       slo = slo.to_s
-      slo = slo[1..-1].lstrip if slo[0] == "="[0] # remove = if slo starts with it
+      slo =~ /^(=|sl:)\s*(.+)/
+      return $2 if $2 
+      # old: slo[1..-1].lstrip if slo[0] == "="[0] # remove = if slo starts with it
       slo
     end
 
@@ -17,7 +22,8 @@ module RTM
 
     # returns true if the String or Locator given starts with "=" 
     def self.is_a_slo?(iri)
-      iri.to_s[0] == "="[0]
+      # iri.to_s[0] == "="[0] # old version
+      iri =~ /^(=|sl:)\s*(.+)/
     end
 
     def self.iid2iri(slo)
@@ -33,7 +39,12 @@ module RTM
     # returns true if the String or Locator given starts with "^".
     # This catches only the prefixing-style, not the local-identifier (non-absolute-iri) style
     def self.is_a_iid?(iri)
-      iri.to_s[0] == "^"[0]
-    end    
+      iri =~ /^(\^|ii:)\s*(.*)/
+      # iri.to_s[0] == "^"[0] # old version
+    end
+    
+    def self.is_a_sid?(iri)
+      iri =~ /^(si:)\s*(.+)/
+    end
   end
 end

data/lib/rtm/{helpers.rb → helpers/no_output.rb}

@@ -1,3 +1,6 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
 # Executes the given block while suppressing all standard output.
 def no_output
   $stdout = File.open( PLATFORM =~ /mswin/ ? "NUL" : "/dev/null", "w" )

data/lib/rtm/helpers/uri.rb

@@ -0,0 +1,13 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module RTM::RTM
+  def is_uri?(test)
+   begin
+    URI(test)
+    rescue Exception => e
+   end
+
+   e ? false : true
+  end
+end

data/lib/rtm/io.rb

@@ -0,0 +1,18 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+require 'rtm/io/to_rdf'
+require 'rtm/io/to_hash'
+
+
+# Check if JSON is available and load JTM if it is
+if Object.const_defined?(:JSON)
+  require 'rtm/io/to_jtm'
+end
+# old code to check for JSON (has Gem-dependency)
+#require 'rtm/io/to_jtm' unless (Gem.source_index.find_name('json/ext').empty? && Gem.source_index.find_name('json/pure').empty?) 
+
+
+require 'rtm/io/to_yaml'
+require 'rtm/io/tmapix'
+require 'rtm/io/to_string'