Permalink
Browse files

Added license comments and README.txt

  • Loading branch information...
1 parent 979a47f commit d0c2ba251dd00b82d90a7cca9dc0a54f3720de0a tep committed Jul 6, 2012
Showing with 1,051 additions and 514 deletions.
  1. +62 −0 GettingStarted.txt
  2. +53 −0 LICENSE.txt
  3. +113 −58 README.txt
  4. +0 −3 pom.xml
  5. +8 −0 scripts/build-index.sh
  6. +10 −0 scripts/query-index.sh
  7. +11 −0 src/main/java/com/yahoo/glimmer/indexing/BySubjectCollectionBuilder.java
  8. +11 −0 src/main/java/com/yahoo/glimmer/indexing/CombinedTermProcessor.java
  9. +11 −0 src/main/java/com/yahoo/glimmer/indexing/ConcatenatedDocumentCollection.java
  10. +11 −0 src/main/java/com/yahoo/glimmer/indexing/DocSizesGenerator.java
  11. +11 −0 src/main/java/com/yahoo/glimmer/indexing/DocSizesReader.java
  12. +11 −0 src/main/java/com/yahoo/glimmer/indexing/HorizontalDocument.java
  13. +11 −0 src/main/java/com/yahoo/glimmer/indexing/HorizontalDocumentFactory.java
  14. +11 −0 src/main/java/com/yahoo/glimmer/indexing/NonWordTermProcessor.java
  15. +11 −0 src/main/java/com/yahoo/glimmer/indexing/RDFDocument.java
  16. +11 −0 src/main/java/com/yahoo/glimmer/indexing/RDFDocumentFactory.java
  17. +11 −0 src/main/java/com/yahoo/glimmer/indexing/RDFInputFormat.java
  18. +11 −0 src/main/java/com/yahoo/glimmer/indexing/RDFRecordReader.java
  19. +11 −0 src/main/java/com/yahoo/glimmer/indexing/RDFtoTrecWebConverter.java
  20. +11 −0 src/main/java/com/yahoo/glimmer/indexing/StatementCollectorHandler.java
  21. +11 −0 src/main/java/com/yahoo/glimmer/indexing/StopwordTermProcessor.java
  22. +11 −0 src/main/java/com/yahoo/glimmer/indexing/TitleListDocumentCollection.java
  23. +11 −0 src/main/java/com/yahoo/glimmer/indexing/TriplesCollectionBuilder.java
  24. +11 −0 src/main/java/com/yahoo/glimmer/indexing/VerticalDocument.java
  25. +11 −0 src/main/java/com/yahoo/glimmer/indexing/VerticalDocumentFactory.java
  26. +11 −0 src/main/java/com/yahoo/glimmer/indexing/WordArrayReader.java
  27. +11 −0 src/main/java/com/yahoo/glimmer/indexing/WordIndexGenerator.java
  28. +11 −0 src/main/java/com/yahoo/glimmer/indexing/generator/DocumentMapper.java
  29. +11 −0 src/main/java/com/yahoo/glimmer/indexing/generator/Index.java
  30. +11 −0 src/main/java/com/yahoo/glimmer/indexing/generator/Occurrence.java
  31. +11 −0 src/main/java/com/yahoo/glimmer/indexing/generator/TermOccurrencePair.java
  32. +11 −0 src/main/java/com/yahoo/glimmer/indexing/generator/TermOccurrencePairReduce.java
  33. +11 −0 src/main/java/com/yahoo/glimmer/indexing/generator/TripleIndexGenerator.java
  34. +11 −0 src/main/java/com/yahoo/glimmer/indexing/preprocessor/ResourceRecordWriter.java
  35. +11 −0 src/main/java/com/yahoo/glimmer/indexing/preprocessor/ResourcesReducer.java
  36. +11 −0 src/main/java/com/yahoo/glimmer/indexing/preprocessor/TuplesToResourcesMapper.java
  37. +11 −0 src/main/java/com/yahoo/glimmer/indexing/preprocessor/TuplesTool.java
  38. +11 −0 src/main/java/com/yahoo/glimmer/query/Context.java
  39. +11 −0 src/main/java/com/yahoo/glimmer/query/IndexStatistics.java
  40. +11 −0 src/main/java/com/yahoo/glimmer/query/QueryLogger.java
  41. +11 −0 src/main/java/com/yahoo/glimmer/query/RDFIndex.java
  42. +11 −0 src/main/java/com/yahoo/glimmer/query/RDFQueryParser.java
  43. +11 −0 src/main/java/com/yahoo/glimmer/query/RDFQueryResult.java
  44. +11 −0 src/main/java/com/yahoo/glimmer/query/RDFResultItem.java
  45. +11 −0 src/main/java/com/yahoo/glimmer/query/SetDocumentPriors.java
  46. +11 −0 src/main/java/com/yahoo/glimmer/query/Util.java
  47. +11 −0 src/main/java/com/yahoo/glimmer/query/WOOScorer.java
  48. +11 −0 src/main/java/com/yahoo/glimmer/util/ComputeHashTool.java
  49. +11 −0 src/main/java/com/yahoo/glimmer/util/MapReducePartInputStreamEnumeration.java
  50. +11 −0 src/main/java/com/yahoo/glimmer/util/MergeSortTool.java
  51. +0 −453 src/main/java/com/yahoo/glimmer/util/NTriplesUtil.java
  52. +12 −0 src/main/java/com/yahoo/glimmer/util/NTuplesWriter.java
  53. +11 −0 src/main/java/com/yahoo/glimmer/util/ReadersWriterMergeSort.java
  54. +11 −0 src/main/java/com/yahoo/glimmer/util/Util.java
  55. +11 −0 src/main/java/com/yahoo/glimmer/vocabulary/OwlUtils.java
  56. +11 −0 src/main/java/com/yahoo/glimmer/web/DocObjectView.java
  57. +11 −0 src/main/java/com/yahoo/glimmer/web/FormatParameterToViewNameTranslator.java
  58. +11 −0 src/main/java/com/yahoo/glimmer/web/IndexMap.java
  59. +11 −0 src/main/java/com/yahoo/glimmer/web/JsObjectView.java
  60. +11 −0 src/main/java/com/yahoo/glimmer/web/Querier.java
  61. +11 −0 src/main/java/com/yahoo/glimmer/web/QueryCommand.java
  62. +11 −0 src/main/java/com/yahoo/glimmer/web/QueryController.java
  63. +11 −0 src/main/java/com/yahoo/glimmer/web/XmlObjectView.java
  64. +67 −0 src/main/resources/t_namespaces.html
  65. +11 −0 src/test/java/com/yahoo/glimmer/indexing/AbstractDocumentFactoryTest.java
  66. +11 −0 src/test/java/com/yahoo/glimmer/indexing/HorizontalDocumentFactoryTest.java
  67. +11 −0 src/test/java/com/yahoo/glimmer/indexing/VerticalDocumentFactoryTest.java
  68. +11 −0 src/test/java/com/yahoo/glimmer/indexing/generator/DocumentMapperTest.java
  69. +11 −0 src/test/java/com/yahoo/glimmer/indexing/generator/TermOccurrencePairReduceTest.java
  70. +11 −0 src/test/java/com/yahoo/glimmer/indexing/preprocessor/ResourceRecordWriterTest.java
  71. +11 −0 src/test/java/com/yahoo/glimmer/indexing/preprocessor/ResourcesReducerTest.java
  72. +11 −0 src/test/java/com/yahoo/glimmer/indexing/preprocessor/TextMatcher.java
  73. +11 −0 src/test/java/com/yahoo/glimmer/indexing/preprocessor/TuplesToResourcesMapperTest.java
  74. +11 −0 src/test/java/com/yahoo/glimmer/util/ComputeHashTest.java
  75. +11 −0 src/test/java/com/yahoo/glimmer/util/ReadersWriterMergeSortTest.java
View
@@ -0,0 +1,62 @@
+Welcome to Glimmer
+
+ Glimmer is a Hadoop based distributed indexing system for building MG4J indexes from RDF tuples in NQuads format. It also includes a simple web application for querying the resulting indexes <TODO +something about this+scorer..). Both the indexing and web application are written in Java. There are also a few shell scripts to execute the steps need to build the indexes for a given NQuads file and query the resulting index from the command line. Glimmer is an academic project and is the implementation of distributed indexing detailed in the paper 'Distributed Indexing for Semantic Search' by Peter Mika(Yahoo Research).
+
+Prerequisites
+-------------
+- Java JDK 6. Other versions may work. The code was written against version 1.6.0_31
+- A Maven installation. We used version 3.0.3 during development.
+- A Hadoop cluster. Probably version 0.20.205.0. The version of Hadoop we developed the code with is defined in the pom.xml file.
+- If you want try out the web app an install of a Java servlet container such as Tomcat, Jetty etc..
+- If you want a more usable interface to the MG4J query command-line you can install rlwrap to get command-line history/editing.
+
+All other dependencies are jars that are automatically downloaded by Maven.
+
+Index Building
+--------------
+
+1. Build an uber jar with mvn for building indexes with.
+
+In the root directory of Glimmer run:
+
+ mvn compile (or mvn test)
+ mvn assembly:single
+
+This will produce a jar Glimmer-?.?.?-SNAPSHOT-jar-with-dependencies.jar in the ./target directory. This jar contains the Glimmer classes + all dependencies zipped into one file.
+
+2. The process of building an index with Glimmer consists of the following steps. (The build-index.sh shell script is provided to automate the process.)
+
+* Preprocess the NQuads tuple file to get:
+ - A sorted unique list by subject with the subjects associated predicates, object, context.
+ - A sorted unique list of subjects resources.
+ - A sorted unique list of predicates resources.
+ - A sorted unique list of all resources(Subject, Predicate, Object & Context).
+
+* Build minimal perfect hash functions over the unique sorted lists of resources. This function is a mapping of a given resource to its position in the unique sorted list.
+
+* Build the 'horizontal' and 'vertical'(See the paper..) MG4J indexes.
+
+* Compute the Document sizes.
+
+* Build the MG4J document collection.
+
+* Copy all the generated files to the desired location.
+
+
+Querying
+--------
+
+Once you have the indexes build you can use the MG4J query command line class it.unimi.dsi.mg4j.query.Query to query them. You may find the query-index.sh script helpful here.
+
+You can also setup, build and deploy the Java web application as follows:
+
+1. Configure where your indexes are in src/main/webapp/WEB-INF/classes/config-generic.properties. The directories found in the directory given by 'multiindex.path' property and that have names starting with the 'multiindex.dirprefix' property are treated as MG4J indexes. The names will appear in the Dataset dropdown in the webapp.
+
+2. Use the maven-war-plugin to build the war file. From the projects root directory run the command
+
+ mvn compile (or mvn test)
+ mvn war:war (mvn war:exploded maybe of interest to some people too)
+
+This will build the war file Glimmer-?.?.?-SNAPSHOT.war in the target directory.
+
+2. Copy the war into do the deployment directory of your installed Java Servlet container.
View
@@ -0,0 +1,53 @@
+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:
+
+You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+You must cause any modified files to carry prominent notices stating that You changed the files; and
+
+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
+
+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.
Oops, something went wrong.

0 comments on commit d0c2ba2

Please sign in to comment.