rtm-javatmapi 0.2.1 → 0.3.0

data/lib/{rtm/javatmapi/core/topic_map_system.rb → rtm-javatmapi.rb}

@@ -1,6 +1,4 @@
 # Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
 # License:   Apache License, Version 2.0
 
-module Java::OrgTmapiCore::TopicMapSystem
-  
-end
+require File.join(File.dirname(__FILE__), 'rtm/javatmapi')

data/lib/rtm/javatmapi.rb

@@ -7,29 +7,15 @@ rescue Exception => e
   raise "TMAPI Implementations are supported for JRuby only"
 end
 
-if Object.const_defined?("Gem") && rtmgem = Gem.loaded_specs["rtm-javatmapi"]
-  require 'rtm'
-else
+unless Object.const_defined?("Gem") && rtmgem = Gem.loaded_specs["rtm-javatmapi"]
   rtm_path = File.expand_path(File.join(File.dirname(__FILE__), "../../../rtm/lib"))
-  if File.directory?(rtm_path)
-    $LOAD_PATH.unshift rtm_path
-    require 'rtm'
-  end
+  $LOAD_PATH.unshift rtm_path if File.directory?(rtm_path)
 end
+require 'rtm'
 
 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
+import Java::OrgTmapiCore::TopicMapSystemFactory
 require "rtm/javatmapi/superiseable"
 require "rtm/javatmapi/ext"
 require "rtm/javatmapi/core"
@@ -42,10 +28,10 @@ module RTM
     end
     
     extend Superiseable
-    include org.tmapi.core.TopicMapSystem
+    include Java::OrgTmapiCore::TopicMapSystem
     attr_reader :tmsf
     attr_reader :tms
-        
+
     def set_properties(properties)
       if properties.is_a?(Hash)
         properties.each do |key, value|
@@ -113,29 +99,52 @@ module RTM
     end
     alias :createLocator :create_locator
 
-    # Creates and returns a new topic map given a base_locator.
-    # The base locator may be a String or a Locator.
+    # Creates and returns a new topic map given a locator.
+    # The locator may be a String or a Locator.
     #
     # :call-seq:
-    #   create(base_locator) -> Topic Map
+    #   create(locator) -> Topic Map
     #
-    def create(base_locator, *args)
-        base_locator = @tms.create_locator(base_locator) if base_locator.is_a?(String)
-        raise("base_locator must be a String or Locator") unless base_locator.is_a?(Locator)
-        if (@tms.getLocators.include?(base_locator))
-          tm = @tms.getTopicMap(base_locator)
-        else
-          tm = @tms.createTopicMap(base_locator)
-        end
-        tm.base_iri ||= base_locator.reference #safe as String
+    def create(locator)
+      locator = @tms.create_locator(locator) if locator.is_a?(String)
+      raise("locator must be a String or Locator but is: #{locator.inspect}") unless locator.is_a?(RTM::Locator)
+      if (@tms.getLocators.include?(locator))
+        tm = @tms.getTopicMap(locator)
+        tm.add_prefix("xsd", RTM::PREFIX[:xsd]) # hack, default prefix for xsd
+        tm.engine = self # hack
+      else
+        tm = @tms.createTopicMap(locator)
+        tm.add_prefix("xsd", RTM::PREFIX[:xsd]) # default prefix for xsd
         tm.engine = self
-        tm.prefixes = {}
-        return tm
-      #end
+      end
+      tm
     end
     alias :create_topic_map :create
     alias :createTopicMap :create
 
+    # Deletes the topic map from the engine.
+    def delete(locator)
+      locator = @tms.create_locator(locator) if locator.is_a?(String)
+      raise("locator must be a String or Locator") unless locator.is_a?(RTM::Locator)
+      if (@tms.getLocators.include?(locator))
+        tm = @tms.getTopicMap(locator)
+        tm.prefixes.clear
+        tm.clear
+        tm.remove
+      else
+        raise("Topic Map with base locator #{locator.reference} not existing")
+      end
+    end
+    alias :delete_topic_map :delete
+    alias :deleteTopicMap :delete
+
+    # States if the topic map given by the locator is existing in the engine.
+    def existing?(locator)
+      locator = @tms.create_locator(locator) if locator.is_a?(String)
+      raise("locator must be a String or Locator") unless locator.is_a?(RTM::Locator)
+      return @tms.getTopicMap(locator) ? true : false
+    end
+
     # Retrieves a topic map managed by this connection
     # with the specified storage address iri.
     # The iri may be a String or Locator.

data/lib/rtm/javatmapi/core.rb

@@ -1,7 +1,6 @@
 # Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
 # License:   Apache License, Version 2.0
 
-require 'rtm/javatmapi/core/topic_map_system'
 require 'rtm/javatmapi/core/construct'
 require 'rtm/javatmapi/core/reifiable'
 require 'rtm/javatmapi/core/topic_map'

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

@@ -55,7 +55,7 @@ module Java::OrgTmapiCore::Construct
       else
         addItemIdentifier(topic_map.create_locator(identifier))
       end
-    rescue org.tmapi.core.IdentityConstraintException => ice
+    rescue Java::OrgTmapiCore::IdentityConstraintException => ice
       # TODO add condition to switch off automerge
       self.mergeIn(self.topic_map.get(identifier))
     end

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

@@ -108,7 +108,7 @@ module Java::OrgTmapiCore::Name
       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)
+    scope = topic_map.get!(scope).to_java(Java::OrgTmapiCore::Topic)
 
     begin
       createVariant(value, datatype, scope)

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

@@ -210,16 +210,6 @@ module Java::OrgTmapiCore::Topic
   end
   alias :reverse_children :parent
 
-  # Calls TMAPI TopicMap.getIndex which
-  # returns the index for the TypeInstanceIndex.
-  #
-  # :call-seq:
-  #   type_instance_index -> TypeInstanceIndex
-  #
-  def type_instance_index
-    topic_map.type_instance_index
-  end
-
   superised
   # Returns the Roles played by this Topic.
   #
@@ -301,7 +291,7 @@ module Java::OrgTmapiCore::Topic
       else
         addSubjectIdentifier(topic_map.create_locator(identifier))
       end
-    rescue org.tmapi.core.IdentityConstraintException => ice
+    rescue Java::OrgTmapiCore::IdentityConstraintException => ice
       # TODO add condition to switch off automerge
       self.mergeIn(self.topic_map.get(identifier))
     end
@@ -345,7 +335,7 @@ module Java::OrgTmapiCore::Topic
       else
         addSubjectLocator(topic_map.create_locator(identifier))
       end
-    rescue org.tmapi.core.IdentityConstraintException => ice
+    rescue Java::OrgTmapiCore::IdentityConstraintException => ice
       # TODO add condition to switch off automerge
       self.mergeIn(self.topic_map.topic_by_subject_locator(identifier))
     end
@@ -511,7 +501,7 @@ module Java::OrgTmapiCore::Topic
 
   private
   def new_empty_java_topic_array
-    [].to_java(org.tmapi.core.Topic)
+    [].to_java(Java::OrgTmapiCore::Topic)
   end
 
   class NoDatatypeHandlerAvailableException < Exception

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

@@ -8,35 +8,43 @@ module Java::OrgTmapiCore::TopicMap
   include RTM::TopicMap
   extend Superiseable
 
-  attr_accessor :prefixes #hash
-  
-  attr_reader :base_iri
-  def base_iri=(base_iri)
-    class << self;undef :base_iri=;end
-    @base_iri = base_iri
+  attr_reader :prefixes #hash
+
+  # returns the base iri of this topic map
+  def base_iri
+    getLocator.reference
   end
-  
   alias :base_locator :base_iri
 
+  def prefixes
+    @prefixes ||= {}
+  end
+
+
   # Adds the identifier (key) and reference (value) to the prefixes-Hash and
   # returns all prefixes. Qnames consisting of "identifier:localpart"
   # will be converted to "referencelocalpart".
   #
-  # The identifier and reference must be Strings.
-  #
-  # Example:
-  #   add_prefix("tml","http://www.topicmapslab.de/")
-  #
-  # :call-seq:
-  #   add_prefix(identifier,reference) -> Hash
-  #
-  def add_prefix(identifier,reference)
+  # @param [String] identifier
+  # @param [String] reference
+  # @example
+  #   add_prefix("tml", "http://www.topicmapslab.de/")
+  # @return void
+  def add_prefix(identifier, reference)
     unless identifier.is_a?(String) && reference.is_a?(String)
       raise("add_prefix: identifier and reference must be Strings")
+      # TODO @raise in yardoc
+    end
+    if identifier.empty? || reference.empty?
+      raise("add_prefix: identifier or reference may not be empty")
     end
-    #if (identifier == "sl") || (identifier == "si") || (identifier == "ii")
-    #  warn("prefixes: identifier is either sl, si or ii")
-    #end
+    if (identifier == "sl") || (identifier == "si") || (identifier == "ii")
+      raise("add_prefix: identifier 'sl', 'si' or 'ii' not allowed for prefixes")
+    end
+    unless reference.include?(URI_PATTERN)
+      raise("add_prefix: reference must be absulute")
+    end
+    # prefix xsd is allowed
     prefixes[identifier]= reference
     prefixes
   end
@@ -174,10 +182,10 @@ module Java::OrgTmapiCore::TopicMap
     end
     raise("create_association: type must be a Topic or Topic-Reference") unless type.is_a?(Java::OrgTmapiCore::Topic) || type.is_a?(String) || type.is_a?(Java::OrgTmapiCore::Locator)
     if scope == :ucs
-      assoc = createAssociation(get!(type),[].to_java(org.tmapi.core.Topic))
+      assoc = createAssociation(get!(type),[].to_java(Java::OrgTmapiCore::Topic))
     else
       raise("create_association: scope must be an Array") unless scope.is_a?(Array)
-      assoc = scope.empty? ? createAssociation(get!(type),[].to_java(org.tmapi.core.Topic)) : createAssociation(get!(type),get!(scope))
+      assoc = scope.empty? ? createAssociation(get!(type),[].to_java(Java::OrgTmapiCore::Topic)) : createAssociation(get!(type),get!(scope))
     end 
     raise("create_association: roles must be a Hash") unless roles.is_a?(Hash)
     roles.each do |k,v|
@@ -199,7 +207,7 @@ module Java::OrgTmapiCore::TopicMap
   #
   def type_instance_index
     # Equals _index(:TypeInstanceIndex), which doesn't work yet
-    getIndex(org.tmapi.index.TypeInstanceIndex.java_class)
+    getIndex(Java::OrgTmapiIndex::TypeInstanceIndex.java_class)
   end
 
   # Calls TMAPI TopicMap.getIndex which
@@ -210,7 +218,7 @@ module Java::OrgTmapiCore::TopicMap
   #
   def literal_index
     # Equals _index(:LiteralIndex), which doesn't work yet
-    getIndex(org.tmapi.index.LiteralIndex.java_class)
+    getIndex(Java::OrgTmapiIndex::LiteralIndex.java_class)
   end
 
   # Calls TMAPI TopicMap.getIndex which
@@ -221,7 +229,7 @@ module Java::OrgTmapiCore::TopicMap
   #
   def scoped_index
     # Equals _index(:ScopedIndex), which doesn't work yet
-    getIndex(org.tmapi.index.ScopedIndex.java_class)
+    getIndex(Java::OrgTmapiIndex::ScopedIndex.java_class)
   end
 
   # Returns all topics in the topic map that are used as instance
@@ -261,7 +269,7 @@ module Java::OrgTmapiCore::TopicMap
   #
   # The return value may be empty.
   #
-  # :call_spec:
+  # :call-seq:
   #   associations -> Set of Associations
   #   associations(type) -> Array of Associations
   #
@@ -272,46 +280,6 @@ module Java::OrgTmapiCore::TopicMap
     return type ? type_instance_index.getAssociations(type).to_a : []
   end
 
-  # Returns all topics in this topic map that are used
-  # as types of associations.
-  #
-  # :call-seq:
-  #   association_types -> Set of Topics
-  #
-  def association_types
-    type_instance_index.getAssociationTypes
-  end
-
-  # Returns the all Topics in this TopicMap that are used
-  # as types of Roles.
-  #
-  # :call-seq:
-  #   role_types -> Set of Topics
-  #
-  def role_types
-    type_instance_index.getRoleTypes
-  end
-
-  # Returns all Topics in this TopicMap that are used
-  # as types of Names.
-  #
-  # :call-seq:
-  #   name_types -> Set of Topics
-  #
-  def name_types
-    type_instance_index.getNameTypes
-  end
-
-  # Returns all Topics in this TopicMap that are used
-  # as types of Occurrences.
-  #
-  # :call-seq:
-  #   occurrence_types -> Set of Topics
-  #
-  def occurrence_types
-    type_instance_index.getOccurrenceTypes
-  end
-
   superised
   # Returns all topics contained in this topic map.
   #
@@ -337,11 +305,39 @@ module Java::OrgTmapiCore::TopicMap
   # :call-seq:
   #   create_locator(identifier) -> Locator
   #
-  def create_locator(identifier)
+  def create_locator(identifier, to_raise = org.tmapi.core.MalformedIRIException)
     return identifier if identifier.is_a?(Java::OrgTmapiCore::Locator)
-    identifier = check_for_qname(identifier) unless prefixes.empty?
-    identifier = proper_base_iri + identifier if identifier.is_a?(String) && !identifier.include?(URI_PATTERN)
-    createLocator(identifier)
+    raise("create_locator: identifier must be a String") unless identifier.is_a?(String)
+    qname = check_for_qname(identifier)
+    if qname
+      identifier = qname
+    else
+      unless identifier.include?(URI_PATTERN)
+        begin
+          if self.engine.identifier == :tinytim
+            identifier = identifier.gsub(' ','%20')
+          end
+          identifier = getLocator.resolve(identifier)
+        rescue org.tmapi.core.MalformedIRIException => mie
+          if to_raise == mie
+            raise(mie.message)
+          else
+            return :fail
+          end
+        end
+        return identifier
+      end
+    end
+    begin
+      identifier = createLocator(identifier)
+    rescue org.tmapi.core.MalformedIRIException => mie
+      if to_raise == mie
+        raise(mie.message)
+      else
+        return :fail
+      end
+    end
+    return identifier
   end
 
   superised
@@ -553,6 +549,26 @@ module Java::OrgTmapiCore::TopicMap
     getConstructById(id)
   end
 
+  # Returns all names occurring in the topic map
+  def names
+    name_types.map{|type| type.typed_names.to_a}.flatten
+  end
+
+  # Returns all occurrences occurring in the topic map
+  def occurrences
+    occurrence_types.map{|type| type.typed_occurrences.to_a}.flatten
+  end
+
+  # Returns all roles occurring in the topic map
+  def roles
+    role_types.map{|type| type.typed_roles.to_a}.flatten
+  end
+
+  # Returns all variants occurring in the topic map
+  def variants
+    names.map{|name| name.variants.to_a}.flatten
+  end
+
   private
 
   # If the identifier is a qname (= "prefix_identifier" + ":" + "localpart"),
@@ -561,20 +577,24 @@ module Java::OrgTmapiCore::TopicMap
   # found in the prefixes-Hash.
   #
   # Returnes the enhanced identifier if successfull.
-  # Returns the original identifier if no substitution
-  # occured.
+  # Returns the nil if no substitution occured.
   #
   # :call-seq:
   #   check_for_qname(identifier) -> String
   #
   def check_for_qname(identifier)
+    return nil if prefixes.empty?
+    
     sections = identifier.split(":")
-    key = sections[0]
-    if (sections.size > 1) && (prefixes.has_key?(key))
-      identifier = identifier.sub(key + ":", prefixes[key])
-      # TODO check NOW if identifier is a valid URI ? or may the identifier still be relative?
+    prefix_identifier = sections[0]
+    if (sections.size > 1) && prefixes.has_key?(prefix_identifier)
+      localpart = identifier.sub("#{prefix_identifier}:", "")
+      # check localpart
+      unless localpart.include?("/") # no / allowed in localpart
+        return prefixes[prefix_identifier] + localpart
+      end
     end
-    return identifier
+    return nil
   end 
 
   # Calls TMAPI TopicMap.getIndex which
@@ -588,7 +608,7 @@ module Java::OrgTmapiCore::TopicMap
   # JRuby doesn't seem to like "send" there;
   # solution: use getIndex directly
   def _index(i)
-    getIndex(org.tmapi.index.send(i).java_class)
+    getIndex(Java::OrgTmapiIndex::send(i).java_class)
   end
 
   # If identifier is not a String or Locator -> assumes it is an Array.
@@ -652,6 +672,7 @@ module Java::OrgTmapiCore::TopicMap
     end
   end
 
+  # TODO delete?
   def proper_base_iri
     if base_iri[-1] == '/'[-1]
       return base_iri

data/lib/rtm/javatmapi/superiseable.rb

@@ -23,9 +23,7 @@ module Superiseable
     self.included(klass) if self.respond_to?(:included)
     return unless @superized_methods
     @superized_methods.each do |method_name|
-      klass.class_eval do
-        define_method(method_name) { |*args| super *args}
-      end
+      klass.class_eval("def #{method_name}(*args); super; end")
     end
   end
 end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: rtm-javatmapi
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Benjamin Bock
@@ -12,21 +17,25 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-21 00:00:00 +01:00
+date: 2010-04-13 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rtm
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.2.1
-    version: 
+        segments: 
+        - 0
+        - 3
+        - 0
+        version: 0.3.0
+  type: :runtime
+  version_requirements: *id001
 description: "    Ruby Topic Maps is a Topic Maps engine written in Ruby.\n    This backend engine uses any Java TMAPI 2.0 compatible backend. See http://www.tmapi.org/2.0/.\n    You can provide your own TMAPI 2.0 compatible implementation or use one of the existing ones:\n    * rtm-ontopia\n    * rtm-tinytim\n    * rtm-sesametm    \n"
-email: rtm+rtm-javatmapi-gem-20100221@topicmapslab.de
+email: rtm+rtm-javatmapi-gem-20100413@topicmapslab.de
 executables: []
 
 extensions: []
@@ -46,7 +55,6 @@ files:
 - lib/rtm/javatmapi/core/scoped.rb
 - lib/rtm/javatmapi/core/topic.rb
 - lib/rtm/javatmapi/core/topic_map.rb
-- lib/rtm/javatmapi/core/topic_map_system.rb
 - lib/rtm/javatmapi/core/typed.rb
 - lib/rtm/javatmapi/core/variant.rb
 - lib/rtm/javatmapi/core.rb
@@ -54,9 +62,10 @@ files:
 - lib/rtm/javatmapi/ext.rb
 - lib/rtm/javatmapi/superiseable.rb
 - lib/rtm/javatmapi.rb
+- lib/rtm-javatmapi.rb
 - lib/rtm/javatmapi/javalibs/asm-2.2.3.jar
 - lib/rtm/javatmapi/javalibs/asm-commons-2.2.3.jar
-- lib/rtm/javatmapi/javalibs/ctm-writer-1.0.0a.jar
+- lib/rtm/javatmapi/javalibs/ctm-writer-1.0.5.a1.jar
 - lib/rtm/javatmapi/javalibs/jing.jar
 - lib/rtm/javatmapi/javalibs/json_simple.jar
 - lib/rtm/javatmapi/javalibs/log4j-1.2.14.jar
@@ -77,9 +86,9 @@ files:
 - lib/rtm/javatmapi/javalibs/semagia-mio-xtm-0.9.5.jar
 - lib/rtm/javatmapi/javalibs/slf4j-api-1.5.8.jar
 - lib/rtm/javatmapi/javalibs/slf4j-log4j12-1.5.8.jar
-- lib/rtm/javatmapi/javalibs/tinytim-mio-2.0.0a5.jar
-- lib/rtm/javatmapi/javalibs/tmapi-2.0.jar
-- lib/rtm/javatmapi/javalibs/tmapix-io-0.3.0-snapshot-200910281502.jar
+- lib/rtm/javatmapi/javalibs/tinytim-mio-2.0.0a6.jar
+- lib/rtm/javatmapi/javalibs/tmapi-2.0.2.jar
+- lib/rtm/javatmapi/javalibs/tmapix-io-0.3.0.jar
 - lib/rtm/javatmapi/javalibs/trove-2.0.4.jar
 - LICENSE
 - DISCLAIMER
@@ -88,7 +97,7 @@ has_rdoc: true
 homepage: http://rtm.topicmapslab.de/
 licenses: []
 
-post_install_message: You have successfully installed rtm-javatmapi.
+post_install_message: 
 rdoc_options: []
 
 require_paths: 
@@ -97,18 +106,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: rtm
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Ruby Topic Maps is a Topic Maps engine written in Ruby. The javatmapi gem holds common code for Java TMAPI-based engines.