ontopia-topicmaps 0.0.1-java

data/README

@@ -0,0 +1,46 @@
+= ontopia-topicmaps - Query topic maps with Ontopia
+
+== VERSION
+
+This documentation refers to ontopia-topicmaps version 0.0.1
+
+
+== DESCRIPTION
+
+Query topic maps with Ontopia[http://ontopia.net/]. A working
+installation[http://ontopia.net/doc/current/install.html] of Ontopia needs to
+be present (point to it through the +OTM_BASE+ environment variable in case it
+cannot be found automatically). Note, though, that's it not required to run the
+application server, only the JAR files are needed.
+
+
+== LINKS
+
+<b></b>
+Documentation:: http://blackwinter.github.com/ontopia-topicmaps
+Source code::   http://github.com/blackwinter/ontopia-topicmaps
+RubyGem::       http://rubygems.org/gems/ontopia-topicmaps
+Ontopia::       http://ontopia.net/
+
+
+== AUTHORS
+
+* Jens Wille <mailto:jens.wille@gmail.com>
+
+
+== LICENSE AND COPYRIGHT
+
+Copyright (C) 2013 Jens Wille
+
+ontopia-topicmaps is free software: you can redistribute it and/or modify it
+under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or (at your
+option) any later version.
+
+ontopia-topicmaps is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public
+License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with ontopia-topicmaps. If not, see <http://www.gnu.org/licenses/>.

data/Rakefile

@@ -0,0 +1,21 @@
+require File.expand_path(%q{../lib/ontopia/topicmaps/version}, __FILE__)
+
+begin
+  require 'hen'
+
+  Hen.lay! {{
+    :gem => {
+      :name         => %q{ontopia-topicmaps},
+      :version      => Ontopia::Topicmaps::VERSION,
+      :summary      => %q{Query topic maps with Ontopia.},
+      :author       => %q{Jens Wille},
+      :email        => %q{jens.wille@gmail.com},
+      :license      => %q{AGPL},
+      :homepage     => :blackwinter,
+      :platform     => 'java',
+      :dependencies => %w[]
+    }
+  }}
+rescue LoadError => err
+  warn "Please install the `hen' gem. (#{err})"
+end

data/lib/ontopia/topicmaps/packages.rb

@@ -0,0 +1,49 @@
+#--
+###############################################################################
+#                                                                             #
+# ontopia-topicmaps -- Query topic maps with Ontopia.                         #
+#                                                                             #
+# Copyright (C) 2013 Jens Wille                                               #
+#                                                                             #
+# ontopia-topicmaps is free software: you can redistribute it and/or modify   #
+# it under the terms of the GNU Affero General Public License as published    #
+# by the Free Software Foundation, either version 3 of the License, or (at    #
+# your option) any later version.                                             #
+#                                                                             #
+# ontopia-topicmaps is distributed in the hope that it will be useful, but    #
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY  #
+# or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public      #
+# License for more details.                                                   #
+#                                                                             #
+# You should have received a copy of the GNU Affero General Public License    #
+# along with ontopia-topicmaps. If not, see <http://www.gnu.org/licenses/>.   #
+#                                                                             #
+###############################################################################
+#++
+
+module Ontopia
+  module Topicmaps
+
+    module Packages
+
+      PACKAGES = {
+        'net.ontopia.infoset.impl.basic'    => %w[URIFragmentLocator],
+        'net.ontopia.topicmaps.query.utils' => %w[QueryWrapper RowMapperIF],
+        'net.ontopia.topicmaps.utils'       => %w[TopicStringifiers],
+        'net.ontopia.topicmaps.utils.ctm'   => %w[CTMTopicMapReader],
+        'net.ontopia.topicmaps.utils.jtm'   => %w[JTMTopicMapReader],
+        'net.ontopia.topicmaps.utils.ltm'   => %w[LTMTopicMapReader],
+        'net.ontopia.topicmaps.utils.rdf'   => %w[RDFTopicMapReader],
+        'net.ontopia.topicmaps.utils.xfml'  => %w[XFMLTopicMapReader],
+        'net.ontopia.topicmaps.xml'         => %w[XTMTopicMapReader],
+        'net.ontopia.utils'                 => %w[OntopiaRuntimeException StringifierIF]
+      }
+
+      def self.included(base)
+        PACKAGES.each_key { |pkg| base.send(:include_package, pkg) }
+      end
+
+    end
+
+  end
+end

data/lib/ontopia/topicmaps/stringifiers.rb

@@ -0,0 +1,42 @@
+#--
+###############################################################################
+#                                                                             #
+# ontopia-topicmaps -- Query topic maps with Ontopia.                         #
+#                                                                             #
+# Copyright (C) 2013 Jens Wille                                               #
+#                                                                             #
+# ontopia-topicmaps is free software: you can redistribute it and/or modify   #
+# it under the terms of the GNU Affero General Public License as published    #
+# by the Free Software Foundation, either version 3 of the License, or (at    #
+# your option) any later version.                                             #
+#                                                                             #
+# ontopia-topicmaps is distributed in the hope that it will be useful, but    #
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY  #
+# or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public      #
+# License for more details.                                                   #
+#                                                                             #
+# You should have received a copy of the GNU Affero General Public License    #
+# along with ontopia-topicmaps. If not, see <http://www.gnu.org/licenses/>.   #
+#                                                                             #
+###############################################################################
+#++
+
+module Ontopia
+  module Topicmaps
+
+    class IdStringifier
+
+      NO_VALUE = '[No ID]'.freeze
+
+      Topicmaps.init(self, :StringifierIF) {
+        URIFragmentLocator.field_accessor :fragment
+      }
+
+      def to_string(object)
+        (id = object.get_item_identifiers.first) ? id.fragment : NO_VALUE
+      end
+
+    end
+
+  end
+end

data/lib/ontopia/topicmaps/topicmap.rb

@@ -0,0 +1,127 @@
+#--
+###############################################################################
+#                                                                             #
+# ontopia-topicmaps -- Query topic maps with Ontopia.                         #
+#                                                                             #
+# Copyright (C) 2013 Jens Wille                                               #
+#                                                                             #
+# ontopia-topicmaps is free software: you can redistribute it and/or modify   #
+# it under the terms of the GNU Affero General Public License as published    #
+# by the Free Software Foundation, either version 3 of the License, or (at    #
+# your option) any later version.                                             #
+#                                                                             #
+# ontopia-topicmaps is distributed in the hope that it will be useful, but    #
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY  #
+# or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public      #
+# License for more details.                                                   #
+#                                                                             #
+# You should have received a copy of the GNU Affero General Public License    #
+# along with ontopia-topicmaps. If not, see <http://www.gnu.org/licenses/>.   #
+#                                                                             #
+###############################################################################
+#++
+
+module Ontopia
+  module Topicmaps
+
+    class Topicmap
+
+      Topicmaps.init(self)
+
+      TOPICMAP_READER = {
+        '.ctm'  => :CTMTopicMapReader,
+        '.jtm'  => :JTMTopicMapReader,
+        '.ltm'  => :LTMTopicMapReader,
+        '.rdf'  => :RDFTopicMapReader,
+        '.xfml' => :XFMLTopicMapReader,
+        '.xtm'  => :XTMTopicMapReader
+      }
+
+      QUERY = {
+        :all_topics => <<-EOT,
+select $TOPIC from
+  topic($TOPIC),
+  item-identifier($TOPIC, $_)?
+        EOT
+        :count_all_topics => <<-EOT
+select count($TOPIC) from
+  topic($TOPIC),
+  item-identifier($TOPIC, $_)?
+        EOT
+      }
+
+      def initialize(file)
+        Topicmaps.setup_classpath
+
+        @file = file.include?(File::SEPARATOR) ? file :
+          File.join(Topicmaps.base, 'topicmaps', file)
+
+        @tm = read(@file)
+      end
+
+      attr_reader :tm, :file
+
+      def count(query = nil, declarations = nil)
+        query ||= :count_all_topics
+        query_for_list(query, declarations) { |i,| i }.first || 0
+      end
+
+      def query(query = nil, declarations = nil, str = nil)
+        str = Topicmaps.stringifier(str || :default)
+        res = query_for_list(query, declarations, &block_given? ?
+          lambda { |i,| yield(i, str) } : lambda { |i,| str.to_string(i) }).to_a
+      end
+
+      def topics(value_str = nil, key_str = nil)
+        hash, key_str = {}, Topicmaps.stringifier(key_str || :id)
+
+        query(:all_topics, nil, value_str) { |i, str|
+          hash[key_str.to_string(i)] = str.to_string(i)
+        }
+
+        hash
+      end
+
+      private
+
+      def read(file, reader = nil)
+        reader ||= TOPICMAP_READER[ext = File.extname(file)]
+        raise "Unsupported file format: #{ext}" unless reader
+
+        self.class.const_get(reader).new(Java::JavaIo::File.new(file)).read
+      rescue Java::JavaIo::IOException => err
+        raise "Error reading topic map: #{err}"
+      end
+
+      def query_for_list(query, declarations, &block)
+        args = [QUERY.has_key?(query ||= :all_topics) ? QUERY[query] :
+          query.is_a?(Symbol) ? raise("No such query: #{query}") : query]
+
+        args << RowMapper.new(&block) if block
+
+        qw = QueryWrapper.new(tm)
+        qw.set_declarations(declarations) if declarations
+
+        qw.query_for_list(*args)
+      rescue OntopiaRuntimeException => err
+        raise "Query error: #{err}"
+      end
+
+      class RowMapper
+
+        Topicmaps.init(self, :RowMapperIF)
+
+        def initialize(&block)
+          @block = block
+        end
+
+        def map_row(result, rowno)
+          @block[result.get_value(0), rowno]
+        end
+
+      end
+
+    end
+
+  end
+end

data/lib/ontopia/topicmaps/version.rb

@@ -0,0 +1,52 @@
+#--
+###############################################################################
+#                                                                             #
+# ontopia-topicmaps -- Query topic maps with Ontopia.                         #
+#                                                                             #
+# Copyright (C) 2013 Jens Wille                                               #
+#                                                                             #
+# ontopia-topicmaps is free software: you can redistribute it and/or modify   #
+# it under the terms of the GNU Affero General Public License as published    #
+# by the Free Software Foundation, either version 3 of the License, or (at    #
+# your option) any later version.                                             #
+#                                                                             #
+# ontopia-topicmaps is distributed in the hope that it will be useful, but    #
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY  #
+# or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public      #
+# License for more details.                                                   #
+#                                                                             #
+# You should have received a copy of the GNU Affero General Public License    #
+# along with ontopia-topicmaps. If not, see <http://www.gnu.org/licenses/>.   #
+#                                                                             #
+###############################################################################
+#++
+
+module Ontopia
+  module Topicmaps
+
+    module Version
+
+      MAJOR = 0
+      MINOR = 0
+      TINY  = 1
+
+      class << self
+
+        # Returns array representation.
+        def to_a
+          [MAJOR, MINOR, TINY]
+        end
+
+        # Short-cut for version string.
+        def to_s
+          to_a.join('.')
+        end
+
+      end
+
+    end
+
+    VERSION = Version.to_s
+
+  end
+end

data/lib/ontopia/topicmaps.rb

@@ -0,0 +1,114 @@
+#--
+###############################################################################
+#                                                                             #
+# ontopia-topicmaps -- Query topic maps with Ontopia.                         #
+#                                                                             #
+# Copyright (C) 2013 Jens Wille                                               #
+#                                                                             #
+# ontopia-topicmaps is free software: you can redistribute it and/or modify   #
+# it under the terms of the GNU Affero General Public License as published    #
+# by the Free Software Foundation, either version 3 of the License, or (at    #
+# your option) any later version.                                             #
+#                                                                             #
+# ontopia-topicmaps is distributed in the hope that it will be useful, but    #
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY  #
+# or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public      #
+# License for more details.                                                   #
+#                                                                             #
+# You should have received a copy of the GNU Affero General Public License    #
+# along with ontopia-topicmaps. If not, see <http://www.gnu.org/licenses/>.   #
+#                                                                             #
+###############################################################################
+#++
+
+require 'java'
+
+require_relative 'topicmaps/version'
+require_relative 'topicmaps/packages'
+
+module Ontopia
+  module Topicmaps
+
+    DEFAULT_JARS = ENV['OTM_JARS'] || 'log4j-*:slf4j-log4j*:ontopia-engine-*'
+    DEFAULT_BASE = ENV['OTM_BASE'] || '/usr/local/ontopia'
+
+    @init = {}
+
+    @base = nil
+
+    @default_stringifier = nil
+
+    class << self
+
+      attr_reader :base
+
+      def default_stringifier=(str)
+        @default_stringifier = stringifier(str)
+      end
+
+      def default_stringifier
+        @default_stringifier ||= name_stringifier
+      end
+
+      def name_stringifier
+        self::TopicStringifiers.get_default_stringifier
+      end
+
+      def id_stringifier
+        IdStringifier.new
+      end
+
+      def stringifier(str)
+        str.is_a?(Symbol) ? send("#{str}_stringifier") : str
+      end
+
+      def count(file, *args)
+        Topicmap.new(file).count(*args)
+      end
+
+      def query(file, *args, &block)
+        Topicmap.new(file).query(*args, &block)
+      end
+
+      def topics(file, *args)
+        Topicmap.new(file).topics(*args)
+      end
+
+      def base=(base)
+        setup_classpath(base)
+      end
+
+      def setup_classpath(base = nil, jars = nil)
+        if @base
+          return unless base
+          raise "#{self}: $CLASSPATH already set up: #{@base}"
+        end
+
+        @base = base ||= DEFAULT_BASE
+
+        Array(jars || DEFAULT_JARS).join(':').split(':').each { |jar|
+          (path = Dir[File.join(base, 'lib', "#{jar}.jar")].sort.last) ?
+            $CLASSPATH << path : raise("JAR not found: #{jar} (#{base})")
+        }
+
+        init.each { |klass, (modules, block)|
+          klass.send :include, Packages, *modules.map { |m| const_get(m) }
+          klass.class_eval(&block) if block
+        }.clear
+      end
+
+      protected
+
+      def init(klass = nil, *modules, &block)
+        klass ? Topicmaps.init[klass] = [modules, block] : @init
+      end
+
+    end
+
+    init(self)
+
+  end
+end
+
+require_relative 'topicmaps/stringifiers'
+require_relative 'topicmaps/topicmap'

data/lib/ontopia-topicmaps.rb

@@ -0,0 +1 @@
+require 'ontopia/topicmaps'