| | 1 | == Build Lucene Index (in java class) == |
| | 2 | ==== Command line : csv export a DB table & call lucene from command line ==== |
| | 3 | * http://gbic.target.rug.nl/trac/pheno/wiki/DespoinaLog/2010/04/29 |
| | 4 | |
| | 5 | ==== Call class from plugin in molgenis ==== |
| | 6 | * either command call lucene : |
| | 7 | * http://publib.boulder.ibm.com/iseries/v5r1/ic2924/index.htm?info/rzaha/clcommex.htm |
| | 8 | * or http://lucene.apache.org/java/2_0_0/api/overview-summary.html |
| | 9 | * http://today.java.net/pub/a/today/2003/07/30/LuceneIntro.html |
| | 10 | * http://lucene.apache.org/java/2_4_0/api/org/apache/lucene/index/memory/MemoryIndex.html |
| | 11 | * http://www.jpgtutorials.com/lucene-full-text-search-in-java |
| | 12 | * * /hvp_pilot/handwritten/java/plugins/callLucene3.java: |
| | 13 | * In main method we create an instance of !IndexBuilder object and call its buildIndex() method. In buildIndex() method we create a File object which repesents our index directory. Then we create a !StandardAnalyzer object. !StandardAnalyzer is extended from Analyzer class. It splits the text into words, convert them to lower case and remove some common words like is, this etc. You may use any other analyzer or create your own analyzer. |
| | 14 | * !IndexWriter object is instantiated by passing parameters to the constructor. The first parameter is Directory object. Since we are using file based index, we use FSDirectory object which is extended from abstract class Directory. Second parameter is the analyzer object which we already created. Third parameter specifies whether we should create or update index. In our case, we are creating index. Fourth parameter specifies the number of tokens which should be indexed. In our case, we are using default number which is 10, 000. If our field value is of type text and consists of more than 10, 000 words excluding stop words, rest will be ignored. But you can select number of tokens unlimited also. |
| | 15 | * During iteration we create Document object. Field objects are created for all columns by providing column name/value pair. We create another field called fulltext by combining the values of name, age and designation fields. This is the default field where we do the search. We pass four parameters to the Field constructor. First parameter is the name of the field. We provide column name as field name. Second parameter is the field value which is again given by column value. Third parameter specifies whether we should store the field value in the index. If we store the field value, we may retrieve it later in its original form from the index rather than quering from database again. This is Ok for small sized fields but not recommended for large text fields |
| | 16 | * Fourth parameter is about indexing. We are not indexing employeeid field. This means this field is not searchable. Since id field is a unique integer value representing employee record, there is no point in searching it. Name and designation fields are indexed and tokenized. This means field value is split into tokens and indexed. ANALYZED constant represents it. Age field is indexed but not tokenized. Since it is an integer value, there is no point in splitting it. Full text field is not stored but indexed and tokenized. Then we add all fields to Document object and Document object is adeded to !IndexWriter object. |
| | 17 | * Finally we optimize the index and close all resources like !IndexWriter and Connection objects. |
| | 18 | * Ok, now our index is ready. |
| | 19 | * Next step , create a new plugin to test it and call the SearchIndex class or , use an existing one. |
| | 20 | |
| | 21 | ==== DONE ==== |
| | 22 | 1. get a reference to index directory file |
| | 23 | 1. initialize the driver class, connect to DB to table hvp pilot with data , |
| | 24 | 1. create statement object |
| | 25 | 1. retrieve fields geneName, chromosomeLocation , geneDescription from DB and create field objects and add to document |
| | 26 | 1. add the document to writer |
| | 27 | 1. optimize the index |
| | 28 | |
| | 29 | ==== next TODO : ==== |
| | 30 | create a new plugin in hvp_pilot to Search the created index from callLucene3 . the plugin should contain an input for the user to enter the search text . |
| | 31 | |
| | 32 | * LuceneSearchPlugin (new plugin to Search Index).The idea here is to add an html input (from user ) to search database (lucene) created index. |
| | 33 | |
| | 34 | == other : == |
| | 35 | eclipse --> New Install : add "http://download.jboss.org/jbosstools/updates/stable/galileo/" and continue |
