rtm-activerecord 0.2.0

data/lib/rtm/activerecord/io/to_yaml.rb

@@ -0,0 +1,132 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module RTM::AR::IO
+  # YAML Export.
+  # Each Topic Maps Construct gets a to_xtm2 method.
+  module TOYAML
+
+    module TopicMap
+      def to_yaml_hash(*a)
+        y={}
+        #j['base_locator'] = base_locator, # with absolute item_identifiers its not needed
+        y['reifier'] = reifier.to_yaml_ref if reifier
+        y['item_identifiers'] = item_identifiers.map{|i| i.reference} unless item_identifiers.empty?
+        y['topics'] = topics.map{|i| i.to_yaml_hash} unless topics.empty?
+        y['associations'] = associations.map{|i| i.to_yaml_hash} unless associations.empty?
+        y
+      end
+      # returns the YAML representation of this topic map
+      def to_yaml(*a)
+        to_yaml_hash.to_yaml(*a)
+      end
+    end
+
+    module Topic
+      # returns the YAML representation of this topic
+      def to_yaml_hash(*a)
+        y={}
+        y['item_identifiers'] = item_identifiers.map{|i| i.reference} unless item_identifiers.empty?
+        y['subject_identifiers'] = subject_identifiers.map{|i| i.reference} unless subject_identifiers.empty?
+        unless y['item_identifiers'] || y['subject_identifiers']
+          y['item_identifiers'] = [to_yaml_ref]
+        end
+        y['subject_locators'] = subject_locators.map{|i| i.reference} unless subject_locators.empty?
+        y['names'] = names.map{|i| i.to_yaml_hash} unless names.empty?
+        y['occurrences'] = occurrences.map{|i| i.to_yaml_hash} unless occurrences.empty?
+        y
+      end
+      def to_yaml(*a)
+        to_yaml_hash.to_yaml(*a)
+      end
+      def to_yaml_ref
+        if subject_identifiers.first
+          return subject_identifiers.first.reference
+        end
+        if item_identifiers.first
+          return item_identifiers.first.reference
+        end
+        "t#{id}"
+      end
+    end
+
+    module Association
+      def to_yaml_hash(*a)
+        y={}
+        y['reifier'] = reifier.to_yaml_ref if reifier
+        y['item_identifiers'] = item_identifiers.map{|i| i.reference} unless item_identifiers.empty?
+        y['type'] = type.to_yaml_ref if type
+        y['scope'] = scope.map{|i| i.to_yaml_hash} unless scope.empty?
+        y['roles'] = roles.map{|i| i.to_yaml_hash} unless roles.empty?
+        y
+      end
+      # returns the YAML representation of this association
+      def to_yaml(*a)
+        to_yaml_hash.to_yaml(*a)
+      end
+    end
+
+    module TopicName
+      def to_yaml_hash(*a)
+        y={}
+        y['reifier'] = reifier.to_yaml_ref if reifier
+        y['item_identifiers'] = item_identifiers.map{|i| i.reference} unless item_identifiers.empty?
+        y['value'] = value if value
+        y['type'] = type.to_yaml_ref if type
+        y['scope'] = scope.map{|i| i.to_yaml_hash} unless scope.empty?
+        y['variants'] = variants.map{|i| i.to_yaml_hash} unless variants.empty?
+        y
+      end
+      def to_yaml(*a)
+        to_yaml_hash.to_yaml(*a)
+      end
+    end
+
+    module Occurrence
+      def to_yaml_hash(*a)
+        y={}
+        y['reifier'] = reifier.to_yaml_ref if reifier
+        y['item_identifiers'] = item_identifiers.map{|i| i.reference} unless item_identifiers.empty?
+        y['value'] = value if value
+        y['datatype'] = datatype if datatype
+        y['type'] = type.to_yaml_ref if type
+        y['scope'] = scope.map{|i| i.to_yaml_hash} unless scope.empty?
+        y
+      end
+      def to_yaml(*a)
+        to_yaml_hash.to_yaml(*a)
+      end
+    end
+
+    module AssociationRole
+      def to_yaml_hash(*a)
+        y={}
+        y['reifier'] = reifier.to_yaml_ref if reifier
+        y['item_identifiers'] = item_identifiers.map{|i| i.reference} unless item_identifiers.empty?
+        y['player'] = player.to_yaml_ref if player
+        y['type'] = type.to_yaml_ref if type
+        y
+      end
+      def to_yaml(*a)
+        to_yaml_hash.to_yaml(*a)
+      end
+    end
+
+    module Variant
+      def to_yaml_hash(*a)
+        y={}
+        y['reifier'] = reifier.to_yaml_ref if reifier
+        y['item_identifiers'] = item_identifiers.map{|i| i.reference} unless item_identifiers.empty?
+        y['value'] = value if value
+        y['scope'] = scope.map{|i| i.to_yaml_hash} unless scope.empty?
+        y
+      end
+      def to_yaml(*a)
+        to_yaml_hash.to_yaml(*a)
+      end
+    end
+  
+    RTM::AR.register_extension self 
+  end
+end
+  

data/lib/rtm/activerecord/literal_index.rb

@@ -0,0 +1,38 @@
+module RTM::AR
+  class Index
+    attr_accessor :topic_map
+    attr_accessor :itopic_map # the internal AR object
+    def initialize(tm)
+      @topic_map = tm
+      @itopic_map = tm.__getobj__
+    end
+    def close
+    end
+    def isAutoUpdated
+      true
+    end
+    def isOpen
+      true
+    end
+    def open
+    end
+    def reindex
+    end
+  end
+  class LiteralIndex < Index
+    def names(value)
+      Names.wrap(self.itopic_map.names.find(:all,:conditions => ["value = ?", value]))
+    end
+    alias :getNames :names
+    
+    def occurrences(value)
+      Occurrences.wrap(self.itopic_map.occurrences.find(:all,:conditions => ["value = ?", value]))
+    end
+    alias :getOccurrences :occurrences
+    
+    def variants(value)
+      Variants.wrap(TMDM::Variant.find(:all,:conditions => ["value = ?", value]).select{|v| v.topic_map == self.itopic_map})
+    end
+    alias :getVariants :variants
+  end
+end

data/lib/rtm/activerecord/locators.rb

@@ -0,0 +1,58 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module RTM::AR
+  class Locator < TMDelegator
+    include RTM::Locator
+
+    delegate :+
+    delegate :-
+    #delegate :==
+    delegate :id
+
+    delegate :get
+    delegate :hash
+    delegate :resolve_relative
+    delegate :to_s, :to => :reference
+    delegate :to_uri
+    delegate :uri
+    delegate :reference, :rw => true, :save => true
+    alias :value :reference
+    alias :value= :reference=
+    alias :v :reference
+    alias :v= :reference=
+
+    equality [:reference]
+
+    def self.wrap(obj)
+      return nil unless obj
+      raise "Double wrapping" if obj.respond_to?(:__getobj__)
+      case obj.class.name
+      when "RTM::AR::TMDM::ItemIdentifier"
+        ItemIdentifier.wrap(obj)
+      when "RTM::AR::TMDM::SubjectIdentifier"
+        SubjectIdentifier.wrap(obj)
+      when "RTM::AR::TMDM::SubjectLocator"
+        SubjectLocator.wrap(obj)
+      else
+        raise "Can't wrap object. Class for wrapping #{obj.class} unknown (object: #{obj})"
+      end
+    end
+  end
+
+  class ItemIdentifier < Locator
+    include RTM::ItemIdentifier
+    wrapper_cache
+    property :construct, :type => :Construct, :wrap => true
+  end
+  class SubjectIdentifier < Locator
+    include RTM::SubjectIdentifier
+    wrapper_cache
+    property :topic, :type => :Topic, :wrap => true
+  end
+  class SubjectLocator < Locator
+    include RTM::SubjectLocator
+    wrapper_cache
+    property :topic, :type => :Topic, :wrap => true    
+  end
+end

data/lib/rtm/activerecord/merging.rb

@@ -0,0 +1,310 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module RTM
+  class MergeException < Exception; end
+  class TopicMergeException < MergeException; end
+  module Merging
+    module ReWrap
+      protected
+      def merge_rewrap(other)
+        # let the wrapper point to the new object
+        old_getobj = other.__getobj__
+        other.__setobj__(self.__getobj__) if self.respond_to?(:__getobj__) && other.respond_to?(:__setobj__)
+        # and destroy the old one
+        old_getobj.reload
+        __getobj__.reload
+        old_getobj.destroy
+      end
+    end
+    module MergeItemIdentifiers
+      protected
+      def merge_item_identifiers(other)
+        #self.item_identifiers.add_all other.item_identifiers
+        RTM::AR::TMDM::ItemIdentifier.move_all(
+          ["topic_map_construct_id", other.__getobj__.id, self.__getobj__.id],
+          ["topic_map_construct_type", other.__getobj__.class.name, self.__getobj__.class.name]
+        )
+      end
+    end
+    module MergeReifiable
+      include MergeItemIdentifiers
+      include ReWrap
+      protected
+      def merge_reifiable(other)
+        if other.reifier && self.reifier
+          self.reifier.merge(other.reifier)
+        elsif other.reifier
+          self.reifier = other.reifier
+        end
+      end
+    end
+
+    module Association
+      include Merging::MergeReifiable
+
+      def merge(other)
+        # The procedure for merging two association items A and B is given below.
+
+        # 1. Create a new association item, C.
+        # -> we will instead just modify a
+
+        # 2. Set C's [type] property to the value of A's [type] property. B's value is equal to that of A and need not be taken into account.
+        # 3. Set C's [scope] property to the value of A's [scope] property. B's value is equal to that of A and need not be taken into account.
+        # 4. Set C's [roles] property to the value of A's [roles] property. B's value is equal to that of A and need not be taken into account.
+        # -> nothing to do till here
+
+        # 5. Set C's [reifier] property to the value of A's [reifier] property if it is not null, and to the value of B's [reifier] property if A's property is null. If both A and B have non-null values, the topic items shall be merged, and the topic item resulting from the merge set as the value of C's [reifier] property.
+        self.merge_reifiable other
+
+        # 6. Set C's [item identifiers] property to the union of the values of A's and B's [item identifiers] properties.
+        self.merge_item_identifiers other
+
+        # 7. Remove A and B from the [associations] property of the topic map item in their [parent] properties, and add C.
+        #self.parent.associations.remove other
+
+        # let the wrapper point to the new object
+        #other.__setobj__(self.__getobj__) if self.respond_to?(:__getobj__) && other.respond_to?(:__setobj__)
+        self.merge_rewrap other
+
+        self
+      end
+    end
+
+    module Role
+      include Merging::MergeReifiable
+
+      def merge(other)
+        # The procedure for merging two association role items A and B is given below.
+        # -> we will instead just modify a
+
+        # 1. Create a new association role item, C.
+        # 2. Set C's [player] property to the value of A's [player] property. B's value is equal to that of A and need not be taken into account.
+        # 3. Set C's [type] property to the value of A's [type] property. B's value is equal to that of A and need not be taken into account.
+        # -> nothing to do till here
+
+        # 4. Set C's [item identifiers] property to the union of the values of A's and B's [item identifiers] properties.
+        self.merge_item_identifiers other
+
+        # 5. Set C's [reifier] property to the value of A's [reifier] property if it is not null,
+        #    and to the value of B's [reifier] property if A's property is null.
+        #    If both A and B have non-null values, the topic items shall be merged,
+        #    and the topic item resulting from the merge set as the value of C's [reifier] property.
+        self.merge_reifiable other
+
+        # 6. Remove A and B from the [roles] property of the association item in their [parent] properties, and add C.
+        #self.parent.roles.remove other
+
+        #puts "#{self.parent.object_id} and #{other.parent.object_id}"
+
+        # let the wrapper point to the new object
+        #other.__setobj__(self.__getobj__) if self.respond_to?(:__getobj__) && other.respond_to?(:__setobj__)
+        self.merge_rewrap other
+
+        self
+      end
+    end
+
+    module Occurrence
+      include Merging::MergeReifiable
+
+      def merge(other)
+        # 1. Create a new occurrence item, C.
+        # -> we will instead just modify a
+
+        # 2. Set C's [value] property to the value of A's [value] property. B's value is equal to that of A and need not be taken into account.
+        # 3. Set C's [datatype] property to the value of A's [datatype] property. B's value is equal to that of A and need not be taken into account.
+        # 4. Set C's [scope] property to the value of A's [scope] property. B's value is equal to that of A and need not be taken into account.
+        # 5. Set C's [type] property to the value of A's [type] property. B's value is equal to that of A and need not be taken into account.
+        # -> nothing to do till here
+
+        # 6. Set C's [reifier] property to the value of A's [reifier] property if it is not null, and to the value of B's [reifier] property if A's property is null. If both A and B have non-null values, the topic items shall be merged, and the topic item resulting from the merge set as the value of C's [reifier] property.
+        self.merge_reifiable other
+
+        # 7. Set C's [item identifiers] property to the union of the values of A's and B's [item identifiers] properties.
+        self.merge_item_identifiers other
+
+        # 8. Remove A and B from the [occurrences] property of the topic item in their [parent] properties, and add C.
+        #self.parent.occurrences.remove other
+
+        # let the wrapper point to the new object
+        #other.__setobj__(self.__getobj__) if self.respond_to?(:__getobj__) && other.respond_to?(:__setobj__)
+        self.merge_rewrap other
+
+        self
+      end
+    end
+
+    module Topic
+      include Merging::ReWrap
+      include Merging::MergeItemIdentifiers
+
+      def merge(other)
+        return unless other
+        # The procedure for merging two topic items A and B
+        # -> we will instead just modify a
+        # (whose [parent] properties shall contain the same topic map item) is given below.
+        raise TopicMergeException, "Both topics must belong to the same topic map!" if self.parent.__getobj__ != other.parent.__getobj__
+        # It is an error if A and B both have non-null values in their [reified] properties which are different.
+        raise TopicMergeException, "The Topics must not reify different things." if self.reified && other.reified && self.reified.__getobj__ != other.reified.__getobj__
+
+        # 1. Create a new topic item C.
+        # 2. Replace A by C wherever it appears in one of the following properties
+        #    of an information item: [topics], [scope], [type], [player], and [reifier].
+        # -> nothing to do here
+
+        # 3. Repeat for B.
+        # [topics]
+        # done below, in rewrap
+        # [scope]
+        RTM::AR::TMDM::ScopedObjectsTopic.move_all(["topic_id", other.__getobj__.id, self.__getobj__.id])
+        # [type]
+        RTM::AR::TMDM::Association.move_all(["ttype_id", other.__getobj__.id, self.__getobj__.id])
+        RTM::AR::TMDM::Role.move_all(["ttype_id", other.__getobj__.id, self.__getobj__.id])
+        RTM::AR::TMDM::Name.move_all(["ttype_id", other.__getobj__.id, self.__getobj__.id])
+        RTM::AR::TMDM::Occurrence.move_all(["ttype_id", other.__getobj__.id, self.__getobj__.id])
+
+        # [player]
+        RTM::AR::TMDM::AssociationRole.move_all(["topic_id", other.__getobj__.id, self.__getobj__.id])
+
+        # [reifier]
+        if other.reified
+          self.reified = other.reified
+        end
+        # 4. Set C's [topic names] property to the union of the values of A and B's [topic names] properties.
+        #self.names.add_all other.names
+        count = RTM::AR::TMDM::Name.move_all(["topic_id", other.__getobj__.id, self.__getobj__.id])
+        if count != 0 && count != names.size
+          names.each_with_index do |n,i|
+            (i+1).upto(names.size-1) do |j|
+              if n == names[j]
+                n.merge names[j]
+              end
+            end
+          end
+        end
+
+        # 5. Set C's [occurrences] property to the union of the values of A and B's [occurrences] properties.
+        #self.occurrences.add_all other.occurrences
+        RTM::AR::TMDM::Occurrence.move_all(["topic_id", other.__getobj__.id, self.__getobj__.id])
+        if count != 0 && count != occurrences.size
+          occurrences.each_with_index do |o,i|
+            (i+1).upto(occurrences.size-1) do |j|
+              if o == occurrences[j]
+                o.merge occurrences[j]
+              end
+            end
+          end
+        end
+
+        # 6. Set C's [subject identifiers] property to the union of the values of A and B's [subject identifiers] properties.
+        #self.subject_identifiers.add_all other.subject_identifiers
+        RTM::AR::TMDM::SubjectIdentifier.move_all(["topic_id", other.__getobj__.id, self.__getobj__.id])
+
+        # 7. Set C's [subject locators] property to the union of the values of A and B's [subject locators] properties.
+        #self.subject_locators.add_all other.subject_locators
+        RTM::AR::TMDM::SubjectLocator.move_all(["topic_id", other.__getobj__.id, self.__getobj__.id])
+
+        # 8. Set C's [item identifiers] property to the union of the values of A and B's [item identifiers] properties.
+        #self.item_identifiers.add_all other.item_identifiers
+        #RTM::AR::TMDM::ItemIdentifier.update_all "topic_map_construct_id = #{self.__getobj__.id}, topic_map_construct_type = '#{self.__getobj__.class.name}'", "topic_map_construct_id = #{other.__getobj__.id} and topic_map_construct_type = '#{other.__getobj__.class.name}'"
+        RTM::AR::TMDM::ItemIdentifier.move_all(
+          ["topic_map_construct_id", other.__getobj__.id, self.__getobj__.id],
+          ["topic_map_construct_type", other.__getobj__.class.name, self.__getobj__.class.name]
+        )
+
+        self.merge_rewrap other
+
+        self
+      end
+      alias :merge_in :merge
+    end
+
+    module TopicMap
+      include Merging::MergeReifiable
+
+      def merge(other) # other:TopicMap
+        self.topics.add_all other.topics
+        self.associations.add_all other.associations
+        self.merge_reifiable other
+        self.merge_item_identifiers other
+
+        self.merge_rewrap other
+        self
+      end
+      alias :merge_in :merge
+    end
+
+    module Name
+      def merge(other)
+        # The procedure for merging two topic name items A and B is given below.
+        # -> we will instead just modify a
+
+        # 1. Create a new topic name item C.
+        # 2. Set C's [value] property to the value of the [value] property of A. B's value is equal that of A and need not be taken into account.
+        # 3. Set C's [type] property to the value of the [type] property of A. B's value is equal that of A and need not be taken into account.
+        # 4. Set C's [scope] property to the value of the [scope] property of A. B's value is equal that of A and need not be taken into account.
+        # -> nothing to do till here
+
+        # 5. Set C's [variants] property to the union of the [variants] properties of A and B.
+        #self.variants.add_all other.variants
+        count = RTM::AR::TMDM::Variant.move_all(["name_id", other.__getobj__.id, self.__getobj__.id])
+        if count != 0 && count != variants.size
+          variants.each_with_index do |v,i|
+            (i+1).upto(variants.size-1) do |j|
+              if v == variants[j]
+                v.merge variants[j]
+              end
+            end
+          end
+        end
+
+        # 6. Set C's [reifier] property to the value of A's [reifier] property if it is not null, and to the value of B's [reifier] property if A's property is null. If both A and B have non-null values, the topic items shall be merged, and the topic item resulting from the merge be set as the value of C's [reifier] property.
+        self.merge_reifiable other
+
+        # 7. Set C's [item identifiers] property to the union of the value of the [item identifiers] properties of A and B.
+        self.merge_item_identifiers other
+
+        # 8. Remove A and B from the [topic names] property of the topic item in their [parent] properties, and add C.
+        #self.parent.names.remove other
+
+        # let the wrapper point to the new object
+        #other.__setobj__(self.__getobj__) if self.respond_to?(:__getobj__) && other.respond_to?(:__setobj__)
+        self.merge_rewrap other
+
+        self
+      end
+    end
+
+    module Variant
+      include Merging::MergeReifiable
+
+      def merge(other)
+        #The procedure for merging two variant items A and B is given below.
+        # -> we will instead just modify a
+
+        # 1. Create a new variant item, C.
+        # 2. Set C's [value] property to the value of A's [value] property. B's value is equal to that of A and need not be taken into account.
+        # 3. Set C's [datatype] property to the value of A's [datatype] property. B's value is equal to that of A and need not be taken into account.
+        # 4. Set C's [scope] property to the value of A's [scope] property. B's value is equal to that of A and need not be taken into account.
+        # -> nothing to do till here
+
+        # 5. Set C's [reifier] property to the value of A's [reifier] property if it is not null, and to the value of B's [reifier] property if A's property is null. If both A and B have non-null values, the topic items shall be merged, and the topic item resulting from the merge set as the value of C's [reifier] property.
+        self.merge_reifiable other
+
+        # 6. Set C's [item identifiers] property to the union of the values of A's and B's [item identifiers] properties.
+        self.merge_item_identifiers other
+
+        # 7. Remove A and B from the [variants] property of the topic name item in their [parent] properties, and add C.
+        #self.parent.variants.remove other
+
+        # let the wrapper point to the new object
+        #other.__setobj__(self.__getobj__) if self.respond_to?(:__getobj__) && other.respond_to?(:__setobj__)
+        self.merge_rewrap other
+
+        self
+      end
+    end
+    RTM.register_extension( self )
+  end
+end