Permalink
Browse files

Add Java package for APE

  • Loading branch information...
1 parent c03ce57 commit 8f3805627b35db415fc0919cbbadad0b0042778c @tkuhn tkuhn committed Nov 21, 2011
Showing with 3,649 additions and 16 deletions.
  1. +1 −0 .gitignore
  2. +14 −0 java/.classpath
  3. +3 −0 java/.gitignore
  4. +17 −0 java/.project
  5. +2 −0 java/LICENSE.txt
  6. +72 −0 java/README.txt
  7. +91 −0 java/build.xml
  8. +38 −0 java/lib/README.txt
  9. BIN java/lib/commons-lang-2.2.jar
  10. BIN java/lib/commons-logging-1.1.jar
  11. BIN java/lib/httpclient-4.1.1.jar
  12. BIN java/lib/httpcore-4.1.1.jar
  13. BIN java/lib/jdom.jar
  14. BIN java/lib/jpl.jar
  15. BIN java/lib/junit-4.5.jar
  16. +6 −0 java/licenses/README.txt
  17. +201 −0 java/licenses/apache-2.0.txt
  18. +845 −0 java/licenses/gpl-3.txt
  19. +56 −0 java/licenses/jdom.txt
  20. +177 −0 java/src/ch/uzh/ifi/attempto/ape/ACEParser.java
  21. +45 −0 java/src/ch/uzh/ifi/attempto/ape/ACEParserException.java
  22. +72 −0 java/src/ch/uzh/ifi/attempto/ape/ACEParserResult.java
  23. +49 −0 java/src/ch/uzh/ifi/attempto/ape/ACEUtils.java
  24. +219 −0 java/src/ch/uzh/ifi/attempto/ape/APELocal.java
  25. +133 −0 java/src/ch/uzh/ifi/attempto/ape/APESocket.java
  26. +193 −0 java/src/ch/uzh/ifi/attempto/ape/APEWebservice.java
  27. +64 −0 java/src/ch/uzh/ifi/attempto/ape/FunctionWords.java
  28. +63 −0 java/src/ch/uzh/ifi/attempto/ape/Gender.java
  29. +115 −0 java/src/ch/uzh/ifi/attempto/ape/Lexicon.java
  30. +383 −0 java/src/ch/uzh/ifi/attempto/ape/LexiconEntry.java
  31. +129 −0 java/src/ch/uzh/ifi/attempto/ape/Message.java
  32. +127 −0 java/src/ch/uzh/ifi/attempto/ape/MessageContainer.java
  33. +134 −0 java/src/ch/uzh/ifi/attempto/ape/OutputType.java
  34. +39 −0 java/src/ch/uzh/ifi/attempto/ape/PrologUtils.java
  35. +137 −0 java/src/ch/uzh/ifi/attempto/ape/SyntaxBoxes.java
  36. +22 −0 java/src/ch/uzh/ifi/attempto/ape/package-info.java
  37. +15 −0 java/src/overview.html
  38. +35 −0 java/test/ch/uzh/ifi/attempto/ape/APESocketTest.java
  39. +136 −0 java/test/ch/uzh/ifi/attempto/ape/APEWebserviceTest.java
  40. +16 −16 tools/create_zip.sh
View
1 .gitignore
@@ -1,2 +1,3 @@
/ape.exe
/.project
+/ape-*.zip
View
14 java/.classpath
@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<classpath>
+ <classpathentry kind="src" path="src"/>
+ <classpathentry kind="src" path="test"/>
+ <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER"/>
+ <classpathentry kind="con" path="org.eclipse.jdt.junit.JUNIT_CONTAINER/4"/>
+ <classpathentry kind="lib" path="lib/jpl.jar"/>
+ <classpathentry kind="lib" path="lib/jdom.jar"/>
+ <classpathentry kind="lib" path="lib/commons-lang-2.2.jar"/>
+ <classpathentry kind="lib" path="lib/commons-logging-1.1.jar"/>
+ <classpathentry kind="lib" path="lib/httpcore-4.1.1.jar"/>
+ <classpathentry kind="lib" path="lib/httpclient-4.1.1.jar"/>
+ <classpathentry kind="output" path="classes"/>
+</classpath>
View
3 java/.gitignore
@@ -0,0 +1,3 @@
+/classes
+/docs
+/attempto-ape.jar
View
17 java/.project
@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+ <name>java</name>
+ <comment></comment>
+ <projects>
+ </projects>
+ <buildSpec>
+ <buildCommand>
+ <name>org.eclipse.jdt.core.javabuilder</name>
+ <arguments>
+ </arguments>
+ </buildCommand>
+ </buildSpec>
+ <natures>
+ <nature>org.eclipse.jdt.core.javanature</nature>
+ </natures>
+</projectDescription>
View
2 java/LICENSE.txt
@@ -0,0 +1,2 @@
+The Attempto Java Packages are free software licensed under the GNU Lesser General Public Licence
+version 3 or later (see licenses/gpl-3.txt or http://www.gnu.org/licenses/lgpl.html).
View
72 java/README.txt
@@ -0,0 +1,72 @@
+Attempto Java Packages
+======================
+
+Copyright 2008-2011, Attempto Group, University of Zurich (see http://attempto.ifi.uzh.ch).
+
+The Attempto Java Packages can be downloaded from http://attempto.ifi.uzh.ch/site/downloads/.
+
+The Attempto Java Packages are a collection of Java packages that are related to the Attempto
+project. The Attempto Java Packages are free software licensed under the GNU Lesser General Public
+Licence (see licenses/gpl-3.txt and http://www.gnu.org/licenses/lgpl.html).
+
+See lib/README.txt for information about the used third-party libraries.
+
+
+1. Content
+----------
+
+The Attempto Java Packages consists of one jar-file:
+
+- attempto-ape.jar contains interfaces to the Attempto Parsing Engine (APE).
+
+Note that AceWiki and the ACE Editor are no longer part of the Attempto Java Packages, but are now
+hosted on Launchpad:
+
+ https://launchpad.net/acewiki
+
+See docs/index.html for the detailed documentation of the packages and classes.
+
+
+2. Compilation
+--------------
+
+This package is pre-compiled. Thus, compilation is needed only if the source code is changed. The
+compilation can be run manually using Ant. Make sure that a recent version of Apache Ant is
+installed. The following commands are available:
+
+"ant compile" compiles the Java source code.
+
+"ant createjars" creates the jar-files.
+
+"ant createjavadoc" creates the Javadoc documentation pages.
+
+"ant clean" deletes all automatically generated files like the compiled Java classes, the
+jar-files, and the Javadoc files.
+
+"ant buildeverything" builds everything from scratch.
+
+
+3. APELocal
+-----------
+
+The APELocal class is an interface to the ACE parser that is written in SWI Prolog. When this class
+is used directly or indirectly, you have to make sure that a recent version of SWI Prolog is
+installed and that the file "ape.exe" is available. The file "ape.exe" can be complied from the APE
+package that is available on the Attempto download page.
+
+Furthermore, you have to use the following Java VM argument that points to the location where the
+SWI Prolog system file libjpl.jnilib (under Mac OS X), jpl.dll (under Windows), or libjpl.so (under
+Unix) is located:
+
+ -Djava.library.path="/opt/local/lib/swipl-5.6.45/lib/i386-darwin8.10.1"
+
+Note that the exact path is most probably different on your system.
+
+
+5. Mailing List
+---------------
+
+If you encounter problems, you can get help from the Attempto community. Visit the Attempto Mailing
+List site:
+
+ http://attempto.ifi.uzh.ch/site/mailinglist/
View
91 java/build.xml
@@ -0,0 +1,91 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<project name="Attempto Java Packages" default="buildeverything" basedir=".">
+
+ <property name="version" value="110615"/>
+ <property name="libs" value="lib/httpcore-4.1.1.jar;lib/httpclient-4.1.1.jar;lib/commons-lang-2.2.jar;lib/commons-logging-1.1.jar;lib/jdom.jar;lib/jpl.jar"/>
+ <property name="classes" location="classes/"/>
+ <property name="test_src" location="test/"/>
+ <property name="test_report" location="test_report/"/>
+
+ <target name="compile"
+ description="Compile the Java files">
+ <mkdir dir="${classes}"/>
+ <javac
+ target="1.5"
+ includeantruntime="false"
+ srcdir="src/"
+ excludes="**/test/**"
+ classpath="${libs}"
+ destdir="${classes}"
+ />
+ </target>
+
+ <target name="createjars"
+ description="Create JAR files"
+ depends="compile">
+ <jar
+ destfile="attempto-ape.jar"
+ basedir="${classes}"
+ includes="ch/uzh/ifi/attempto/ape/**"
+ />
+ </target>
+
+ <target name="createjavadoc"
+ description="Create the Javadoc files">
+ <javadoc
+ sourcepath="src/"
+ packagenames="*"
+ excludepackagenames="**.test"
+ destdir="docs/"
+ extdirs="lib/"
+ windowtitle="Attempto Java Packages, version ${version}"
+ doctitle="Attempto Java Packages, version ${version}"
+ overview="src/overview.html"
+ linksource="on">
+ <bottom><![CDATA[<em>Copyright 2008-2011, Attempto Group, University of Zurich (see <a href="http://attempto.ifi.uzh.ch" target="_blank">http://attempto.ifi.uzh.ch</a>)</em>]]></bottom>
+ </javadoc>
+ <copy
+ file="README.txt"
+ tofile="docs/README.txt"
+ />
+ </target>
+
+ <target name="clean"
+ description="Clean up">
+ <delete file="attempto-ape.jar"/>
+ <delete dir="${classes}/ch/"/>
+ <delete dir="docs/"/>
+ </target>
+
+ <target name="buildeverything"
+ depends="clean, createjars, createjavadoc"
+ description="Clean up, create JAR files and create Javadoc"
+ />
+
+ <target name="test" depends="compile" description="Unit test">
+ <javac srcdir="${test_src}" destdir="${classes}">
+ <classpath>
+ <fileset dir="lib" >
+ <include name="*.jar" />
+ </fileset>
+ <pathelement location="${classes}"/>
+ </classpath>
+ </javac>
+ <mkdir dir="${test_report}"/>
+ <junit printsummary="yes" haltonfailure="no" fork="on">
+ <classpath>
+ <fileset dir="lib" >
+ <include name="*.jar" />
+ </fileset>
+ <pathelement location="${classes}"/>
+ </classpath>
+ <formatter type="plain"/>
+ <batchtest fork="yes" todir="${test_report}">
+ <fileset dir="${test_src}">
+ <include name="**/*Test.java"/>
+ </fileset>
+ </batchtest>
+ </junit>
+ </target>
+</project>
View
38 java/lib/README.txt
@@ -0,0 +1,38 @@
+Used Third-Party Libraries
+--------------------------
+
+JPL
+ files: jpl.jar
+ url: http://www.swi-prolog.org/packages/jpl/java_api/
+ copyright: 1990-2007 University of Amsterdam
+ licenses: GNU Lesser General Public License (see licenses/gpl-3.txt)
+
+JDOM
+ files: jdom.jar
+ url: http://www.jdom.org/
+ copyright: 2000-2004 Jason Hunter & Brett McLaughlin
+ licenses: Apache-style open source license without acknowledgment clause (see licenses/jdom.txt)
+
+Commons Lang 2.2
+ files: commons-lang-2.2.jar
+ url: http://commons.apache.org/lang/
+ copyright: 2001-2006 The Apache Software Foundation
+ licenses: Apache License, version 2.0 (see licenses/apache-2.0.txt)
+
+Commons Logging 1.1
+ files: commons-logging-1.1.jar
+ url: http://commons.apache.org/logging/
+ copyright: 2003-2007 The Apache Software Foundation
+ licenses: Apache License, version 2.0 (see licenses/apache-2.0.txt)
+
+Apache HttpComponents Core
+ files: httpcore-4.1.1.jar
+ url: http://hc.apache.org/httpcomponents-core-ga/index.html
+ copyright: 2005-2011 The Apache Software Foundation
+ licenses: Apache License, version 2.0 (see licenses/apache-2.0.txt)
+
+Apache HttpComponents Client
+ files: httpclient-4.1.1.jar
+ url: http://hc.apache.org/httpcomponents-client-ga/index.html
+ copyright: 1999-2011 The Apache Software Foundation
+ licenses: Apache License, version 2.0 (see licenses/apache-2.0.txt)
View
BIN java/lib/commons-lang-2.2.jar
Binary file not shown.
View
BIN java/lib/commons-logging-1.1.jar
Binary file not shown.
View
BIN java/lib/httpclient-4.1.1.jar
Binary file not shown.
View
BIN java/lib/httpcore-4.1.1.jar
Binary file not shown.
View
BIN java/lib/jdom.jar
Binary file not shown.
View
BIN java/lib/jpl.jar
Binary file not shown.
View
BIN java/lib/junit-4.5.jar
Binary file not shown.
View
6 java/licenses/README.txt
@@ -0,0 +1,6 @@
+This directory contains the license texts of the different licenses involved.
+
+The complete Attempto Java Packages are licensed under the GNU Lesser General Public Licence
+(see gpl-3.txt). See README.txt (one level up in the directory structure) for more information.
+
+Some of the used third-party libraries use other licenses. See lib/README.txt for details.
View
201 java/licenses/apache-2.0.txt
@@ -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.
View
845 java/licenses/gpl-3.txt
@@ -0,0 +1,845 @@
+ 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.
+
+
+
+
+
+
+ GNU 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.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU 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
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program 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 General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ <program> Copyright (C) <year> <name of author>
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<http://www.gnu.org/licenses/>.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
View
56 java/licenses/jdom.txt
@@ -0,0 +1,56 @@
+/*--
+
+ $Id: LICENSE.txt,v 1.11 2004/02/06 09:32:57 jhunter Exp $
+
+ Copyright (C) 2000-2004 Jason Hunter & Brett McLaughlin.
+ 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 disclaimer that follows
+ these conditions in the documentation and/or other materials
+ provided with the distribution.
+
+ 3. The name "JDOM" must not be used to endorse or promote products
+ derived from this software without prior written permission. For
+ written permission, please contact <request_AT_jdom_DOT_org>.
+
+ 4. Products derived from this software may not be called "JDOM", nor
+ may "JDOM" appear in their name, without prior written permission
+ from the JDOM Project Management <request_AT_jdom_DOT_org>.
+
+ In addition, we request (but do not require) that you include in the
+ end-user documentation provided with the redistribution and/or in the
+ software itself an acknowledgement equivalent to the following:
+ "This product includes software developed by the
+ JDOM Project (http://www.jdom.org/)."
+ Alternatively, the acknowledgment may be graphical using the logos
+ available at http://www.jdom.org/images/logos.
+
+ THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
+ WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ DISCLAIMED. IN NO EVENT SHALL THE JDOM AUTHORS OR THE PROJECT
+ CONTRIBUTORS 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.
+
+ This software consists of voluntary contributions made by many
+ individuals on behalf of the JDOM Project and was originally
+ created by Jason Hunter <jhunter_AT_jdom_DOT_org> and
+ Brett McLaughlin <brett_AT_jdom_DOT_org>. For more information
+ on the JDOM Project, please see <http://www.jdom.org/>.
+
+ */
+
View
177 java/src/ch/uzh/ifi/attempto/ape/ACEParser.java
@@ -0,0 +1,177 @@
+// This file is part of the Attempto Java Packages.
+// Copyright 2008-2009, Attempto Group, University of Zurich (see http://attempto.ifi.uzh.ch).
+//
+// The Attempto Java Packages is free software: you can redistribute it and/or modify it under the
+// terms of the GNU Lesser General Public License as published by the Free Software Foundation,
+// either version 3 of the License, or (at your option) any later version.
+//
+// The Attempto Java Packages 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 for more details.
+//
+// You should have received a copy of the GNU Lesser General Public License along with the Attempto
+// Java Packages. If not, see http://www.gnu.org/licenses/.
+
+package ch.uzh.ifi.attempto.ape;
+
+import java.io.StringReader;
+
+import org.jdom.Element;
+import org.jdom.input.SAXBuilder;
+
+/**
+ * This is an interface to the Attempto Parsing Engine (APE), that translates sentences in
+ * Attempto Controlled English (ACE) into logic.
+ *
+ * @author Kaarel Kaljurand
+ * @author Tobias Kuhn
+ */
+public abstract class ACEParser {
+
+ private boolean guessingEnabled = false;
+ private boolean clexEnabled = true;
+ private String uri;
+
+ /**
+ * Creates a new ACEParser object.
+ */
+ protected ACEParser() {}
+
+ /**
+ * Returns one single output for the given ACE text using the given lexicon. See the enumeration
+ * OutputType for further information about the possible outputs. If parsing succeeds then a string
+ * containing the result of the parser is returned. In the case of failure, an ACEParserException
+ * is thrown containing the error messages.
+ *
+ * @param text The ACE text to be parsed.
+ * @param lexicon The lexicon to be loaded.
+ * @param outputType The kind of output that should be returned.
+ * @return The result as a string.
+ * @throws ACEParserException Contains the error messages if an error occurred.
+ * @see #getMultiOutput(String, Lexicon, OutputType...)
+ */
+ public abstract String getSoloOutput(String text, Lexicon lexicon, OutputType outputType) throws ACEParserException;
+
+ /**
+ * Returns one single output for the given ACE text using no lexicon.
+ *
+ * @param text The ACE text to be parsed.
+ * @param outputType The kind of output that should be returned.
+ * @return The result as a string.
+ * @throws ACEParserException Contains the error messages if an error occurred.
+ * @see #getSoloOutput(String, Lexicon, OutputType)
+ */
+ public final String getSoloOutput(String text, OutputType outputType) throws ACEParserException {
+ return getSoloOutput(text, null, outputType);
+ }
+
+ /**
+ * Returns multiple outputs for the given ACE text using the given lexicon. See the enumeration
+ * OutputType for further information about the possible outputs. The result is returned as an
+ * ACEParserResult object.
+ *
+ * @param text The ACE text to be parsed.
+ * @param lexicon The lexicon to be loaded.
+ * @param outputTypes The kind of outputs that should be returned.
+ * @return A ParserResult object containing the outputs.
+ * @see #getSoloOutput(String, Lexicon, OutputType)
+ */
+ public abstract ACEParserResult getMultiOutput(String text, Lexicon lexicon, OutputType... outputTypes);
+
+ /**
+ * Returns multiple outputs for the given ACE text using no lexicon.
+ *
+ * @param text The ACE text to be parsed.
+ * @param outputTypes The kind of outputs that should be returned.
+ * @return A ParserResult object containing the outputs.
+ * @see #getMultiOutput(String, Lexicon, OutputType...)
+ */
+ public final ACEParserResult getMultiOutput(String text, OutputType... outputTypes) {
+ return getMultiOutput(text, null, outputTypes);
+ }
+
+ /**
+ * Determines whether unknown words should be guessed. If false, unknown words lead to an error
+ * message. Note that unknown word guessing is not always perfect. The default value is false.
+ *
+ * @param guessingEnabled true if unknown words should be guessed. false otherwise.
+ */
+ public void setGuessingEnabled(boolean guessingEnabled) {
+ this.guessingEnabled = guessingEnabled;
+ }
+
+ /**
+ * Returns whether unknown words should be guessed.
+ *
+ * @return true if guessing is enabled.
+ */
+ public boolean isGuessingEnabled() {
+ return guessingEnabled;
+ }
+
+ /**
+ * Sets the namespace URI to be used for outputs like OWL.
+ *
+ * @param uri The namespace URI.
+ */
+ public void setURI(String uri) {
+ // TODO: BUG: should we use a URI instead of String?
+ this.uri = uri;
+ }
+
+ /**
+ * Returns the namespace URI to be used for outputs like OWL.
+ *
+ * @return The namespace URI.
+ */
+ public String getURI() {
+ return uri;
+ }
+
+ /**
+ * Determines whether the built-in lexicon should be used. The default value is true.
+ *
+ * @param clexEnabled true if the built-in lexicon should be used. false otherwise.
+ */
+ public void setClexEnabled(boolean clexEnabled) {
+ this.clexEnabled = clexEnabled;
+ }
+
+ /**
+ * Returns whether the built-in lexicon is used.
+ *
+ * @return true if the built-in lexicon is used.
+ */
+ public boolean isClexEnabled() {
+ return clexEnabled;
+ }
+
+ String getOptions() {
+ String guessString = "";
+ if (isGuessingEnabled()) guessString = ",guess=on";
+ String clexString = ",noclex=on";
+ if (isClexEnabled()) clexString = ",noclex=off";
+ String uriString = "";
+ if (getURI() != null) {
+ uriString = ",uri=" + PrologUtils.escape(getURI());
+ }
+ return guessString + clexString + uriString;
+ }
+
+ static String checkForErrors(String s) throws ACEParserException {
+ Element xmlElement = null;
+ try {
+ SAXBuilder sb = new SAXBuilder();
+ sb.setValidation(false);
+ xmlElement = sb.build(new StringReader(s)).getRootElement();
+ } catch (Exception ex) {
+ // String s does not represent an XML document
+ return s;
+ }
+
+ if (xmlElement != null && xmlElement.getName().equals("messages")) {
+ throw new ACEParserException(xmlElement);
+ }
+ return s;
+ }
+}
View
45 java/src/ch/uzh/ifi/attempto/ape/ACEParserException.java
@@ -0,0 +1,45 @@
+// This file is part of the Attempto Java Packages.
+// Copyright 2008-2009, Attempto Group, University of Zurich (see http://attempto.ifi.uzh.ch).
+//
+// The Attempto Java Packages is free software: you can redistribute it and/or modify it under the
+// terms of the GNU Lesser General Public License as published by the Free Software Foundation,
+// either version 3 of the License, or (at your option) any later version.
+//
+// The Attempto Java Packages 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 for more details.
+//
+// You should have received a copy of the GNU Lesser General Public License along with the Attempto
+// Java Packages. If not, see http://www.gnu.org/licenses/.
+
+package ch.uzh.ifi.attempto.ape;
+
+import org.jdom.Element;
+
+/**
+ * This exception is used by the ACE parser when used in solo mode. It contains the error
+ * messages of the parser.
+ *
+ * @author Tobias Kuhn
+ */
+public class ACEParserException extends Exception {
+
+ private static final long serialVersionUID = 5759137566239371054L;
+
+ private MessageContainer messageContainer;
+
+
+ ACEParserException(Element xmlElement) {
+ messageContainer = new MessageContainer(xmlElement);
+ }
+
+ /**
+ * Returns the message container with the error messages.
+ *
+ * @return The message container.
+ */
+ public MessageContainer getMessageContainer() {
+ return messageContainer;
+ }
+
+}
View
72 java/src/ch/uzh/ifi/attempto/ape/ACEParserResult.java
@@ -0,0 +1,72 @@
+// This file is part of the Attempto Java Packages.
+// Copyright 2008-2009, Attempto Group, University of Zurich (see http://attempto.ifi.uzh.ch).
+//
+// The Attempto Java Packages is free software: you can redistribute it and/or modify it under the
+// terms of the GNU Lesser General Public License as published by the Free Software Foundation,
+// either version 3 of the License, or (at your option) any later version.
+//
+// The Attempto Java Packages 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 for more details.
+//
+// You should have received a copy of the GNU Lesser General Public License along with the Attempto
+// Java Packages. If not, see http://www.gnu.org/licenses/.
+
+package ch.uzh.ifi.attempto.ape;
+
+import java.io.StringReader;
+
+import org.jdom.Document;
+import org.jdom.Element;
+import org.jdom.input.SAXBuilder;
+
+/**
+ * This class represents the output that is returned by the ACEParser class.
+ *
+ * @author Tobias Kuhn
+ */
+public class ACEParserResult {
+
+ private Element result;
+ private MessageContainer messageContainer = new MessageContainer();
+
+
+ ACEParserResult(String xmlString) {
+ try {
+ SAXBuilder sb = new SAXBuilder();
+ sb.setValidation(false);
+ Document xml = sb.build(new StringReader(xmlString));
+ result = xml.getRootElement();
+ messageContainer = new MessageContainer(result.getChild("messages"));
+ } catch (Exception ex) {
+ ex.printStackTrace();
+ }
+ }
+
+ /**
+ * Returns the specified output as a string. If the requested output is not available (because
+ * it has not been requested) then null is returned.
+ *
+ * @param outputType The output to be returned.
+ * @return The output as a string.
+ */
+ public String get(OutputType outputType) {
+ try {
+ Element element = result.getChild(outputType.toString().toLowerCase());
+ return element.getText();
+ } catch (Exception ex) {
+ return null;
+ }
+ }
+
+ /**
+ * Returns the message container that contains the error and warning messages of the parsing
+ * procedure.
+ *
+ * @return The message container.
+ */
+ public MessageContainer getMessageContainer() {
+ return messageContainer;
+ }
+
+}
View
49 java/src/ch/uzh/ifi/attempto/ape/ACEUtils.java
@@ -0,0 +1,49 @@
+// This file is part of the Attempto Java Packages.
+// Copyright 2008-2009, Attempto Group, University of Zurich (see http://attempto.ifi.uzh.ch).
+//
+// The Attempto Java Packages is free software: you can redistribute it and/or modify it under the
+// terms of the GNU Lesser General Public License as published by the Free Software Foundation,
+// either version 3 of the License, or (at your option) any later version.
+//
+// The Attempto Java Packages 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 for more details.
+//
+// You should have received a copy of the GNU Lesser General Public License along with the Attempto
+// Java Packages. If not, see http://www.gnu.org/licenses/.
+
+package ch.uzh.ifi.attempto.ape;
+
+/**
+ * This class contains ACE-related utility methods.
+ *
+ * @author Tobias Kuhn
+ */
+public class ACEUtils {
+
+ private ACEUtils() {} // no instances allowed
+
+ /**
+ * This method can be used to determine whether an indefinite article has the form "a" or
+ * "an" if it is followed by the given word. Heuristics are used and the result might not
+ * be correct in 100% of the cases.
+ *
+ * @param word The word that immediately follows the indefinite article.
+ * @return true if "an" should be used; false for "a".
+ */
+ public static boolean useIndefiniteArticleAn(String word) {
+ if (word == null || word.equals("")) return false;
+ boolean an = false;
+ word = word.toLowerCase();
+ if (word.matches("[aeiou].*")) an = true;
+ if (word.matches("[fhlmnrsx]")) an = true;
+ if (word.matches("[fhlmnrsx]-.*")) an = true;
+ if (word.equals("u")) an = false;
+ if (word.matches("u-.*")) an = false;
+ if (word.matches("u[rtn]i.*")) an = false;
+ if (word.matches("use.*")) an = false;
+ if (word.matches("uk.*")) an = false;
+ return an;
+ }
+
+}
View
219 java/src/ch/uzh/ifi/attempto/ape/APELocal.java
@@ -0,0 +1,219 @@
+//This file is part of the Attempto Java Packages.
+//Copyright 2008-2009, Attempto Group, University of Zurich (see http://attempto.ifi.uzh.ch).
+
+//The Attempto Java Packages is free software: you can redistribute it and/or modify it under the
+//terms of the GNU Lesser General Public License as published by the Free Software Foundation,
+//either version 3 of the License, or (at your option) any later version.
+
+//The Attempto Java Packages 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 for more details.
+
+//You should have received a copy of the GNU Lesser General Public License along with the Attempto
+//Java Packages. If not, see http://www.gnu.org/licenses/.
+
+package ch.uzh.ifi.attempto.ape;
+
+import jpl.Atom;
+import jpl.Compound;
+import jpl.JPL;
+import jpl.Query;
+import jpl.Term;
+import jpl.Util;
+import jpl.Variable;
+
+/**
+ * This class provides an interface to the SWI Prolog executable of the Attempto Parsing Engine
+ * (APE). Note that you need the file "ape.exe" (which can be compiled from the Attempto APE
+ * distribution) and that SWI Prolog needs to be installed.
+ * Furthermore, you have to make sure that the JPL libraries of SWI Prolog are in the java library
+ * path. This can be achieved by a Java VM argument which looks like this (for Mac OS X):
+ *
+ * <blockquote><code>
+ * -Djava.library.path=/opt/local/lib/swipl-5.6.45/lib/i386-darwin8.10.1
+ * </code></blockquote>
+ *
+ * Under Linux, the following environment variable has to be set additionally:
+ *
+ * <blockquote><code>
+ * LD_PRELOAD=/usr/lib/pl-5.6.45/lib/i386-linux/libjpl.so
+ * </code></blockquote>
+ *
+ * The exact paths are most probably different on your machine. Just look for the directory that
+ * contains the file or symbolic link <em>libjpl.jnilib</em> (under Mac OS X), <em>jpl.dll</em>
+ * (under Windows), or <em>libjpl.so</em> (under Unix). If you get the error message
+ *
+ * <blockquote><code>
+ * java.lang.UnsatisfiedLinkError: no jpl in java.library.path
+ * </code></blockquote>
+ *
+ * then this is a strong indication that the SWI Prolog JPL libraries are not found.
+ *
+ *
+ * @author Tobias Kuhn
+ */
+public class APELocal extends ACEParser {
+
+ private static APELocal apeLocal;
+
+ /**
+ * Creates a new parser object. You can create at most one such object per JVM. If you
+ * try to create more than one such object or if you called the init method before
+ * then a runtime exception is thrown.
+ *
+ * @param apeExeFile The path (with filename) of the file "ape.exe".
+ */
+ public APELocal(String apeExeFile) {
+ if (apeLocal != null) {
+ throw new RuntimeException("Only one APELocal object can be created.");
+ }
+
+ // A problem was reported that might be solved by using the --nosignals option.
+ // Otherwise, it seems to have no effect in our case.
+ // The first argument "swipl" has no effect and could be any other string.
+ JPL.init(new String[] {"swipl", "-x", apeExeFile, "-g", "true", "--nosignals"});
+
+ apeLocal = this;
+ }
+
+ /**
+ * Creates a new parser object. You can create at most one such object per JVM. If you
+ * try to create more than one such object or if you called the init method before
+ * then a runtime exception is thrown.
+ * <br>
+ * This method is deprecated because the {@code prologCommand} argument is actually not needed.
+ * Use {@link #APELocal(String)} instead.
+ *
+ * @param prologCommand The command to run the SWI Prolog interpreter.
+ * On Windows this is usually "plcon", on Linux "pl", and on Mac "swipl".
+ * @param apeExeFile The path (with filename) of the file "ape.exe".
+ */
+ @Deprecated
+ public APELocal(String prologCommand, String apeExeFile) {
+ this(apeExeFile);
+ }
+
+ /**
+ * Returns the singleton APELocal instance. Null is returned if the APELocal instance has not yet
+ * been initialized by the constructor or the init method.
+ *
+ * @return The singleton APELocal instance.
+ */
+ public static APELocal getInstance() {
+ return apeLocal;
+ }
+
+ /**
+ * Initializes the APELocal singleton instance. This method can be called at most once.
+ * If you call it twice or if you called the constructor before then a runtime exception
+ * is thrown.
+ *
+ * @param apeExeFile The path (with filename) of the file "ape.exe".
+ */
+ public static void init(String apeExeFile) {
+ new APELocal(apeExeFile);
+ }
+
+ /**
+ * Initializes the APELocal singleton instance. This method can be called at most once.
+ * If you call it twice or if you called the constructor before then a runtime exception
+ * is thrown.
+ * <br>
+ * This method is deprecated because the {@code prologCommand} argument is actually not needed.
+ * Use {@link #init(String)} instead.
+ *
+ * @param prologCommand The command to run the SWI Prolog interpreter.
+ * On Windows this is usually "plcon", on Linux "pl", and on Mac "swipl".
+ * @param apeExeFile The path (with filename) of the file "ape.exe".
+ */
+ @Deprecated
+ public static void init(String prologCommand, String apeExeFile) {
+ new APELocal(prologCommand, apeExeFile);
+ }
+
+ /**
+ * Checks whether the singleton instance has already been initialized.
+ *
+ * @return true if the singleton instance has been initialized.
+ */
+ public static boolean isInitialized() {
+ return apeLocal != null;
+ }
+
+ public synchronized String getSoloOutput(String text, Lexicon lexicon, OutputType outputType) throws ACEParserException {
+ clearMessages();
+ String ulextext = "";
+ if (lexicon != null) {
+ ulextext = ",ulextext=" + PrologUtils.escape(lexicon.toString());
+ }
+ Term input = Util.textToTerm("[text=" + PrologUtils.escape(text) + ulextext + ",solo=" + outputType.toString().toLowerCase() + getOptions() + "]");
+ Query q = new Query("get_ape_results", new Term[] {input, new Variable("Result")});
+ Atom result = (Atom) q.oneSolution().get("Result");
+ String s = result.name();
+
+ return checkForErrors(s);
+ }
+
+ public synchronized ACEParserResult getMultiOutput(String text, Lexicon lexicon, OutputType... outputTypes) {
+ clearMessages();
+ String outputs = "";
+ for (OutputType t : outputTypes) {
+ outputs += ",c" + t.toString().toLowerCase() + "=on";
+ }
+ String ulextext = "";
+ if (lexicon != null) {
+ ulextext = ",ulextext=" + PrologUtils.escape(lexicon.toString());
+ }
+ Term input = Util.textToTerm("[text=" + PrologUtils.escape(text) + ulextext + outputs + getOptions() + "]");
+ Query q = new Query("get_ape_results", new Term[] {input, new Variable("Result")});
+ Atom result = (Atom) q.oneSolution().get("Result");
+ return new ACEParserResult(result.name());
+ }
+
+ /**
+ * Loads the lexicon by adding all lexicon entries of the lexicon. Note that these lexicon entries
+ * are automatically discarded the first time you call getSoloOutput or getMultiOutput with a lexicon
+ * parameter that is not null.
+ *
+ * @param lexicon The lexicon to be loaded.
+ * @see #addLexiconEntry
+ * @see #discardLexicon
+ */
+ public synchronized void addLexicon(Lexicon lexicon) {
+ clearMessages();
+ Query q = new Query(new Compound("add_lexicon_entries", new Term[] { Util.textToTerm(lexicon.toList()) }));
+ q.oneSolution();
+ }
+
+ /**
+ * Adds a new lexicon entry. Note that this lexicon entry is automatically discarded the first time
+ * you call getSoloOutput or getMultiOutput with a lexicon parameter that is not null.
+ *
+ * @param lexiconEntry The lexicon entry to be added.
+ * @see #addLexicon
+ * @see #discardLexicon
+ */
+ public synchronized void addLexiconEntry(LexiconEntry lexiconEntry) {
+ clearMessages();
+ Query q = new Query(new Compound("add_lexicon_entry", new Term[] { Util.textToTerm(lexiconEntry.toString()) }) );
+ q.oneSolution();
+ }
+
+ /**
+ * Discards the dynamically added lexicon entries. Note that the lexicon entries that are complied into
+ * the SWI Prolog executable are not affected by this operation.
+ *
+ * @see #addLexiconEntry
+ * @see #addLexicon
+ */
+ public synchronized void discardLexicon() {
+ clearMessages();
+ Query q = new Query("discard_ulex");
+ q.oneSolution();
+ }
+
+ private void clearMessages() {
+ Query q = new Query("clear_messages");
+ q.oneSolution();
+ }
+}
View
133 java/src/ch/uzh/ifi/attempto/ape/APESocket.java
@@ -0,0 +1,133 @@
+// This file is part of the Attempto Java Packages.
+// Copyright 2008-2011, Attempto Group, University of Zurich (see http://attempto.ifi.uzh.ch).
+//
+// The Attempto Java Packages is free software: you can redistribute it and/or modify it under the
+// terms of the GNU Lesser General Public License as published by the Free Software Foundation,
+// either version 3 of the License, or (at your option) any later version.
+//
+// The Attempto Java Packages 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 for more details.
+//
+// You should have received a copy of the GNU Lesser General Public License along with the Attempto
+// Java Packages. If not, see http://www.gnu.org/licenses/.
+
+package ch.uzh.ifi.attempto.ape;
+
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.io.PrintWriter;
+import java.net.Socket;
+import java.net.UnknownHostException;
+
+/**
+ * This class provides an interface to the Attempto Parsing Engine (APE) socket server.
+ * The socket server implementation is provided by <code>ape.exe</code>. To start
+ * a server, execute for example:
+ *
+ * <pre>
+ * ./ape.exe -server -port 2766
+ * </pre>
+ *
+ * @author Kaarel Kaljurand
+ */
+public class APESocket extends ACEParser {
+
+ private String host;
+ private int port;
+
+ /**
+ * Constructs a new parser object based on the hostname and the port number
+ * of the APE socket server.
+ *
+ * @param host The hostname of the socket server.
+ * @param port The port number of the socket server.
+ */
+ public APESocket(String host, int port) {
+ this.host = host;
+ this.port = port;
+ }
+
+ /**
+ * Constructs a new parser object based on the APE socket server running on "localhost".
+ *
+ * @param port The port number of the socket server.
+ */
+ public APESocket(int port) {
+ this("localhost", port);
+ }
+
+ public ACEParserResult getMultiOutput(String text, Lexicon lexicon, OutputType... outputTypes) {
+ String ulexStr = "";
+ if (lexicon != null) {
+ ulexStr = ",ulextext=" + PrologUtils.escape(lexicon.toString());
+ }
+ String paramList = "text=" + PrologUtils.escape(text) + ulexStr + getOptions();
+ for (OutputType t : outputTypes) {
+ paramList = paramList + "," + t.toMultiFlag() + "=on";
+ }
+ return new ACEParserResult(getParserResponseAsString(paramList));
+ }
+
+ public String getSoloOutput(String text, Lexicon lexicon, OutputType outputType) throws ACEParserException {
+ String ulexStr = "";
+ if (lexicon != null) {
+ ulexStr = ",ulextext=" + PrologUtils.escape(lexicon.toString());
+ }
+ String paramList = "text=" + PrologUtils.escape(text) + ulexStr + ",solo=" + outputType.toSoloFlag() + getOptions();
+ return checkForErrors(getParserResponseAsString(paramList));
+ }
+
+
+ private String getParserResponseAsString(String paramList) {
+ Socket client;
+ try {
+ client = new Socket(host, port);
+ } catch (UnknownHostException e) {
+ throw new RuntimeException("Accessing APE socket failed: " + e.getMessage());
+ } catch (IOException e) {
+ throw new RuntimeException("Accessing APE socket failed: " + e.getMessage());
+ }
+
+
+ BufferedReader fromServer;
+
+ try {
+ fromServer = new BufferedReader(new InputStreamReader(client.getInputStream()));
+ } catch (IOException e) {
+ throw new RuntimeException("Accessing APE socket failed: " + e.getMessage());
+ }
+
+
+ PrintWriter toServer;
+ try {
+ toServer = new PrintWriter(client.getOutputStream(), true);
+ } catch (IOException e) {
+ throw new RuntimeException("Accessing APE socket failed: " + e.getMessage());
+ }
+
+ toServer.println("get([" + paramList + "]).");
+
+ String allLines = "";
+ String responseLine;
+ try {
+ while ((responseLine = fromServer.readLine()) != null) {
+ if (responseLine.equals("APESERVERSTREAMEND")) {
+ break;
+ }
+ allLines = allLines + responseLine;
+ }
+ } catch (IOException e) {
+ throw new RuntimeException("Accessing APE socket failed: " + e.getMessage());
+ }
+ try {
+ toServer.close();
+ fromServer.close();
+ client.close();
+ } catch (IOException e) {
+ throw new RuntimeException("Accessing APE socket failed: " + e.getMessage());
+ }
+ return allLines;
+ }
+}
View
193 java/src/ch/uzh/ifi/attempto/ape/APEWebservice.java
@@ -0,0 +1,193 @@
+// This file is part of the Attempto Java Packages.
+// Copyright 2008-2010, Attempto Group, University of Zurich (see http://attempto.ifi.uzh.ch).
+//
+// The Attempto Java Packages is free software: you can redistribute it and/or modify it under the
+// terms of the GNU Lesser General Public License as published by the Free Software Foundation,
+// either version 3 of the License, or (at your option) any later version.
+//
+// The Attempto Java Packages 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 for more details.
+//
+// You should have received a copy of the GNU Lesser General Public License along with the Attempto
+// Java Packages. If not, see http://www.gnu.org/licenses/.
+
+package ch.uzh.ifi.attempto.ape;
+
+import java.io.IOException;
+import java.io.UnsupportedEncodingException;
+import java.util.ArrayList;
+import java.util.List;
+
+import org.apache.http.HttpEntity;
+import org.apache.http.HttpResponse;
+import org.apache.http.HttpStatus;
+import org.apache.http.NameValuePair;
+import org.apache.http.client.ClientProtocolException;
+import org.apache.http.client.entity.UrlEncodedFormEntity;
+import org.apache.http.client.methods.HttpGet;
+import org.apache.http.client.methods.HttpPost;
+import org.apache.http.client.methods.HttpUriRequest;
+import org.apache.http.client.utils.URLEncodedUtils;
+import org.apache.http.impl.client.DefaultHttpClient;
+import org.apache.http.message.BasicNameValuePair;
+import org.apache.http.protocol.HTTP;
+import org.apache.http.util.EntityUtils;
+
+/**
+ * This class provides an interface to the Attempto Parsing Engine (APE) webservice
+ * (i.e. HTTP server).
+ * The HTTP server implementation is provided by <code>ape.exe</code>. To start
+ * a server, execute for example:
+ *
+ * <pre>
+ * ./ape.exe -httpserver -port 8000
+ * </pre>
+ *
+ * @author Kaarel Kaljurand
+ * @author Tobias Kuhn
+ */
+public class APEWebservice extends ACEParser {
+
+ private static final int MAX_HTTP_GET_LENGTH = 1000;
+ private static final String ERROR_MESSAGE = "Accessing APE webservice failed";
+
+ private String wsUrl;
+
+ /**
+ * Creates a new parser object based on the URL of a running APE webservice.
+ *
+ * @param wsUrl The URL of the APE webservice.
+ */
+ public APEWebservice(String wsUrl) {
+ this.wsUrl = wsUrl;
+ }
+
+ /**
+ * Sets the URL of the APE webservice to be used.
+ *
+ * @param wsUrl The URL of the APE webservice.
+ */
+ public void setWebserviceUrl(String wsUrl) {
+ if (wsUrl == null) {
+ throw new NullPointerException("APE webservice URL cannot be null");
+ }
+ this.wsUrl = wsUrl;
+ }
+
+ public String getSoloOutput(String aceText, Lexicon lexicon, OutputType outputType) throws ACEParserException {
+ List <NameValuePair> nvps = new ArrayList <NameValuePair>();
+ nvps.add(getTextParam(aceText));
+ nvps.add(getUlexParam(lexicon));
+ nvps.add(getSoloParam(outputType));
+ nvps.add(getUriParam());
+ nvps.add(getGuessParam());
+ nvps.add(getClexParam());
+ return checkForErrors(getResponseAsString(nvps));
+ }
+
+ public ACEParserResult getMultiOutput(String aceText, Lexicon lexicon, OutputType... outputTypes) {
+ List <NameValuePair> nvps = new ArrayList <NameValuePair>();
+ nvps.add(getTextParam(aceText));
+ nvps.add(getUlexParam(lexicon));
+ nvps.add(getUriParam());
+ nvps.add(getGuessParam());
+ nvps.add(getClexParam());
+ for (OutputType t : outputTypes) {
+ nvps.add(new BasicNameValuePair(t.toMultiFlag(), "on"));
+ }
+ return new ACEParserResult(getResponseAsString(nvps));
+ }
+
+ private NameValuePair getUlexParam(Lexicon lexicon) {
+ if (lexicon == null) {
+ return new BasicNameValuePair("ulextext", "");
+ }
+ return new BasicNameValuePair("ulextext", lexicon.toString());
+ }
+
+ private NameValuePair getTextParam(String text) {
+ return new BasicNameValuePair("text", text);
+ }
+
+ private NameValuePair getSoloParam(OutputType solo) {
+ return new BasicNameValuePair("solo", solo.toSoloFlag());
+ }
+
+ private NameValuePair getGuessParam() {
+ if (isGuessingEnabled()) {
+ return new BasicNameValuePair("guess", "on");
+ }
+ return new BasicNameValuePair("guess", "off");
+ }
+
+ private NameValuePair getClexParam() {
+ if (isClexEnabled()) {
+ return new BasicNameValuePair("noclex", "off");
+ }
+ return new BasicNameValuePair("noclex", "on");
+ }
+
+ private NameValuePair getUriParam() {
+ return new BasicNameValuePair("uri", getURI());
+ }
+
+ private String getResponseAsString(List<NameValuePair> nvps) {
+ DefaultHttpClient httpclient = new DefaultHttpClient();
+ HttpUriRequest request = getHttpUriRequest(nvps);
+ return getEntity(httpclient, request);
+ }
+
+ /**
+ * We create an HTTP GET query from the given parameters. If it turns out to be
+ * too long (which we expect to happen very infrequently) then we fall back to creating
+ * HTTP POST.
+ *
+ * BUG: Old versions of the SWI-Prolog HTTP server do not handle POST queries correctly.
+ * Hopefully this has been fixed in v5.11.9 (but I haven't tested it).
+ * See the bug report in the SWI-Prolog mailing list in 2010-11-03.
+ *
+ * @param nvps List of name-value pairs
+ * @return HTTP request (either GET or POST)
+ */
+ private HttpUriRequest getHttpUriRequest(List<NameValuePair> nvps) {
+ String getQuery = wsUrl + "?" + URLEncodedUtils.format(nvps, HTTP.UTF_8);
+ if (getQuery.length() > MAX_HTTP_GET_LENGTH) {
+ HttpPost httppost = new HttpPost(wsUrl);
+ try {
+ httppost.setEntity(new UrlEncodedFormEntity(nvps, HTTP.UTF_8));
+ } catch (UnsupportedEncodingException e) {
+ // BUG: Assuming that this cannot happen
+ }
+ return httppost;
+ }
+ return new HttpGet(getQuery);
+ }
+
+ private String getEntity(DefaultHttpClient httpclient, HttpUriRequest httpRequest) {
+ try {
+ HttpResponse response = httpclient.execute(httpRequest);
+ HttpEntity entity = response.getEntity();
+
+ if (entity == null) {
+ throw new RuntimeException(ERROR_MESSAGE + ": " + response.getStatusLine());
+ }
+ int statusCode = response.getStatusLine().getStatusCode();
+ if (statusCode != HttpStatus.SC_OK) {
+ throw new RuntimeException(ERROR_MESSAGE + ": " + response.getStatusLine());
+ }
+ // The APE webservice returns the data in UTF8, even if it doesn't declare it.
+ if (entity.getContentEncoding() == null) {
+ return EntityUtils.toString(entity, HTTP.UTF_8);
+ }
+ return EntityUtils.toString(entity);
+
+ } catch (ClientProtocolException e) {
+ throw new RuntimeException(ERROR_MESSAGE + ": " + e.getMessage());
+ } catch (IOException e) {
+ throw new RuntimeException(ERROR_MESSAGE + ": " + e.getMessage());
+ } finally {
+ httpclient.getConnectionManager().shutdown();
+ }
+ }
+}
View
64 java/src/ch/uzh/ifi/attempto/ape/FunctionWords.java
@@ -0,0 +1,64 @@
+// This file is part of the Attempto Java Packages.
+// Copyright 2008-2009, Attempto Group, University of Zurich (see http://attempto.ifi.uzh.ch).
+//
+// The Attempto Java Packages is free software: you can redistribute it and/or modify it under the
+// terms of the GNU Lesser General Public License as published by the Free Software Foundation,
+// either version 3 of the License, or (at your option) any later version.
+//
+// The Attempto Java Packages 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 for more details.
+//
+// You should have received a copy of the GNU Lesser General Public License along with the Attempto
+// Java Packages. If not, see http://www.gnu.org/licenses/.
+
+package ch.uzh.ifi.attempto.ape;
+
+import java.util.Arrays;
+import java.util.HashSet;
+import java.util.Set;
+
+/**
+ * This class contains the function words of ACE. These words have a predefined meaning and cannot
+ * be used in the lexicon. Function words like "can" or "true", which can be used in the lexicon,
+ * are not covered by this class.
+ *
+ * @author Tobias Kuhn
+ */
+public class FunctionWords {
+
+ private static HashSet<String> functionWords = new HashSet<String>(Arrays.asList(new String[] {
+ "null", "zero", "one", "two", "three", "four", "five", "six", "seven", "eight", "nine", "ten", "eleven",
+ "twelve", "dozen", "there", "and", "or", "not", "that", "than", "of", "if", "then", "such", "be", "provably",
+ "more", "most", "are", "is", "the", "a", "an", "some", "no", "every", "all", "each", "which", "its", "his",
+ "her", "their", "whose", "it", "he", "she", "they", "him", "them", "itself", "himself", "herself",
+ "themselves", "someone", "somebody", "something", "nobody", "nothing", "everyone", "everybody", "everything",
+ "what", "who", "how", "where", "when", "by", "Null", "Zero", "One", "Two", "Three", "Four", "Five", "Six",
+ "Seven", "Eight", "Nine", "Ten", "Eleven", "Twelve", "Dozen", "There", "If", "Are", "Is", "The", "A", "An",
+ "Some", "No", "Every", "All", "Each", "Which", "Its", "His", "Her", "Their", "Whose", "It", "He", "She",
+ "They", "Someone", "Somebody", "Something", "Nobody", "Nothing", "Everyone", "Everybody", "Everything",
+ "What", "Who", "How", "Where", "When"
+ }));
+
+ private FunctionWords() {} // no instances allowed
+
+ /**
+ * Checks whether a certain string represents a function word.
+ *
+ * @param s The string to be checked.
+ * @return true if the string represents a function word.
+ */
+ public static boolean isFunctionWord(String s) {
+ return functionWords.contains(s);
+ }
+
+ /**
+ * Returns a set that contains all function words.
+ *
+ * @return A list containing all function words.
+ */
+ public static Set<String> getFunctionWords() {
+ return new HashSet<String>(functionWords);
+ }
+
+}
View
63 java/src/ch/uzh/ifi/attempto/ape/Gender.java
@@ -0,0 +1,63 @@
+// This file is part of the Attempto Java Packages.
+// Copyright 2008-2009, Attempto Group, University of Zurich (see http://attempto.ifi.uzh.ch).
+//
+// The Attempto Java Packages is free software: you can redistribute it and/or modify it under the
+// terms of the GNU Lesser General Public License as published by the Free Software Foundation,
+// either version 3 of the License, or (at your option) any later version.
+//
+// The Attempto Java Packages 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 for more details.
+//
+// You should have received a copy of the GNU Lesser General Public License along with the Attempto
+// Java Packages. If not, see http://www.gnu.org/licenses/.
+
+package ch.uzh.ifi.attempto.ape;
+
+/**
+ * This enumeration lists the possible gender types for nouns and proper names.
+ *
+ * @author Tobias Kuhn
+ */
+public enum Gender {
+
+ /**