{"id":19053634,"url":"https://github.com/nating/lucene-search-engine","last_synced_at":"2025-10-07T17:27:25.198Z","repository":{"id":91224629,"uuid":"153936307","full_name":"nating/lucene-search-engine","owner":"nating","description":"Indexing and Searching for documents using Apache Lucene. 🔍","archived":false,"fork":false,"pushed_at":"2018-10-20T20:27:07.000Z","size":8931,"stargazers_count":0,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-02T10:46:18.389Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nating.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-10-20T18:34:11.000Z","updated_at":"2023-01-13T16:54:38.000Z","dependencies_parsed_at":"2023-03-24T08:04:57.898Z","dependency_job_id":null,"html_url":"https://github.com/nating/lucene-search-engine","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nating%2Flucene-search-engine","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nating%2Flucene-search-engine/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nating%2Flucene-search-engine/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nating%2Flucene-search-engine/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nating","download_url":"https://codeload.github.com/nating/lucene-search-engine/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240109715,"owners_count":19749182,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T23:32:53.852Z","updated_at":"2025-10-07T17:27:25.087Z","avatar_url":"https://github.com/nating.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"# lucene-search-engine 🔍\n\nA [Lucene](https://lucene.apache.org/) implementation of indexing and searching documents from the [Cranfield collection](http://ir.dcs.gla.ac.uk/resources/test_collections/cran/), evaluated using [trec_eval](https://trec.nist.gov/trec_eval/).\n\n## Usage\n\n*(You will need [maven](https://maven.apache.org/), [java](https://www.java.com/), [python](https://www.python.org/) x)*\n\nTo download and run the code:\n```bash\ngit clone https://github.com/nating/lucene-search-engine\ncd lucene-search-engine\n./run.sh\n```\n\nYou will see the trec_eval results of the Lucene application.\n\n## Output\n\nThe output of run.sh should look like this:\n\n|Metric \t|Geoff's |Seamus' |Difference\t|\n|---|---|---|---|\n|num_q  \t|225.0   |225.0   |0.0\t\t\t|\n|num_rel \t|218235.0|178376.0|39859.0\t\t|\n|um_rel \t|1837.0  |1837.0  |0.0\t\t\t|\n|num_rel_ret|1771.0  |1714.0  |57.0\t\t\t|\n|ap \t\t|0.425   |0.375   |0.05\t\t\t|\n|...|...|...|...|\n\nThese outputs represent: \n* The metrics from trec_eval.\n* The results of the application (Geoff's).\n* The results given as an example/ground truth in the TCD Computer Science module CS7IS3 (Seamus').\n* The difference between the two results for that metric.\n\n## Files\n\n* [**run.sh**](https://github.com/nating/lucene-search-engine/blob/master/run.sh) packages the maven app, indexes the cran files, performs the cran queries across the indexes, runs trec_eval, creates a results file and outputs the results of trec_eval.\n* [**IndexFiles.java**](https://github.com/nating/lucene-search-engine/blob/master/luceneapp/src/main/java/com/mycompany/luceneapp/IndexFiles.java) contains the code for indexing the cranfield documents.\n* [**CustomAnalyzer.java**](https://github.com/nating/lucene-search-engine/blob/master/luceneapp/src/main/java/com/mycompany/luceneapp/CustomAnalyzer.java) contains the custom analyzer for analyzing document and query content.\n* [**SearchFiles.java**](https://github.com/nating/lucene-search-engine/blob/master/luceneapp/src/main/java/com/mycompany/luceneapp/SearchFiles.java) contains the code for running the cranfield queries and creating the results file.\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnating%2Flucene-search-engine","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnating%2Flucene-search-engine","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnating%2Flucene-search-engine/lists"}