rtm 0.1.6 → 0.2

data/DISCLAIMER

@@ -1,36 +1,13 @@
-Copyright (c) 2007-2008 Benjamin Bock.
-All rights reserved.
+Copyright 2008-2010 Topic Maps Lab, University of Leipzig.
 
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions
-are met:
-1. Redistributions of source code must retain the above copyright
-   notice, this list of conditions and the following disclaimer.
-2. Redistributions in binary form must reproduce the above copyright
-   notice, this list of conditions and the following disclaimer in the
-   documentation and/or other materials provided with the distribution.
-3. Redistributions in any form must be accompanied by information on
-   how to obtain complete source code for the software and any
-   accompanying software that uses the software. The source code
-   must either be included in the distribution or be available for no
-   more than the cost of distribution plus a nominal fee, and must be
-   freely redistributable under reasonable conditions. For an
-   executable file, complete source code means the source code for all
-   modules it contains.  It does not include source code for modules or
-   files that typically accompany the major components of the operating
-   system on which the executable file runs.
+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 
 
-THIS SOFTWARE IS PROVIDED BY BENJAMIN BOCK ``AS IS'' AND ANY EXPRESS
-OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR
-NON-INFRINGEMENT, ARE DISCLAIMED.  IN NO EVENT SHALL BENJAMIN BOCK
-BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
-THE POSSIBILITY OF SUCH DAMAGE.
+  http://www.apache.org/licenses/LICENSE-2.0 
 
-This license is compatible with The GNU General Public License, Version 1
-This license is compatible with The GNU General Public License, Version 2
+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

@@ -1,4 +1,33 @@
-Copyright (c) 2007-2008 Benjamin Bock.
-All rights reserved.
+=== Ruby Topic Maps (RTM)
+RTM is a Topic Maps engine written in Ruby. See http://rtm.topicmapslab.de/ for instructions.
+Several backends and extensions are available as separate gems.
 
-See http://rtm.rubyforge.org/ for instructions.
+==== Overview
+From a developer's perspective, RTM is a schema-less database management system.
+The Topic Maps standard (described below) on which RTM is based provides a way of creating a self-describing schema just by using it.
+
+==== Topic Maps
+Topic Maps is an international industry standard (ISO13250) for interchangeably representing information
+about the structure of information resources used to define topics, and the relationships between topics.
+A set of one or more interrelated documents that employs the notation defined by this International Standard is called a topic map.
+A topic map defines a multidimensional topic space - a space in which the locations are topics,
+and in which the distances between topics are measurable in terms of the number of intervening topics
+which must be visited in order to get from one topic to another, and the kinds of relationships that define
+the path from one topic to another, if any, through the intervening topics, if any.
+In addition, information objects can have properties, as well as values for those properties, assigned to them.
+The Topic Maps Data Model which is used in this implementation can be found on http://www.isotopicmaps.org/sam/sam-model/.
+
+==== Backends
+[rtm-ontopia] JRuby only, recommended,
+              uses Ontopia: http://code.google.com/p/ontopia/
+[rtm-tinytim] JRuby only,
+              uses TinyTiM: http://tinytim.sourceforge.net/
+[rtm-activerecord] uses a custom ActiveRecord schema
+
+==== Extensions
+[rtm-tmql] Adds support for the Topic Maps Query Language (TMQL), http://isotopicmaps.org/tmql/
+[rtm-tmcl] Adds support for the Topic Maps Constraint Language (TMCL), http://isotopicmaps.org/tmcl/
+
+==== 
+[Copyright] Copyright 2009 Topic Maps Lab, University of Leipzig.
+[License]   Apache License, Version 2.0

data/lib/rtm.rb

@@ -1,82 +1,134 @@
-# RTM: Ruby Topic Maps.
-# Copyright (c) 2007-2008 Benjamin Bock.
-# All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions
-# are met:
-# 1. Redistributions of source code must retain the above copyright
-#    notice, this list of conditions and the following disclaimer.
-# 2. Redistributions in binary form must reproduce the above copyright
-#    notice, this list of conditions and the following disclaimer in the
-#    documentation and/or other materials provided with the distribution.
-# 3. Redistributions in any form must be accompanied by information on
-#    how to obtain complete source code for the software and any
-#    accompanying software that uses the software. The source code
-#    must either be included in the distribution or be available for no
-#    more than the cost of distribution plus a nominal fee, and must be
-#    freely redistributable under reasonable conditions. For an
-#    executable file, complete source code means the source code for all
-#    modules it contains.  It does not include source code for modules or
-#    files that typically accompany the major components of the operating
-#    system on which the executable file runs.
-#
-# THIS SOFTWARE IS PROVIDED BY BENJAMIN BOCK ``AS IS'' AND ANY EXPRESS
-# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR
-# NON-INFRINGEMENT, ARE DISCLAIMED.  IN NO EVENT SHALL BENJAMIN BOCK
-# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
-# THE POSSIBILITY OF SUCH DAMAGE.
+# Ruby Topic Maps (RTM)
+# Copyright:     Topic Maps Lab  http://www.topicmapslab.de
+# License:       Apache License, Version 2.0
+# Project lead:  Benjamin Bock   bock(at)informatik.uni-leipzig.de
+# Developers:    Benjamin Bock   bock(at)informatik.uni-leipzig.de
+#                Arnim Bleier    bleier(at)informatik.uni-leipzig.de
+#                Uta Schulze     uta.schulze(at)informatik.uni-leipzig.de
+#                Daniel Exner    exner(at)informatik.uni-leipzig.de
+# Testing:       Uta Schulze     uta.schulze(at)informatik.uni-leipzig.de
+# Documentation: Uta Schulze     uta.schulze(at)informatik.uni-leipzig.de
+
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__))
+
 module RTM
+  module Topic
+  end
 
-end
+  module Association
+  end
+
+  module Occurrence
+  end
+
+  module Reifiable
+  end
+
+  module Name
+  end
+
+  module Role
+  end
+
+  module Scoped
+  end
+
+  module Typed
+  end
+
+  module Variant
+  end
+
+  module Locator
+  end
+
+  module Construct
+  end
+
+  module Reifiable
+  end
+
+  module TopicMap
+    attr_accessor :engine
+  end
+
+  module TopicMapSystem
+  end
+
+  module ItemIdentifier
+  end
+
+  module SubjectIdentifier
+  end
 
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__))) 
-
-unless defined? ActiveRecord
-  active_record_path = File.dirname(__FILE__) + "/../../activerecord/lib"
-  if File.exist?(active_record_path)
-    $:.unshift active_record_path
-    old_verbose=$VERBOSE
-    $VERBOSE=false
-    require 'active_record'
-    $VERBOSE=old_verbose
-  else
-    require 'rubygems'
-    gem 'activerecord'
-    old_verbose=$VERBOSE
-    $VERBOSE=false
-    require 'active_record'
-    $VERBOSE=old_verbose
+  module SubjectLocator
+  end
+
+  module DatatypeAware
   end
 end
 
-require 'rtm/core_ext'
-require 'rtm/helpers'
-require 'rtm/locator_helpers'
-require 'rtm/base'
-require 'rtm/psi'
+require 'rtm/version'
 require 'rtm/extensions'
-require 'rtm/validation'
-#require 'rtm/io/to_jtm'
-require 'rtm/io/to_string'
-require 'rtm/io/to_xtm2'
-require 'rtm/io/to_yaml'
-require 'rtm/io/from_xtm2'
-begin
-  #require 'rtm/io/from_xtm2_libxml.rb'
-rescue Exception
-  warn("LibXML could not be loaded, only (slow) REXML import available")
+require "rtm/engine"
+require 'rtm/psi'
+require "rtm/navigation"
+require "rtm/axes"
+require "rtm/sugar"
+require "rtm/io"
+
+module RTM
+  # Connects to a topic map engine.
+  # The optional parameter can be used to
+  # select the backend.
+  #
+  # :call-seq:
+  #   RTM.connect(:implementation => :ontopia)            -> Ontopia backend
+  #   RTM.connect(:implementation => :tinytim)            -> tinyTim backend
+  #   RTM.connect(:implementation => :activerecord)       -> Active Record backend
+  #   RTM.connect(:implementation => :sesametm)           -> SesameTM backend
+  #   RTM.connect(:implementation => :merged)             -> Merged TMAPI backend
+  #
+  def self.connect(params = {}, *args)
+    engine = Engine.load!(params[:implementation])
+    connection = engine.new(params)
+    add_connection(connection)
+    connection
+  end
+
+  # Returns all connections grouped by their backend
+  #
+  # :call-seq:
+  #   connections -> Hash
+  #
+  def self.connections
+    @connections ||= Hash.new{|h,k| h[k] = []}
+    @connections
+  end
+
+  # Returns all connections. The optional argument may specify the backend
+  # the connections should use.
+  #
+  # :call-seq:
+  #   [] -> all connections as Hash
+  #   [:tinytim] -> all connections using TinyTiM
+  #   [:ontopia] -> all connections using Ontopia
+  #   [:sesame] -> all connections using SesameTM
+  #   [:activerecord] -> all connectioms using RTM AR
+  #
+  def self.[](args = nil)
+      return @connections[args] if args
+      connections
+  end
+
+  def self.included(klass)
+    @@meine_implementierungen ||= []
+    @@meine_implementierungen << klass
+    self.included_modules.each {|im| klass.extend(im)}
+  end
+
+  private
+  def self.add_connection(connection)
+    self.connections[connection.class.identifier] << connection
+  end
 end
-#require 'rtm/io/from_xtm2_hpricot'
-require 'rtm/merging/merging'
-require 'rtm/pimp_my_api'
-require 'rtm/backend/active_record'
-require 'rtm/connect'
-require 'rtm/backward_compatibility'