rtm-javatmapi 0.2.0 → 0.2.1

data/lib/rtm/javatmapi.rb

@@ -7,31 +7,31 @@ rescue Exception => e
   raise "TMAPI Implementations are supported for JRuby only"
 end
 
-begin
+if Object.const_defined?("Gem") && rtmgem = Gem.loaded_specs["rtm-javatmapi"]
   require 'rtm'
-rescue LoadError
+else
   rtm_path = File.expand_path(File.join(File.dirname(__FILE__), "../../../rtm/lib"))
   if File.directory?(rtm_path)
-    $:.unshift rtm_path
+    $LOAD_PATH.unshift rtm_path
     require 'rtm'
   end
 end
 
 Dir[File.join(File.dirname(__FILE__), 'javatmapi/javalibs/*.jar')].each {|file| require file }
 
+# provide easy access to java classes in a net.* package
 def net
   Java::Net
 end
 
+# provide easy access to java classes in a de.* package
 def de
   Java::De
 end
 
 import org.tmapi.core.TopicMapSystemFactory
-require "rtm/javatmapi/java_implementations"
-require "rtm/javatmapi/inclusion"
-require "rtm/javatmapi/ext"
 require "rtm/javatmapi/superiseable"
+require "rtm/javatmapi/ext"
 require "rtm/javatmapi/core"
 require "rtm/javatmapi/aliases"
 
@@ -41,7 +41,6 @@ module RTM
       self == JavaTMAPI
     end
     
-    include RTM::TopicMapSystem
     extend Superiseable
     include org.tmapi.core.TopicMapSystem
     attr_reader :tmsf
@@ -56,7 +55,21 @@ module RTM
         in_file = java.io.FileInputStream.new(properties)
         props = java.util.Properties.new
         props.load(in_file)
-        @tmsf.setProperties(props)
+        if @tmsf.respond_to?(:setProperties)
+          # This is not part of the TMAPI interfaces but e.g. Ontopia supports it
+          @tmsf.setProperties(props)
+        else
+          # Try to read a java properties file. This ignores file continuations with backslash and may be incomplete in other respects
+          in_file = File.read_lines(features)
+          in_file.each do |line|
+            line.strip! # strip whitespaces at begin and end
+            next if line.blank? # skip empty lines
+            next if line =~ /^[#!]/ # skip comments
+            key, value = line.split(/\s*[=:\s]\s*/, 2) # split at "=", ":" or any whitespace surrounded by any number of whitespace
+            next if key.blank? # the value may be the empty string
+            @tmsf.setFeature(key, value)
+          end
+        end
       end
     end
     
@@ -69,6 +82,14 @@ module RTM
         features.each do |key, value|
           @tmsf.setFeature(key, value)
         end
+      elsif features.is_a?(String) && File.exists?(features)
+        # in contrast to properties, features values are always boolean
+        in_file = File.read_lines(features)
+        in_file.each do |line|
+          key, value = line.strip.split(/\s*[=:]\s*/, 2)
+          next if key.blank? or value.blank?
+          @tmsf.setFeature(key, %w[true 1 on enabled ja wahr da oui jo].include?(value)) # multi cultural feature files :)
+        end
       end
     end
     
@@ -106,7 +127,7 @@ module RTM
         else
           tm = @tms.createTopicMap(base_locator)
         end
-        tm.base_iri = base_locator.reference #safe as String
+        tm.base_iri ||= base_locator.reference #safe as String
         tm.engine = self
         tm.prefixes = {}
         return tm
@@ -157,9 +178,11 @@ module RTM
     end
 
     # Returns a property in the underlying implementation of TopicMapSystem.
-    def getProperty(property_name)
-      @tms.getProperty(property_name)
+    def property(property_name)
+      @tmsf.getProperty(property_name)
     end
+    alias :get_property :property
+    alias :getProperty :property
 
     # Returns topic maps stored in this connection.
     # The optional arguments may specify the iri the topic maps are stored at.

data/lib/rtm/javatmapi/aliases.rb

@@ -5,39 +5,39 @@
 
 module Java::OrgTmapiCore
   module TopicMap
-    
     alias :tii :type_instance_index
     alias :li :literal_index
     alias :si :scoped_index
-    alias :construct_ii :get_construct_by_item_identifier
-    alias :c_ii :construct_ii
-    alias :topic_si :get_topic_by_subject_identifier
-    alias :t_si :topic_si
-    alias :topic_sl :get_topic_by_subject_locator
-    alias :t_sl :topic_sl
-    alias :create_si :create_topic_by_subject_identifier
-    alias :create_sl :create_topic_by_subject_locator
-    alias :create_ii :create_topic_by_item_identifier
+
+    alias :by_ii :get_construct_by_item_identifier
+    alias :by_si :get_topic_by_subject_identifier
+    alias :by_sl :get_topic_by_subject_locator
+
+    alias :t :topics
+    alias :a :associations
   end
 
   module Topic
     alias :o :occurrences
     alias :n :names
-    alias :tii :type_instance_index
+
     alias :si :subject_identifiers
-    alias :si= :add_subject_identifier
     alias :add_si :add_subject_identifier 
-    alias :sl= :add_subject_locator
-    alias :add_sl :add_subject_locator
     alias :remove_si :remove_subject_identifier
+
+    alias :sl :subject_locators
+    alias :add_sl :add_subject_locator
     alias :remove_sl :remove_subject_locator
   end
 
   module Construct
-    
-    alias :item_identifiers= :add_item_identifier
+    alias :p :parent
+    alias :ii :item_identifiers
     alias :add_ii :add_item_identifier
-    alias :ii= :add_item_identifier
     alias :remove_ii :remove_item_identifier
   end
+
+  module Association
+    alias :r :roles
+  end
 end

data/lib/rtm/javatmapi/core.rb

@@ -14,3 +14,4 @@ require 'rtm/javatmapi/core/scoped'
 require 'rtm/javatmapi/core/locator'
 require 'rtm/javatmapi/core/variant'
 require 'rtm/javatmapi/core/typed'
+require 'rtm/javatmapi/core/datatype_aware'

data/lib/rtm/javatmapi/core/association.rb

@@ -3,8 +3,8 @@
 
 module Java::OrgTmapiCore::Association
   
+  include RTM::Association
   extend Superiseable
-  #include RTM::Association
   
   superised
   # Returns the topic map this association belongs to.
@@ -47,7 +47,7 @@ module Java::OrgTmapiCore::Association
   # The optional identifier specifies the type of
   # the returned Roles.
   #
-  # Identifier may be a Topic or Topic-Reference.
+  # Identifier may be a topic reference.
   #
   # The result may be empty.
   #

data/lib/rtm/javatmapi/core/construct.rb

@@ -3,8 +3,8 @@
 
 module Java::OrgTmapiCore::Construct
   
+  include RTM::Construct
   extend Superiseable
-  #include RTM::Construct
 
   # Returns the TopicMap instance this Construct belongs to.
   #
@@ -15,12 +15,31 @@ module Java::OrgTmapiCore::Construct
     getTopicMap
   end
   
+  # Returns the parent construct this construct belongs to.
+  #
+  # :call-seq:
+  #   parent -> a construct (TopicMap, Topic, Association or Name)
+  #
+  def parent
+    getParent
+  end
+
   # Returns true if the construct fulfills all constraints defined in the TMDM
   def valid?
     # This is defined in RTM::AR and we test it. I guess from the API perspective, in TMAPI the validness of an object is guaranteed.
     true
   end unless self.method_defined?(:valid?)
 
+
+  # Returns the item identifiers assigned to the current construct.
+  #
+  # :call-seq:
+  #   item_identifiers -> Set of Locators
+  #
+  def item_identifiers
+    getItemIdentifiers
+  end
+
   superised
   # Adds an item identifier to this construct.
   # Identifier may be a String or Locator.
@@ -30,13 +49,18 @@ module Java::OrgTmapiCore::Construct
   #
   def add_item_identifier(identifier)
     # TODO Spec
-    if identifier.is_a? Java::OrgTmapiCore::Locator
-      addItemIdentifier(identifier)
-    else
-      addItemIdentifier(topic_map.create_locator(identifier))
+    begin
+      if identifier.is_a? Java::OrgTmapiCore::Locator
+        addItemIdentifier(identifier)
+      else
+        addItemIdentifier(topic_map.create_locator(identifier))
+      end
+    rescue org.tmapi.core.IdentityConstraintException => ice
+      # TODO add condition to switch off automerge
+      self.mergeIn(self.topic_map.get(identifier))
     end
   end
-  alias :item_identifiers= :add_item_identifier
+  alias :item_identifiers= :add_item_identifier # FIXME ii= is not add! it's set.
 
 
   superised

data/lib/rtm/javatmapi/core/datatype_aware.rb

@@ -0,0 +1,60 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module Java::OrgTmapiCore::DatatypeAware
+
+  include RTM::DatatypeAware
+  extend Superiseable
+
+  superised
+  # Changes the value (and if given, the datatype) of this Occurrence.
+  #
+  # The datatype must be a String or Locator.
+  #
+  # If value is a String, this methods sets the string value and
+  # the datatype implicitly to xsd:string.
+  #
+  # If argument is a Locator, this method sets the IRI value and
+  # the datatype implicitly to xsd:anyURI.
+  #
+  # If argument is a Float, this method sets the Float value and
+  # the datatype implicitly to xsd:float.
+  #
+  # If argument is a Fixnum, this method sets Fixnum value and
+  # the datatype implicitly to xsd:long.
+  #
+  # If argument is a Bignum, this method sets Bignum value and
+  # the datatype implicitly to xsd:integer.
+  #
+  # :call-seq:
+  #   value = value
+  #   value = value, datatype
+  #
+	def value=(args)
+    if args.is_a?(Array)
+      raise("value=(value) or value=(value,datatype)") unless args.size == 2
+      datatype = topic_map.create_locator(args.last)
+      value = args.first.to_s
+      if datatype.reference == RTM::PSI[:IRI]
+        setValue(topic_map.create_locator(value))
+      else
+        setValue(value, datatype)
+      end
+    else
+      setValue(args)
+    end
+  end
+
+  # Sets the datatype of this occurrence without changing its value.
+  #
+  # The datatype must be a String or Locator.
+  #
+  # :call-seq:
+  #   datatype = datatype
+  #
+  def datatype=(datatype)
+    self.value = self.value, datatype
+  end
+  alias :set_datatype :datatype=
+
+end

data/lib/rtm/javatmapi/core/locator.rb

@@ -2,10 +2,10 @@
 # License:   Apache License, Version 2.0
 
 module Java::OrgTmapiCore::Locator
-  
-  #include RTM::Locator
+
+  include RTM::Locator
   extend Superiseable
-  
+
   # Returns the external form of the IRI.
   # Any special character will be escaped using the escaping conventions
   # of RFC 3987.
@@ -16,9 +16,5 @@ module Java::OrgTmapiCore::Locator
   def value
     toExternalForm
   end
-  
- superised
-  def to_s
-    self.value
-  end
+
 end

data/lib/rtm/javatmapi/core/name.rb

@@ -3,9 +3,8 @@
 
 module Java::OrgTmapiCore::Name
 
-  #include RTM::Name
+  include RTM::Name
   extend Superiseable
-  
 
   # Returns the Topic this Name belongs to.
   #
@@ -52,50 +51,77 @@ module Java::OrgTmapiCore::Name
   # Creates a Variant given the value and scope, if value is a Locator or
   # given value, datatype and scope, if the value is a String.
   #
-  # Scope may be an Array of Topic/Topic-References and must not be empty.
+  # Scope may be an Array of topic references and must not be empty.
   #
-  # Datatype may be a Topic-Reference (String or Locator).
+  # Datatype may be a String or Locator.
   #
   # :call-seq:
   #   create_variant(value, scope) -> Variant
   #   create_variant(value, datatype, scope) -> Variant
   #
-  def create_variant(arg1, arg2, arg3 = :nothing)
-    if arg1.is_a?(Java::OrgTmapiCore::Locator)
-      raise("create_variant(value,scope), value: Locator, scope must be an Array") unless arg2.is_a?(Array)
-      if arg2.empty?
-        raise("create_variant(value,scope), value: Locator, scope must not be empty")
-      end
-      arg2.each do |theme|
-        raise("create_variant(value,scope), value: Locator, scope must contain Topic/Topic-References") unless (theme.is_a?(Java::OrgTmapiCore::Topic) || theme.is_a?(String) || theme.is_a?(Java::OrgTmapiCore::Locator))
-      end
-      return createVariant(arg1, topic_map.get!(arg2).to_java(org.tmapi.core.Topic))
-    elsif arg1.is_a?(String) 
-      if arg3 == :nothing 
-        raise("create_variant(value,scope), value: String, scope must be an Array") unless arg2.is_a?(Array)
-        if arg2.empty?
-          raise("create_variant(value,scope), value: String, scope must not be empty")
-        end
-        arg2.each do |theme|
-          raise("create_variant(value,scope), value: String, scope must contain Topic/Topic-References") unless (theme.is_a?(Java::OrgTmapiCore::Topic) || theme.is_a?(String) || theme.is_a?(Java::OrgTmapiCore::Locator))
-        end
-        return createVariant(arg1, topic_map.get!(arg2).to_java(org.tmapi.core.Topic))
-      elsif (arg2.is_a?(Locator) || arg2.is_a?(String))
-        if ((arg2 == RTM::PSI[:String]) || (arg2 == topic_map.create_locator(RTM::PSI[:String])))
-          return createVariant(arg1, topic_map.create_locator(RTM::PSI[:String]), topic_map.get!(arg3))
-        elsif ((arg2 == RTM::PSI[:IRI]) || (arg2 == topic_map.create_locator(RTM::PSI[:IRI])))
-          return createVariant(arg1, topic_map.create_locator(RTM::PSI[:IRI]), topic_map.get!(arg3))
-        elsif ((arg2 == RTM::PSI[:XML]) || (arg2 == topic_map.create_locator(RTM::PSI[:XML])))
-          return createVariant(arg1, topic_map.create_locator(RTM::PSI[:XML]), topic_map.get!(arg3))
-        else 
-          raise("create_variant(value,datatype,scope), value: String, unknown datatype")
-        end
+  def create_variant(value, *args)
+    # reading scope and datatype, if given
+    if args.length == 1
+      if args.first.is_a?(Hash)
+        # TODO
       else
-        raise("create_variant(value,datatype,scope), datatype must be a String (identifier) or Locator")
-      end 
+        # scope given
+        scope = args.first
+        raise("create_variant(value, scope): scope must be an Array") unless scope.is_a?(Array)
+      end
+    elsif args.length == 2
+      # datatype and scope given
+      datatype = args.first
+      scope = args.last
+      raise("create_variant(value, datatype, scope): scope must be an Array") unless scope.is_a?(Array)
     else
-      raise "create_variant: value not a Locator or String"
-    end  
+      raise("create_variant: arguments don't match - no scope given.")
+    end
+    # reading the value and setting the datatype dynamicaly if not set before
+    unless datatype
+      if value.is_a?(Java::OrgTmapiCore::Locator)
+        datatype ||= RTM::PSI[:IRI]
+      elsif value.is_a?(String)
+        datatype ||= RTM::PSI[:String]
+      elsif value.is_a?(Float)
+        datatype ||= RTM::PSI[:Float]
+      elsif value.is_a?(Fixnum)
+        datatype ||= RTM::PSI[:Long]
+      elsif value.is_a?(Bignum)
+        datatype ||= RTM::PSI[:Integer]
+      elsif value.is_a?(DateTime) #DateTime is a Time and a Date
+        datatype ||= RTM::PSI[:DateTime]
+      elsif value.is_a?(Time)
+        datatype ||= RTM::PSI[:Time]
+      elsif value.is_a?(Date)
+        datatype ||= RTM::PSI[:Date]
+      else
+        raise NoDatatypeHandlerAvailableException.new(value)
+      end
+    end
+    # creating locator for datatype
+    datatype = topic_map.create_locator(datatype)
+    # value must be a String
+    value = value.to_s
+    # if datatype is xsd:anyURI -> resolve value against base_iri
+    if datatype.reference == RTM::PSI[:IRI]
+      value = topic_map.create_locator(value).reference
+    end
+    # creating an array of topics for the scope
+    scope = topic_map.get!(scope).to_java(org.tmapi.core.Topic)
+
+    begin
+      createVariant(value, datatype, scope)
+    rescue java.lang.IllegalArgumentException => iae
+      raise(iae.message)
+    end
+  end
+
+  private
+  class NoDatatypeHandlerAvailableException < Exception
+    def initialize(value)
+      super "Cannot map #{value} to a variant value+datatype. Maybe you need to add a handler for your Ruby object type."
+    end
   end
-  
+
 end