rtm-javatmapi 0.3.1-java

data/DISCLAIMER

@@ -0,0 +1,15 @@
+Copyright 2006-2008 Benjamin Bock
+
+Copyright 2008-2010 Topic Maps Lab, University of Leipzig.
+
+Licensed under the Apache License, Version 2.0 (the "License"); 
+you may not use this file except in compliance with the License. 
+You may obtain a copy of the License at 
+
+  http://www.apache.org/licenses/LICENSE-2.0 
+
+Unless required by applicable law or agreed to in writing, software 
+distributed under the License is distributed on an "AS IS" BASIS, 
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
+See the License for the specific language governing permissions and limitations 
+under the License.

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README

@@ -0,0 +1,4 @@
+Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+License:   Apache License, Version 2.0
+
+See http://rtm.topicmapslab.de/ for instructions.

data/lib/rtm-javatmapi.rb

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

data/lib/rtm/javatmapi.rb

@@ -0,0 +1,229 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+begin
+  require 'java'
+rescue Exception => e
+  raise "TMAPI Implementations are supported for JRuby only"
+end
+
+unless Object.const_defined?("Gem") && rtmgem = Gem.loaded_specs["rtm-javatmapi"]
+  rtm_path = File.expand_path(File.join(File.dirname(__FILE__), "../../../rtm/lib"))
+  $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 }
+
+import Java::OrgTmapiCore::TopicMapSystemFactory
+require "rtm/javatmapi/superiseable"
+require "rtm/javatmapi/ext"
+require "rtm/javatmapi/core"
+require "rtm/javatmapi/aliases"
+
+module RTM
+  class JavaTMAPI < Engine
+    def self.abstract?
+      self == JavaTMAPI
+    end
+    
+    extend Superiseable
+    include Java::OrgTmapiCore::TopicMapSystem
+    attr_reader :tmsf
+    attr_reader :tms
+
+    def set_properties(properties)
+      if properties.is_a?(Hash)
+        properties.each do |key, value|
+          @tmsf.setProperty(key, value)
+        end
+      elsif properties.is_a?(String) && File.exists?(properties)
+        in_file = java.io.FileInputStream.new(properties)
+        props = java.util.Properties.new
+        props.load(in_file)
+        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
+    
+    def set_tmsf(tmsf)
+      @tmsf = tmsf
+    end
+    
+    def set_features(features)
+      if features.is_a?(Hash)
+        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
+    
+    def create_system
+      @tms = @tmsf.newTopicMapSystem
+    end
+    
+    def refresh
+      RTM.included_modules.each {|im| self.extend(im)}
+      RTM.included_modules.each {|im| self.class.class_eval("include #{im}")}
+    end
+
+    # Returns a Locator instance representing the specified IRI reference.
+    # The specified IRI reference is assumed to be absolute.
+    #
+    # :call-seq:
+    #   create_locator(reference) -> Locator
+    #
+    def create_locator(reference)
+      @tms.create_locator(reference)
+    end
+    alias :createLocator :create_locator
+
+    # Creates and returns a new topic map given a locator.
+    # If a topic map is given directly it is returned.
+    # If a topic map with this locator already exists the existing one is returned.
+    # The locator may be a String or a Locator.
+    #
+    # :call-seq:
+    #   create(locator_or_tm) -> Topic Map
+    #
+    def create(locator_or_tm)
+      return locator_or_tm if locator_or_tm.is_a?(RTM::TopicMap)
+      locator = locator_or_tm
+      raise("locator must be a String or Locator but is: #{locator.inspect}") unless (locator.is_a?(RTM::Locator) || locator.is_a?(String))
+      tm = topic_map(locator)
+      unless tm
+        tm = @tms.createTopicMap(locator)
+        tm.add_prefix("xsd", RTM::PREFIX[:xsd]) # default prefix for xsd
+        tm.set_engine(self)
+      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 = topic_map(locator)
+        tm.prefixes.clear
+        tm.clear unless self.identifier == :hatana
+        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)
+      raise("locator must be a String or Locator") unless (locator.is_a?(RTM::Locator) || locator.is_a?(String))
+      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.
+    #
+    # If no topic map is stored at the specified iri, nil is returned.
+    def topic_map(iri)
+      return iri if iri.is_a?(RTM::TopicMap)
+      raise("The iri must be a String or Locator") unless (iri.is_a?(Locator) || iri.is_a?(String))
+      tm = @tms.getTopicMap(iri) #could be nil
+      if tm
+        tm.add_prefix("xsd", RTM::PREFIX[:xsd]) # hack, default prefix for xsd
+        tm.set_engine(self) # hack
+      end
+      tm
+    end
+    alias :getTopicMap :topic_map
+    alias :get_topic_map :topic_map
+
+    # Returns all storage addresses of TopicMap instances known by this
+    # connection. The return value may be empty but is never null.
+    #
+    # :call-seq:
+    #   locators -> Array of Strings
+    #
+    def locators()
+      @tms.getLocators.map {|l| l.reference}
+    end
+    alias :get_locators :locators
+
+    # Returns all storage addresses of TopicMap instances known by this
+    # connection. The return value may be empty but is never null.
+    #
+    # :call-seq:
+    #   locators -> Array of Locators
+    #
+    def getLocators
+      @tms.getLocators
+    end
+
+    # Returns the value of the feature specified by feature_name
+    # for the TopicMapSystem instance stored by this connection:
+    # * true, if the named feature is enabled
+    # * false if the named feature is disabled
+    def feature(feature_name)
+      @tms.getFeature(feature_name)
+    end
+    alias :get_feature :feature
+    alias :getFeature :feature
+
+    # Returns a property in the underlying implementation of TopicMapSystem.
+    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.
+    #
+    # The iris may be Strings and/or Locators.
+    # The result may be empty.
+    #
+    # :call-seq:
+    #   [] -> Array of TopicMaps
+    #   [iri1, iri2, ...] -> Array of TopicMaps
+    #
+    def [](*args)
+      if args.empty?
+        return @tms.getLocators.map {|l| topic_map(l)}
+      end
+      return args.map{|l| topic_map(l)}
+    end
+
+    # Applications SHOULD call this method when the topic map system is no longer required
+    def close
+      if defined?(@tms) && @tms
+        @tms.close
+        @tms = nil
+      end
+    end
+
+  end
+end