wiki:BluePrint/TextSearch

Version 21 (modified by Vishrut Mehta, 9 years ago) ( diff )

--

BluePrint: Text Search

Introduction

The Blueprint outlines the development of two functionalities for Sahana Eden. They are:

Full-text Search

  • It will provides users to search for text in uploaded documents.

Global Search

  • It will provide users to search for text over multiple resources (eg. Organization, Hospital, etc.).

Stakeholders

  • The End Users

Agencies like:

  • TLDRMP : Timor Leste Disaster Risk Management Portal
  • CSN : Community Stakeholder Network
  • LAC: Los Angeles County
  • IFRC : International Federation of Red Cross and Red Crescent Societies

User Stories

For Full-Text Search:

  • The user will have to go to Document module and Search option. Then he has to type the text(or the specified query format) to search in all the uploaded documents.
  • The result will be the name on the document, the link to the uploaded documents(specifying the authorization checks) and a line of text containing the search string.

Requirements

Functional

For Full Text Search:

  • Proper understanding and the work model of S3Search(depricated) and S3Filter is required.
  • Literature study of Apache Lucene and PyLucene.
  • Getting familiar with PyLucene and deploy it into my local machine.
  • Studying the linkage of the Lucene daemon and web2py server.
  • Extend the functionality of S3Filter by introducing an addition feature (which is a text field) to search for text through documents.
  • A user interface for displaying the search result.

Non-functional

Standards

System Constraints

  • The user should have PyLucene installed in there machine.
  • Also, while starting the web2py server, the Lucence deamon should also start.
  • In case of failure, the search query related to full-text search will not be functional.

Use-Cases

Design

Workflows

For Full-Text Search:

  • The workflow will be according to the use case described above. First the user should need to analyze whether he wants to search through all the uploaded documents or any resource specific document.

UnRelated Search:

  • The user should go the the Document -> Search.
  • Type the following query(string) he wants to search for.
  • The output will be the response of the Lucene Daemon running in the background.
  • T

Site Map

Wireframes

Technologies

Implementation

References

Chats and Discussions

http://logs.sahanafoundation.org/sahana-eden/2013-03-24.txt
http://logs.sahanafoundation.org/sahana-eden/2013-03-24.txt
http://logs.sahanafoundation.org/sahana-eden/2013-04-20.txt

Online Resources

http://lucene.apache.org/core/4_2_1/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#Boosting_a_Term
http://lucene.apache.org/pylucene/features.html
http://oak.cs.ucla.edu/cs144/projects/lucene/


BluePrint

Attachments (1)

Download all attachments as: .zip

Note: See TracWiki for help on using the wiki.