rtm 0.1.6 → 0.2.0

data/lib/rtm/io/to_rdf.rb

@@ -0,0 +1,30 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+
+module RTM::IO
+
+  # RDF Export.
+  # RTM::TopicMap gets a to_rdf method.
+  module TORDF
+    module TopicMap
+      
+      def to_rdf
+        case self
+          when net.ontopia.topicmaps.impl.tmapi2.TopicMapImpl then to_rdf_ontopia
+          else raise "Not supported for #{self}"
+        end
+      end
+      
+      def to_rdf_ontopia
+        @out = java.io.StringWriter.new
+        w=Java::NetOntopiaTopicmapsUtilsRdf::RDFTopicMapWriter.new @out
+        w.write self.getWrapped
+        @out.to_s
+      end
+    end
+
+    RTM.register_extension self 
+
+  end
+end

data/lib/rtm/io/to_string.rb

@@ -1,4 +1,6 @@
-# Ruby Topic Maps (RTM) http://rtm.rubyforge.org/
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
 module RTM::IO
   # Each Topic Maps Construct gets a custom to_s method which supports optional :short or :long output.
   module TOSTRING
@@ -53,20 +55,20 @@ module RTM::IO
         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)} roles=[#{roles.entries.map { |ar| ar.to_s }.join(", ")}]>"
+          "#<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
         end
       end
     end
 
-    module AssociationRole
+    module Role
       def to_s(style=:short)
         case style
         when :short
           r = " #{reifier.to_s(:short)}" if reifier
           i = " iids=#{item_identifiers.to_s}" unless item_identifiers.empty?
-          "#<RTM::AssociationRole id=#{id}#{i}#{r}>"
+          "#<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?
@@ -77,7 +79,7 @@ module RTM::IO
       end
     end
 
-    module TopicName
+    module Name
       def to_s(style=:short)
         case style
         when :short
@@ -85,7 +87,7 @@ module RTM::IO
         when :long
           r = " #{reifier.to_s(:short)}" if reifier
           i = " iids=#{item_identifiers.to_s}" unless item_identifiers.empty?
-          "#<RTM::TopicName id=#{id}#{i}#{r} type=#{type.to_s(:short)} value=#{value} variants:#{variants.size}>"
+          "#<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
         end

data/lib/rtm/io/to_xtm1.rb

@@ -1,4 +1,6 @@
-# Ruby Topic Maps (RTM) http://rtm.rubyforge.org/
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
 module RTM::IO
   # XTM1 Export
   module TOXTM1
@@ -98,9 +100,9 @@ module RTM::IO
       end
     end
 
-    module TopicName
+    module Name
       def to_xtm1
-        warn("TOXTM1: Warning: outputting invalid TopicName #{self}") unless valid?
+        warn("TOXTM1: Warning: outputting invalid Name #{self}") unless valid?
         # name = element name { reifiable, type?, scope?, value, variant* }
         x = REXML::Element.new 'name'
         x.add_attribute('reifier', reifier.xtm1_id) if reifier
@@ -128,7 +130,7 @@ module RTM::IO
       end
     end
 
-    module AssociationRole
+    module Role
       def to_xtm1
         warn("TOXTM1: Warning: outputting invalid AssociationRole #{self}") unless valid?
         # role = element role { reifiable, type, topicRef }

data/lib/rtm/io/to_xtm2.rb

@@ -1,4 +1,6 @@
-# Ruby Topic Maps (RTM) http://rtm.rubyforge.org/
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
 
 module RTM::IO
   # XTM2 Export.
@@ -92,7 +94,7 @@ module RTM::IO
         # association = element association { reifiable, type, scope?, role+ }
         x = REXML::Element.new 'association'
         x.add_attribute('reifier', reifier.xtm2_id) if reifier
-        item_identifiers.each { |ii| x << TOXTM2.ii(ii) } # itemIdentity
+        item_identifiers.each { |ii| x << TOXTM2.locator(ii) } # itemIdentity
         x << TOXTM2.type(type) if type
         x << TOXTM2.scope(scope) unless scope.empty?
         roles.each { |r| x << r.to_xtm2 }
@@ -100,13 +102,13 @@ module RTM::IO
       end
     end
 
-    module TopicName
+    module Name
       def to_xtm2
-        warn("TOXTM2: Warning: outputting invalid TopicName #{self}") unless valid?
+        warn("TOXTM2: Warning: outputting invalid Name #{self}") unless valid?
         # name = element name { reifiable, type?, scope?, value, variant* }
         x = REXML::Element.new 'name'
         x.add_attribute('reifier', reifier.xtm2_id) if reifier
-        item_identifiers.each { |ii| x << TOXTM2.ii(ii) } # itemIdentity
+        item_identifiers.each { |ii| x << TOXTM2.locator(ii) } # itemIdentity
         x << TOXTM2.type(type) if type
         x << TOXTM2.scope(scope) unless scope.empty?
         (x << REXML::Element.new('value')).text = value # adds the value within a value-element
@@ -122,7 +124,7 @@ module RTM::IO
         #   type, scope?, ( resourceRef | resourceData ) }
         x = REXML::Element.new 'occurrence'
         x.add_attribute('reifier', reifier.xtm2_id) if reifier
-        item_identifiers.each { |ii| x << TOXTM2.ii(ii) } # itemIdentity
+        item_identifiers.each { |ii| x << TOXTM2.locator(ii) } # itemIdentity
         x << TOXTM2.type(type) if type
         x << TOXTM2.scope(scope) unless scope.empty?
         x << TOXTM2.value(datatype, value)
@@ -136,7 +138,7 @@ module RTM::IO
         # role = element role { reifiable, type, topicRef }
         x = REXML::Element.new 'role'
         x.add_attribute('reifier', reifier.xtm2_id) if reifier
-        item_identifiers.each { |ii| x << TOXTM2.ii(ii) } # itemIdentity
+        item_identifiers.each { |ii| x << TOXTM2.locator(ii) } # itemIdentity
         x << TOXTM2.type(type) if type
         x << player.to_xtm2_ref if player
         x
@@ -149,7 +151,7 @@ module RTM::IO
         # variant = element variant { reifiable, scope, (resourceRef | resourceData) }
         x = REXML::Element.new 'variant'
         x.add_attribute('reifier', reifier.xtm2_id) if reifier
-        item_identifiers.each { |ii| x << TOXTM2.ii(ii) } # itemIdentity
+        item_identifiers.each { |ii| x << TOXTM2.locator(ii) } # itemIdentity
         x << TOXTM2.scope(scope)
         x << TOXTM2.value(datatype, value)
         x

data/lib/rtm/io/to_yaml.rb

@@ -1,130 +1,61 @@
-# Ruby Topic Maps (RTM) http://rtm.rubyforge.org/
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
 module RTM::IO
   # YAML Export.
-  # Each Topic Maps Construct gets a to_xtm2 method.
+  # Each Topic Maps Construct gets a to_yaml 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)
+      # Returns the YAML representation of this RTM::TopicMap
+      def to_yaml
+        to_hash.to_yaml
       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}"
+      # Returns the YAML representation of this RTM::Topic
+      def to_yaml
+        to_hash.to_yaml
       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)
+      # Returns the YAML representation of this RTM::Association
+      def to_yaml
+        to_hash.to_yaml
       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)
+    module Name
+      # Returns the YAML representation of this RTM::Name
+      def to_yaml
+        to_hash.to_yaml
       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)
+      # Returns the YAML representation of this RTM::Occurrence
+      def to_yaml
+        to_hash.to_yaml
       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)
+    module Role
+      # Returns the YAML representation of this RTM::Role
+      def to_yaml
+        to_yaml_hash.to_yaml
       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)
+      # Returns the YAML representation of this RTM::Variant
+      def to_yaml
+        to_yaml_hash.to_yaml
       end
     end
-  
+
     RTM.register_extension( self )
+    
   end
 end
-  

data/lib/rtm/navigation.rb

@@ -0,0 +1,37 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module RTM
+  module Navigation
+  end
+end
+
+require "rtm/navigation/association/players"
+require "rtm/navigation/name/characteristics"
+require "rtm/navigation/name/atomify"
+require "rtm/navigation/occurrence/characteristics"
+require "rtm/navigation/occurrence/atomify"
+require "rtm/navigation/topic/characteristics"
+require "rtm/navigation/topic/indicators"
+require "rtm/navigation/topic/items"
+require "rtm/navigation/topic/locators"
+require "rtm/navigation/topic/players"
+require "rtm/navigation/topic/supertypes"
+require "rtm/navigation/topic/traverse"
+require "rtm/navigation/topic/types"
+
+module RTM::Topic
+  include RTM::Navigation::Topic
+end
+
+module RTM::Name
+  include RTM::Navigation::Name
+end
+
+module RTM::Occurrence
+  include RTM::Navigation::Occurrence
+end
+
+module RTM::Association
+  include RTM::Navigation::Association
+end

data/lib/rtm/navigation/association/players.rb

@@ -0,0 +1,25 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module RTM
+  module Navigation
+    module Association
+      
+      # Returns all players of roles in this association.
+      #
+      # 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 topics are possible.
+      #
+      # :call-seq:
+      #   players -> Array of Topics
+      #   players(identifier) -> Array of Topics
+      #
+      def players(type = :any)
+        return roles(type).map{|r| r.player}
+      end
+      
+    end
+  end
+end

data/lib/rtm/navigation/name/atomify.rb

@@ -0,0 +1,19 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module RTM 
+  module Navigation
+    module Name
+      
+      # Returns the atomic value of the Characteristic (Name/Occurrence).
+      #
+      # :call-seq:
+      #   atomify -> String
+      #
+      def atomify
+        value
+      end
+      
+    end
+  end
+end

data/lib/rtm/navigation/name/characteristics.rb

@@ -0,0 +1,33 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module RTM
+  module Navigation
+    module Name
+      
+      # Returns the Topic this Characteristic (Name/Occurrence) 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)
+        return parent if type == :any
+        _topic = topic_map.get(type)
+        return nil unless _topic
+        #filter the Name/Occurrence for its type:
+        if _topic == self.type
+          return parent
+        else
+          return nil
+        end
+      end
+      
+    end
+  end
+end