scripts/mir-setup/README: update with link to new doc on wiki
[mir.git] / source / mircoders / search / KeywordSearchTerm.java
1 /*
2  * Copyright (C) 2001, 2002 The Mir-coders group
3  *
4  * This file is part of Mir.
5  *
6  * Mir is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * Mir is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with Mir; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  *
20  * In addition, as a special exception, The Mir-coders gives permission to link
21  * the code of this program with  any library licensed under the Apache Software License,
22  * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library
23  * (or with modified versions of the above that use the same license as the above),
24  * and distribute linked combinations including the two.  You must obey the
25  * GNU General Public License in all respects for all of the code used other than
26  * the above mentioned libraries.  If you modify this file, you may extend this
27  * exception to your version of the file, but you are not obligated to do so.
28  * If you do not wish to do so, delete this exception statement from your version.
29  */
30
31 package mircoders.search;
32
33 import java.util.Map;
34
35 import javax.servlet.http.HttpServletRequest;
36
37 import mir.entity.Entity;
38
39 import org.apache.lucene.document.Document;
40 import org.apache.lucene.document.Field;
41
42
43 /**
44  * indexes a field and stores it for retrieval, but
45  * does not tokenize it.  useful for things 
46  * like strings representing
47  */
48 public class KeywordSearchTerm extends SearchTerm{
49
50
51   public KeywordSearchTerm(String anEntityPart,String aParamName,String aMatchField,String aDataField, String aTemplateVariable){
52     partOfEntity = anEntityPart;
53     paramName = aParamName;
54     matchField = aMatchField;
55     dataField = aDataField;
56     templateVariable = aTemplateVariable;
57   }
58
59
60   public void index(Document doc, Entity entity){
61     doc.add(Field.Keyword(matchField,entity.getFieldValue(partOfEntity)));
62   }
63
64   public void indexValue(Document doc, String value){
65     doc.add(Field.Keyword(matchField, value));
66   }
67
68
69   public String makeTerm(HttpServletRequest req){
70       String wanted = req.getParameter(paramName);
71       if (wanted != null && !(wanted.equals(""))){
72         return matchField + ":" + "\"" + wanted + "\"";
73       }
74                         return null;
75   }
76   public void returnMeta(Map result,Document doc){
77     result.put(templateVariable,doc.get(dataField));
78   }
79
80
81 }
82
83