uwn-api 0.0.1

data/COPYING.LESSER

@@ -0,0 +1,165 @@
+       GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions. 
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version. 
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in uwn-api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,14 @@
+Copyright (c) 2013 Dennis Blommesteijn
+All rights reserved.
+
+This code is free software: you can redistribute it and/or modify it under
+the terms of the GNU Lesser General Public License version 3 only, as
+published by the Free Software Foundation.
+
+This code 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 Lesser General Public License
+version 3 for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+version 3 along with this work.  If not, see <http://www.gnu.org/licenses/>.

data/README.md

@@ -0,0 +1,146 @@
+# Uwn::Api
+
+This project is a Ruby on Rails (gem) wrapper for the UWN database (build from Wordnet), using JRuby (Java) and uwnapi.jar (which are included). Ruby MRI users will NOT be successful using this gem!!
+
+ * UWN/MENTA: Towards a Universal Multilingual Wordnet API.
+ * http://www.mpi-inf.mpg.de/yago-naga/uwn/downloads.html
+
+## Installation
+
+Add this line to your application's Gemfile (bundler):
+
+    gem 'uwn-api', git: "git://github.com/dblommesteijn/uwn-api.git"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as (RubyGems):
+
+    $ gem install uwn-api
+
+
+## Roadmap
+
+  * Version (0.0.2)
+
+    Depth query on synset subclasses
+
+    Depth search over multiple nodes
+
+
+## Usage
+
+### Download and install
+
+Before using UWN you'll need to download Wordnet and UWN plugin libraries (http://www.mpi-inf.mpg.de/yago-naga/uwn/downloads.html) which are ~100Mb, and place it in the appropriate directory.
+
+Place the uwn.dat/plg (and/or) wordnet.dat/plg into your plugins directory
+  
+    ~/yourgems/uwn-api/lib/uwn/api/deps/plugins (default directory)
+
+OR Point Uwn::Api::Connect to the plugins path.
+
+```ruby
+uwn = Uwn::Api::Connect.new plugins_path: "/location/of/your/plugins"
+```
+
+### Connecting and word Query
+
+```ruby
+# connect to UWN and point the plugins dir
+uwn = Uwn::Api::Connect.new plugins_path: "/location/of/your/plugins"
+# perform query word gem in English
+meaning = uwn.meaning "gem", "eng"
+# iterate the found statements
+meaning.statements.each do |statement|
+  # print statement
+  puts statement
+end
+```
+
+### More advanced lists
+
+Uwn::Api::Meaning includes shorthand methods that invocate, and flatten nested statement lists. Therefor meaning_instance.synsets are equivalent to meaning_instance.statments.flat_map{|s| s.synsets}.
+
+
+#### Basic iteration example
+```ruby
+# connect to UWN and point the plugins dir
+uwn = Uwn::Api::Connect.new plugins_path: "/location/of/your/plugins"
+# perform query word gem in English
+meaning = uwn.meaning "gem", "eng"
+
+# iterate synsets (part of speech) on all nested statements
+meaning.synsets.each do |synset|
+  # print statement synset
+  puts synset
+end
+```
+
+#### Lexical Categories (word type: verb, noun etc.)
+
+```ruby
+# iterate lexical_categories (word type: verb, noun etc.)
+meaning.lexical_categories.each do |lexical_category|
+  # print statement lexical_category
+  puts lexical_category
+  # you can verify lexical_categories using:
+  lexical_category.is_lexical_category?
+  # word types can be retreived using:
+  lexical_category.lexcat
+end
+```
+
+#### Synonyms (based on synset word)
+
+```ruby
+# iterate synonyms (word synonyms based on synset)
+meaning.synonyms.each do |synonym|
+  # print statement synonym
+  puts synonym
+  # you can verify synonyms using:
+  synonym.is_synonym?
+  # word retreival can be done using:
+  synonym.term_str
+end
+```
+
+#### Lexicalizations (translations)
+
+```ruby
+# iterate lexicalizations (translations)
+meaning.lexicalizations.each do |lexicalization|
+  # print statement lexicalization
+  puts lexicalization
+  # word language
+  lexicalization.language
+  # word itself
+  lexicalization.term_str
+end
+```
+
+#### Subclasses (synset related classes)
+
+```ruby
+# iterate related classes
+meaning.subclasses.each do |subclass|
+  # the related subclass (synset id)
+  subclass.to_s
+  #TODO: do an in depth query on this synset is not yet supported!
+end
+```
+
+#### Glossary (text explanation of word)
+
+```ruby
+meaning.glosses.each do |gloss|
+  # print statement glossary
+  puts gloss
+end
+```
+
+
+
+
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/uwn/api.rb

@@ -0,0 +1,13 @@
+require File.expand_path(File.dirname(__FILE__) + "/api/version")
+require File.expand_path(File.dirname(__FILE__) + "/api/connect")
+require File.expand_path(File.dirname(__FILE__) + "/api/statement")
+require File.expand_path(File.dirname(__FILE__) + "/api/meaning")
+require File.expand_path(File.dirname(__FILE__) + "/api/util")
+
+
+
+module Uwn
+  module Api
+    # Your code goes here...
+  end
+end

data/lib/uwn/api/connect.rb

@@ -0,0 +1,61 @@
+require 'java'
+require File.expand_path(File.dirname(__FILE__) + "/../deps/uwnapi.jar")
+
+
+module Uwn
+  module Api
+      
+    class Connect
+
+      DEFAULT_PATH = File.dirname(__FILE__) + "/../deps/plugins"
+
+      import 'org.lexvo.uwn.UWN'
+      import 'org.lexvo.uwn.Entity'
+      import 'org.lexvo.uwn.Statement'
+
+
+      def initialize options={}
+        begin
+          # setup plugin directory
+          unless options.include? :plugins_path
+            plugins_path = DEFAULT_PATH
+          else
+            plugins_path = options[:plugins_path]
+          end
+          f = java.io.File.new(plugins_path.to_s)
+          # load uwn
+          @uwn = UWN.new(f)
+        rescue Exception => e
+          # hide java verbose output
+          raise e.message
+        end
+      end
+
+      # lookup meaning of term by name and language
+      def meaning term, language
+        meaning = Meaning.new connect: self, term: term, language: language
+        # get meaning entities
+        mes = @uwn.get_meaning_entities term, language
+        # iterate entities
+        while mes.has_next do
+          # append statment to meaning object
+          meaning.append_statement mes.next
+        end
+        meaning
+      end
+
+      # get statements by direct uwn query
+      def statements object_string
+        ret = []
+        mes = @uwn.get(Entity.new(object_string))
+        while mes.has_next do
+          ret << mes.next
+        end
+        ret 
+      end
+
+      
+    end
+
+  end
+end

data/lib/uwn/api/meaning.rb

@@ -0,0 +1,58 @@
+
+module Uwn
+  module Api
+    
+    # Class for Abstract UWN Statement wrapper (with some high level functions)
+    class Meaning
+
+      attr_accessor :connect, :parent, :term, :language, :statements
+
+      def initialize options={}
+        self.connect = options[:connect] if options.include? :connect
+        self.term = options[:term] if options.include? :term
+        self.language = options[:language] if options.include? :language
+        self.statements = []
+      end
+
+      # contains a statement set?
+      def has_meaning?
+        !self.statements.empty?
+      end
+
+      # append a statement, and wrap with a Statement object
+      def append_statement statement
+        self.statements << Statement.new(parent: self, object: statement)
+      end
+
+      # short handeded (high level) methods
+
+      def synsets
+        self.statements.flat_map{ |s| s.synsets }
+      end
+
+      def synonyms
+        self.statements.flat_map{ |s| s.synonyms }
+      end
+
+      def lexicalizations
+        self.statements.flat_map{ |s| s.lexicalizations }
+      end
+
+      def glosses
+        self.statements.flat_map{ |s| s.glosses }
+      end
+
+      def subclasses
+        self.statements.flat_map{ |s| s.subclasses }
+      end
+
+      def lexical_categories
+        self.statements.flat_map{ |s| s.lexical_categories }
+      end
+
+
+
+    end
+
+  end
+end