rtm 0.1.6 → 0.2.0

data/lib/rtm/axes/assocs_names_occs.rb

@@ -0,0 +1,56 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module RTM::Axes
+  module AssocsNamesOccs
+
+    def self.extended(k)
+      k.extend ArrayProxy
+    end
+
+    def result
+      self.map{|i| i.construct}
+    end
+    alias :tmapi :result
+
+    # ---- reifier-axis ------------------------------------------------------#
+    
+    # Returns the reifing Topics of these Characteristics and
+    # Associations only
+    # if such Topics exists.
+    #
+    # The result may be empty.
+    #
+    # :call-seq:
+    #   reverse_reified -> Array of Topics
+    #
+    def reverse_reifier
+      _res = self.inject([]){|all,containee| all << containee.send(:reverse_reifier)}.flatten
+      _res = _res.select{|i| i}
+      ### FLAG UNIQUE ###
+      _res = _res.map{|i| i.construct}.uniq.map{|i| i.axes}
+      ###             ###
+      _res.extend(Topics)
+    end
+
+    # ---- scope-axis --------------------------------------------------------#
+    
+    # Returns the scope of these Characteristics
+    # and Associations.
+    #
+    # The result may be empty.
+    #
+    # :call-seq:
+    #   scope -> Array of Topics
+    #
+    def scope
+      _res = self.inject([]){|all,containee| all << containee.send(:scope)}.flatten
+      ### FLAG UNIQUE ###
+      _res = _res.map{|i| i.construct}.uniq.map{|i| i.axes}
+      ###             ###
+      _res = _res.extend(Topics)
+      _res
+    end
+
+  end
+end

data/lib/rtm/axes/characteristic.rb

@@ -0,0 +1,68 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module RTM::Axes
+
+  class Characteristic < ItemProxy
+
+    # ---- atomify-axis ------------------------------------------------------#
+    
+    # Returns the atomic value of the Characteristic.
+    #
+    # :call-seq:
+    #   atomify -> String
+    #
+    def atomify
+      _res = @construct.atomify #String
+      RTM::Axes::String.new(_res,@tm)
+    end
+
+    # ---- characteristics-axis ----------------------------------------------#
+    
+    # Returns the Topic this Characteristic belongs to.
+    # The optional argument identifier filters the
+    # Characteristic for its type. If the type
+    # does not match, nil is returned.
+    #
+    # The identifier may be a Topic or Topic-Reference.
+    #
+    # :call-seq:
+    #   reverse_characteristics -> Topic
+    #   reverse_characteristics(identifier) -> Topic or nil
+    #
+    def reverse_characteristics(type=:any)
+      _res = @construct.reverse_characteristics(type) #Topic or nil
+      RTM::Axes::Topic.new(_res,@tm) if _res
+    end
+
+    # ---- reifier-axis ------------------------------------------------------#
+    
+    
+    # Returns the reifing Topic of this Characteristic or nil,
+    # if no such Topic exists.
+    #
+    # :call-seq:
+    #   reverse_reified -> Topic or nil
+    #
+    def reverse_reifier
+      _res = @construct.reifier #Topic or nil
+      RTM::Axes::Topic.new(_res,@tm) if _res
+    end
+
+    # ---- scope-axis --------------------------------------------------------#
+    
+    # Returns the scope of this Characteristic.
+    #
+    # The result may be empty.
+    #
+    # :call-seq:
+    #   scope -> Array of Topics
+    #
+    def scope
+      _res = @construct.scope.map{|r| r.axes}
+      _res.extend(Topics)
+    end
+
+  end
+
+end

data/lib/rtm/axes/characteristics.rb

@@ -0,0 +1,93 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module RTM::Axes
+  module Characteristics
+
+    def self.extended(k)
+      k.extend ArrayProxy
+    end
+
+    def result
+      self.map{|i| i.construct}
+    end
+    alias :tmapi :result
+
+    # ---- atomify-axis ------------------------------------------------------#
+    
+    # Returns the atomic values of these Characteristics.
+    #
+    # :call-seq:
+    #   atomify -> Array of Strings
+    #
+    def atomify
+      #self = Array of TopicProxies
+      #containee: RTM::Axes::Topic
+      #send -> Array of (String or nil)s
+      _res = self.inject([]){|all,containee| all << containee.send(:atomify)}.flatten
+      _res = _res.select{|i| i}
+      ### NO UNIQUE 
+      _res.extend(Strings)
+    end
+
+    # ---- characteristics-axis ----------------------------------------------#
+    
+    # Returns the Topics these Characteristics belong to.
+    # The optional argument identifier filters the
+    # Characteristics for their types. If the type
+    # does not match, the Topic is not returned.
+    #
+    # The identifier may be a Topic or Topic-Reference.
+    #
+    # :call-seq:
+    #   reverse_characteristics -> Array of Topic
+    #   reverse_characteristics(identifier) -> Array of Topic or empty Array
+    #
+    def reverse_characteristics(type=:any)
+      _res = self.inject([]){|all,containee| all << containee.send(:reverse_characteristics,type)}.flatten
+      _res = _res.select{|i| i}
+      ### FLAG UNIQUE ###
+      _res = _res.map{|i| i.construct}.uniq.map{|i| i.axes}
+      ###             ###
+      _res.extend(Topics)
+    end
+
+    # ---- reifier-axis ------------------------------------------------------#
+    
+    # Returns the reifing Topics of these Characteristics only
+    # if such Topics exists.
+    #
+    # The result may be empty.
+    #
+    # :call-seq:
+    #   reverse_reified -> Array of Topics
+    #
+    def reverse_reifier
+      _res = self.inject([]){|all,containee| all << containee.send(:reverse_reifier)}.flatten
+      _res = _res.select{|i| i}
+      ### FLAG UNIQUE ###
+      _res = _res.map{|i| i.construct}.uniq.map{|i| i.axes}
+      ###             ###
+      _res.extend(Topics)
+    end
+
+    # ---- scope-axis --------------------------------------------------------#
+    
+    # Returns the scope of these Characteristics.
+    #
+    # The result may be empty.
+    #
+    # :call-seq:
+    #   scope -> Array of Topics
+    #
+    def scope
+      _res = self.inject([]){|all,containee| all << containee.send(:scope)}.flatten
+      ### FLAG UNIQUE ###
+      _res = _res.map{|i| i.construct}.uniq.map{|i| i.axes}
+      ###             ###
+      _res = _res.extend(Topics)
+      _res
+    end
+
+  end
+end

data/lib/rtm/axes/string.rb

@@ -0,0 +1,76 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module RTM::Axes
+  class String < ItemProxy
+    
+    # ---- atomify-axis ------------------------------------------------------#
+    
+    # Returns all Names and Occurrences which have
+    # String as data value. If the String is found as value of a Variant,
+    # the parent Name is returned.
+    #
+    # The result may be empty.
+    #
+    # :call-seq:
+    #   reverse_atomify -> Array of Names and Occurrences
+    #
+    def reverse_atomify
+      index =  @tm.literal_index
+      names = index.getNames(@construct).to_a
+      occs = index.getOccurrences(@construct).to_a
+      variants = index.getVariants(@construct).to_a
+      names2 = variants.map{|v| v.parent}
+      _res = names + occs + names2 #could be empty
+      _res = _res.map{|r| r.axes}
+      _res.extend(Characteristics)
+    end
+      
+    # ---- indicators-axis ---------------------------------------------------#
+    
+    # Returns the Topic which has this String as indicator (subject identifier)
+    # or nil if no such Topic exists.
+    #
+    # :call-seq:
+    #   reverse_indicators -> Topic or nil
+    #
+    def reverse_indicators
+      _res = @tm.get_topic_by_subject_identifier(@construct) #Topic or nil
+      _res = RTM::Axes::Topic.new(_res,@tm) if _res
+      return _res
+    end
+    
+    # ---- item-axis ---------------------------------------------------------#
+    
+    # Returns one Topic which has this String as item identifer or nil
+    # if no such Topic exists.
+    #
+    # :call-seq:
+    #   reverse_item -> Topic or nil
+    #
+    def reverse_item
+      _res = @tm.get_construct_by_item_identifier(@construct) #Construct or nil TODO -> Topic
+      return nil unless _res
+      if _res.is_a?(RTM::Topic)
+        return RTM::Axes::Topic.new(_res,@tm)
+      else
+        return nil
+      end
+    end
+    
+    # ---- locators-axis -----------------------------------------------------#
+    
+    # Returns the Topic which has this String as subject locator or nil
+    # if no such Topic exists.
+    #
+    # :call-seq:
+    #   reverse_locators -> Topic or nil
+    #
+    def reverse_locators
+      _res = @tm.get_topic_by_subject_locator(@construct) #Topic or nil
+      _res = RTM::Axes::Topic.new(_res,@tm) if _res
+      return _res #RTM::Axes::Topic or nil
+    end
+    
+  end
+end

data/lib/rtm/axes/strings.rb

@@ -0,0 +1,87 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module RTM::Axes
+   module Strings
+    
+    def self.extended(k)
+      k.extend ArrayProxy
+    end
+
+    def result
+      self.map{|i| i.construct}
+    end
+    alias :tmapi :result
+    
+    # ---- atomify-axis ------------------------------------------------------#
+    
+    # Returns all Names and Occurrences which have one of these
+    # Strings as data value. If one String is found as value of a Variant,
+    # the parent Name is returned.
+    #
+    # The result may be empty.
+    #
+    # :call-seq:
+    #   reverse_atomify -> Array of Names and Occurrences
+    #
+    def reverse_atomify
+      _res = self.inject([]){|all,containee| all << containee.send(:reverse_atomify)}.flatten
+      ### NO UNIQUE NEEDED
+      _res = _res.extend(Characteristics)
+      _res
+    end
+    
+    # ---- indicators-axis ---------------------------------------------------#
+    
+    # Returns all Topics which have one of these Strings as indicator (subject identifier)
+    # only if such Topics exist.
+    #
+    # The result may be empty.
+    #
+    # :call-seq:
+    #   reverse_indicators -> Array of Topics
+    #
+    def reverse_indicators
+      _res = self.inject([]){|all,containee| all << containee.send(:reverse_indicators)}.flatten
+      ### NO UNIQUE
+      _res = _res.select{|i| i} #reject nil
+      _res = _res.extend(Topics)
+      _res
+    end
+    
+    # ---- item-axis ---------------------------------------------------------#
+    
+    # Returns all Topics which have one of these Strings as item identifer
+    # only if such Topics exist.
+    #
+    # The result may be empty.
+    #
+    # :call-seq:
+    #   reverse_item -> Array of Topics
+    #
+    def reverse_item
+      _res = self.inject([]){|all,containee| all << containee.send(:reverse_item)}.flatten
+      _res = _res.select{|i| i} #reject nil
+      _res = _res.extend(Topics)
+      _res
+    end
+    
+    # ---- locators-axis -----------------------------------------------------#
+    
+    # Returns all Topics which have one of these Strings as subject locator
+    # only if such Topics exist.
+    #
+    # The result may be empty.
+    #
+    # :call-seq:
+    #   reverse_locators -> Array of Topics
+    #
+    def reverse_locators
+      _res = self.inject([]){|all,containee| all << containee.send(:reverse_locators)}.flatten
+      _res = _res.select{|i| i} #reject nil
+      _res = _res.extend(Topics)
+      _res
+    end
+    
+   end
+end

data/lib/rtm/axes/topic.rb

@@ -0,0 +1,233 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module RTM::Axes
+
+  class Topic < ItemProxy
+
+    # ---- characteristics-axis ----------------------------------------------#
+    
+    # Returns all Names and Occurrences of this Topic.
+    # 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 = @construct.characteristics(type).map{|r| r.axes}
+      _res.extend(Characteristics)
+    end
+
+    # ---- indicators-axis ---------------------------------------------------#
+    
+    # Returns all indicators (subject identifiers) of this Topic.
+    #
+    # The result may be empty.
+    #
+    # :call-seq:
+    #   indicators -> Array of Strings
+    #
+    def indicators
+      @construct.indicators #Array of Strings or empty
+    end
+
+    # ---- item-axis ---------------------------------------------------------#
+    
+    # Returns one item identifier of this Topic or nil
+    # if this Topic has no item identifier.
+    #
+    # :call-seq:
+    #   item -> String or nil
+    #
+    def item
+      @construct.item #String or nil
+    end
+
+    # ---- locators-axis ------------------------------------------------------#
+    
+    # Returns all subject locators of this Topic.
+    #
+    # The result may be empty.
+    #
+    # :call-seq:
+    #   locators -> Array of Strings
+    #
+    def locators
+      @construct.locators #Array of Strings or empty
+    end
+
+    # ---- players-axis ------------------------------------------------------#
+    
+    # Returns all Associations in which this Topic plays 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 = @construct.reverse_players(type).map{|r| r.axes}
+      _res.extend(Associations)
+    end
+
+    # ---- reifier-axis ------------------------------------------------------#
+    
+    # Alias for the TMAPI function getReified.
+    # Returns the Construct which is reified by this Topic
+    # or nil if this Topic does not reify a Construct.
+    #
+    # So far, only Associations, Names or Occurrences are returned.
+    #
+    # :call-seq:
+    #   reifier -> Association, Name, Occurrence or nil
+    #
+    def reifier
+      #TODO: what if the reified construct is a Topic Map?
+      _res = @construct.getReified # Name,Occ,Assoc or nil
+      return RTM::Axes::Name.new(_res,@tm) if _res.is_a?(RTM::Name)
+      return RTM::Axes::Occurrence.new(_res,@tm) if _res.is_a?(RTM::Occurrence)
+      return RTM::Axes::Association.new(_res,@tm) if _res.is_a?(RTM::Association)
+      return nil
+    end
+
+    # ---- roles-axis --------------------------------------------------------#
+    
+    # Returns all Associations that have Roles that have
+    # this Topic as Role type. Multiple instances of the same
+    # Association are possible.
+    #
+    # The result may be empty.
+    #
+    # :call-seq:
+    #   reverse_roles -> Array of Associations
+    #
+    def reverse_roles
+      _res = @tm.type_instance_index.getRoles(@construct).map {|r| r.getParent }
+      _res = _res.map{|r| r.axes}
+      _res.extend(Associations)
+    end
+
+    # ---- scope-axis --------------------------------------------------------#
+    
+    # Returns all Associations, Names and Occurrences that include this
+    # Topic (theme) in their scope.
+    #
+    # The result may be empty.
+    #
+    # :call-seq:
+    #   reverse_scope -> Array of Names, Associations and Occurrences
+    #
+    def reverse_scope
+      _index = @tm.scoped_index
+      _res = _index.names(@construct).to_a + _index.occurrences(@construct).to_a + _index.associations(@construct).to_a
+      _res = _res.map{|r| r.axes}
+      _res.extend(AssocsNamesOccs)
+    end
+
+    # ---- supertypes-axis ---------------------------------------------------#
+    
+    # Returns all supertypes of this Topic. 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 = @construct.transitive_supertypes_with_self.map{|r| r.axes}
+      _res.extend(Topics)
+    end
+    
+    # Returns all subtypes of this Topic. 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 = @construct.transitive_subtypes_with_self.map{|r| r.axes}
+      _res.extend(Topics)
+    end
+    
+    alias reverse_subtypes supertypes
+    alias reverse_supertypes subtypes
+
+    # ---- traverse-axis ---------------------------------------------------#
+    
+    # First computes all Associations where this Topic playes a Role.
+    # There, the optional identifier filters the Associations for their type.
+    # 
+    # Returns all Players of all Roles in these Associations.
+    # The current 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 = @construct.traverse(type).map{|r| r.axes}
+      _res.extend(Topics)
+    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 this Topic is an instance of. Calls
+    # the TMAPI getTypes method.
+    #
+    # The result may be empty.
+    #
+    # :call-seq:
+    #   types -> Array of Topics
+    #
+    def types
+      _res = @construct.types.map{|r| r.axes}
+      _res.extend(Topics)
+    end
+    
+    # Returns the Topics which are instances of this Topic.
+    # Uses the TMAPI TypeInstanceIndex.
+    #
+    # The result may be empty.
+    #
+    # :call-seq:
+    #   instances -> Array of Topics
+    #
+    def instances
+      _res = @construct.instances.map{|r| r.axes}
+      _res.extend(Topics)
+    end
+    
+    alias reverse_types instances
+    alias reverse_instances types
+
+  end #of Class
+
+end