rtm 0.2.0 → 0.2.1

data/lib/rtm/io/to_jtm.rb

@@ -88,7 +88,7 @@ module RTM::IO
       alias :to_json :to_jtm
     end
 
-    RTM.register_extension self 
+    RTM.register_extension self
     
   end
 end

data/lib/rtm/io/to_rdf.rb

@@ -1,21 +1,36 @@
 # 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 ToRDF
     module TopicMap
-      
+
+      # If this topic map is an Ontopia tmapi2 topic map to_rdf_ontopia is
+      # called and the RDF reprensentation is returned.
+      #
+      # Else, a "Not supported" error is raised.
+      #
+      # :call-seq:
+      #   to_rdf -> String
+      #
       def to_rdf
         case self
           when net.ontopia.topicmaps.impl.tmapi2.TopicMapImpl then to_rdf_ontopia
           else raise "Not supported for #{self}"
         end
       end
-      
+
+      # Returns the RDF representation according to RDF2TM
+      # of this topic map as String.
+      #
+      # @see http://www.ontopia.net/topicmaps/materials/rdf2tm.html
+      #
+      # :call-seq:
+      #   to_rdf_ontopia -> String
+      #
       def to_rdf_ontopia
         @out = java.io.StringWriter.new
         w=Java::NetOntopiaTopicmapsUtilsRdf::RDFTopicMapWriter.new @out
@@ -24,7 +39,7 @@ module RTM::IO
       end
     end
 
-    RTM.register_extension self 
+    RTM.register_extension self
 
   end
 end

data/lib/rtm/io/to_string.rb

@@ -3,7 +3,7 @@
 
 module RTM::IO
   # Each Topic Maps Construct gets a custom to_s method which supports optional :short or :long output.
-  module TOSTRING
+  module ToString
 
     module TopicMap
       # Returns different String representations. Try :short (default), :long, :super (original)
@@ -123,7 +123,18 @@ module RTM::IO
         end
       end
     end
-  
+
+    module Locator
+      def to_s(style=:short)
+        case style
+        when :short
+          value
+        when :long
+          value
+        end
+      end
+    end
+
     RTM.register_extension( self )
   end
 end

data/lib/rtm/io/to_yaml.rb

@@ -2,56 +2,84 @@
 # License:   Apache License, Version 2.0
 
 module RTM::IO
-  # YAML Export.
+  # Yaml Export.
   # Each Topic Maps Construct gets a to_yaml method.
-  module TOYAML
+  module ToYAML
 
     module TopicMap
-      # Returns the YAML representation of this RTM::TopicMap
+      # Returns the YAML representation of this topic map as String.
+      #
+      # :call-seq:
+      #   to_yaml -> String
+      #
       def to_yaml
         to_hash.to_yaml
       end
     end
 
     module Topic
-      # Returns the YAML representation of this RTM::Topic
+      # Returns the YAML representation of this topic as String.
+      #
+      # :call-seq:
+      #   to_yaml -> String
+      #
       def to_yaml
         to_hash.to_yaml
       end
     end
 
     module Association
-      # Returns the YAML representation of this RTM::Association
+      # Returns the YAML representation of this association as String.
+      #
+      # :call-seq:
+      #   to_yaml -> String
+      #
       def to_yaml
         to_hash.to_yaml
       end
     end
 
     module Name
-      # Returns the YAML representation of this RTM::Name
+      # Returns the YAML representation of this name as String.
+      #
+      # :call-seq:
+      #   to_yaml -> String
+      #
       def to_yaml
         to_hash.to_yaml
       end
     end
 
     module Occurrence
-      # Returns the YAML representation of this RTM::Occurrence
+      # Returns the YAML representation of this occurrence as String.
+      #
+      # :call-seq:
+      #   to_yaml -> String
+      #
       def to_yaml
         to_hash.to_yaml
       end
     end
 
     module Role
-      # Returns the YAML representation of this RTM::Role
+      # Returns the YAML representation of this role as String.
+      #
+      # :call-seq:
+      #   to_yaml -> String
+      #
       def to_yaml
-        to_yaml_hash.to_yaml
+        to_hash.to_yaml
       end
     end
 
     module Variant
-      # Returns the YAML representation of this RTM::Variant
+      # Returns the YAML representation of this variant as String.
+      #
+      # :call-seq:
+      #   to_yaml -> String
+      #
       def to_yaml
-        to_yaml_hash.to_yaml
+        to_hash.to_yaml
       end
     end
 

data/lib/rtm/navigation.rb

@@ -20,18 +20,4 @@ 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
+RTM.register_extension(RTM::Navigation)

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

@@ -8,7 +8,7 @@ module RTM
       # 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.
+      # The identifier may be a topic reference.
       #
       # Multiple instances of the same topics are possible.
       #

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

@@ -10,7 +10,7 @@ module RTM
       # Characteristic for its type. If the type
       # does not match, nil is returned.
       #
-      # The identifier may be a Topic or Topic-Reference.
+      # The identifier may be a topic reference.
       #
       # :call-seq:
       #   reverse_characteristics -> Topic

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

@@ -10,7 +10,7 @@ module RTM
       # Characteristic for its type. If the type
       # does not match, nil is returned.
       #
-      # The identifier may be a Topic or Topic-Reference.
+      # The identifier may be a topic reference.
       #
       # :call-seq:
       #   reverse_characteristics -> Topic

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

@@ -9,7 +9,7 @@ module RTM
       # 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.
+      # Identifier may be a topic reference.
       #
       # The result may be empty.
       #

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

@@ -9,7 +9,7 @@ module RTM
       #
       # The optional
       # identifier specifies the type of the Roles to be considered.
-      # The identifier may be a Topic or Topic-Reference.
+      # The identifier may be a topic reference.
       #
       # Multiple instances of the same Association are possible.
       # The result may be empty.

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

@@ -23,7 +23,7 @@ module RTM
       # the player of the supertype-Role. The current Topic will play the
       # subtype-Role. Returns the created Association.
       #
-      # Identifier may be a Topic or Topic-Reference.
+      # Identifier may be a topic reference.
       #
       # :call-seq:
       #   add_supertype(identifier) -> Association
@@ -40,7 +40,7 @@ module RTM
       # the player of a supertype-Role. The current topic will play the
       # subtype-Role in each association. Returns the associations.
       #
-      # The identifier may be topic references.
+      # The identifiers may be topic references.
       #
       # :call-seq:
       #   add_supertypes(identifier1, identifier2, ...) -> Array of Associtions
@@ -60,13 +60,15 @@ module RTM
       #   transitive_supertypes -> Array of Topics
       #
       def transitive_supertypes
-        result_types = new_s_t = direct_supertypes
-        until new_s_t.empty?
-          new_s_t = new_s_t.map{|s| s.direct_supertypes}.flatten.uniq
-          new_s_t = new_s_t.reject{|s| result_types.include?(s)}
-          result_types = result_types + new_s_t
-        end
-        return result_types
+#       topic_map.cached self, :transitive_supertypes do
+          result_types = new_s_t = direct_supertypes
+          until new_s_t.empty?
+            new_s_t = new_s_t.map{|s| s.direct_supertypes}.flatten.uniq
+            new_s_t = new_s_t.reject{|s| result_types.include?(s)}
+            result_types = result_types + new_s_t
+          end
+          result_types
+#       end
       end
       
       # Returns all supertypes of this Topic. The result includes the direct_supertypes
@@ -97,7 +99,7 @@ module RTM
       # the player of the subtype-Role. The current Topic will play the
       # supertype-Role. Returns the created Association.
       #
-      # Identifier may be Topic or Topic Reference.
+      # Identifier may be topic reference.
       #
       # :call-seq:
       #   add_subtype(identifier) -> Association
@@ -114,7 +116,7 @@ module RTM
       # the player of a subtype-Role. The current topic will play the
       # supertype-Role in each association. Returns the associations.
       #
-      # The identifier may be topic references.
+      # The identifiers may be topic references.
       #
       # :call-seq:
       #   add_subtypes(identifier1, identifier2, ...) -> Array of Associtions
@@ -133,13 +135,15 @@ module RTM
       #   transitive_subtypes -> Array of Topics
       #
       def transitive_subtypes
-        result_types = new_s_t = direct_subtypes
-        until new_s_t.empty?
-          new_s_t = new_s_t.map{|s| s.direct_subtypes}.flatten.uniq
-          new_s_t = new_s_t.reject{|s| result_types.include?(s)}
-          result_types = result_types + new_s_t
+        topic_map.cached self, :transitive_subtypes do
+          result_types = new_s_t = direct_subtypes
+          until new_s_t.empty?
+            new_s_t = new_s_t.map{|s| s.direct_subtypes}.flatten.uniq
+            new_s_t = new_s_t.reject{|s| result_types.include?(s)}
+            result_types = result_types + new_s_t
+          end
+          result_types
         end
-        return result_types
       end
       
       # Returns all subtypes of this Topic. The result includes the direct_subtypes

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

@@ -12,7 +12,7 @@ module RTM
       # The current Topic is not included in the result.
       # The result may be empty.
       #
-      # The identifier may be a Topic or Topic-Reference.
+      # The identifier may be a topic reference.
       #
       # :call-seq:
       #   traverse(identifier) -> Array of Topics

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

@@ -27,8 +27,9 @@ module RTM
       #   type -> Topic or nil
       #
       def type
-        raise "Topic must have exactly one type to call the type-method. Use the types-method instead." unless types.size < 2
-        types.size == 1 ? types.to_a.first : nil
+        _types = types
+        raise "Topic must have exactly one type to call the type-method. Use the types-method instead." unless _types.size < 2
+        _types.size == 1 ? _types.to_a.first : nil
       end
       
       # Returns the topics which are instances of this topic.
@@ -52,8 +53,9 @@ module RTM
       #   instance -> Topic
       #
       def instance
-        raise "Topic must have exactly one instance to call the instance-method. Use the instances-method instead." unless instances.size < 2
-        instances.size == 1 ?  instances.to_a.first : nil
+        _instances = instances
+        raise "Topic must have exactly one instance to call the instance-method. Use the instances-method instead." unless _instances.size < 2
+        _instances.size == 1 ?  _instances.to_a.first : nil
       end
       
       alias :reverse_types :instances

data/lib/rtm/psi.rb

@@ -29,6 +29,9 @@ module RTM
   PSI[:Integer] = "http://www.w3.org/2001/XMLSchema#integer"
   PSI[:Int] = "http://www.w3.org/2001/XMLSchema#int"
   PSI[:Decimal] = "http://www.w3.org/2001/XMLSchema#decimal"
+  PSI[:Date] = "http://www.w3.org/2001/XMLSchema#date"
+  PSI[:DateTime] = "http://www.w3.org/2001/XMLSchema#dateTime"
+  PSI[:Time] = "http://www.w3.org/2001/XMLSchema#time"
 
   PSI[:XTM] = "http://psi.topicmaps.org/iso13250/glossary/XTM"
   PSI[:association] = "http://psi.topicmaps.org/iso13250/glossary/association"
@@ -62,6 +65,9 @@ module RTM
   PSI[:variant] = "http://psi.topicmaps.org/iso13250/glossary/variant-name"
   PSI[:variant_name] = "http://psi.topicmaps.org/iso13250/glossary/variant-name"
 
+  PSI[:subject_representation] = "http://psi.topicmapslab.de/subject-representation"
+  PSI[:represented_subject] = "http://psi.topicmapslab.de/represented-subject"
+
   # languages
   # PSI[:] = "http://psi.oasis-open.org/iso/639/#"
   PSI[:language] = "http://psi.oasis-open.org/iso/639/#language"

data/lib/rtm/sugar.rb

@@ -1,34 +1,47 @@
 # Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
 # License:   Apache License, Version 2.0
 
-module RTM::Topic
-  require 'rtm/sugar/topic/topic_ref'
-  include Sugar::Topic::TopicRef
-  require 'rtm/sugar/topic/hash_access'
-  include RTM::Sugar::Topic::HashAccess
-  require 'rtm/sugar/topic/characteristics'
-  include Sugar::Topic::Characteristics
-  require 'rtm/sugar/topic/counterparts'
-  include Sugar::Topic::Counterparts
-  require 'rtm/sugar/topic/scoped'
-  include Sugar::Topic::Scoped
-  require 'rtm/sugar/topic/typed'
-  include Sugar::Topic::Typed
-end
-module RTM::Association
-  require "rtm/sugar/association/hash_access"
-  include Sugar::Association::HashAccess
-end
-module RTM::Role
-  require "rtm/sugar/role/counterparts"
-  include Sugar::Role::Counterparts
-end
-module RTM::Occurrence
-  require "rtm/sugar/occurrence/dynamic_value"
-  include Sugar::Occurrence::DynamicValue
-end
-module RTM::Typed
-  require "rtm/sugar/typed/types"
-  include Sugar::Typed::Types
+module RTM::Sugar;end
+
+require 'rtm/sugar/topic/topic_ref'
+require 'rtm/sugar/topic/hash_access'
+require 'rtm/sugar/topic/characteristics'
+require 'rtm/sugar/topic/counterparts'
+require 'rtm/sugar/topic/scoped'
+require 'rtm/sugar/topic/typed'
+require 'rtm/sugar/topic/best_name'
+RTM::Topic.register_extension(RTM::Sugar::Topic::TopicRef)
+RTM::Topic.register_extension(RTM::Sugar::Topic::HashAccess)
+RTM::Topic.register_extension(RTM::Sugar::Topic::Characteristics)
+RTM::Topic.register_extension(RTM::Sugar::Topic::Counterparts)
+RTM::Topic.register_extension(RTM::Sugar::Topic::Scoped)
+RTM::Topic.register_extension(RTM::Sugar::Topic::Typed)
+RTM::Topic.register_extension(RTM::Sugar::Topic::BestName)
+
+require "rtm/sugar/association/hash_access"
+RTM::Association.register_extension(RTM::Sugar::Association::HashAccess)
+
+require "rtm/sugar/role/counterparts"
+RTM::Role.register_extension(RTM::Sugar::Role::Counterparts)
+
+require "time"
+require "rtm/sugar/occurrence/dynamic_value"
+require "rtm/sugar/occurrence/external"
+RTM::Occurrence.register_extension(RTM::Sugar::Occurrence::DynamicValue)
+RTM::Occurrence.register_extension(RTM::Sugar::Occurrence::External)
+
+require "rtm/sugar/typed/types"
+RTM::Typed.register_extension(RTM::Sugar::Typed::Types)
+
+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'
+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)