source/mircoders/search/SearchTerm.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 import javax.servlet.http.HttpServletRequest;
  35 import mir.entity.Entity;
  36 import org.apache.lucene.document.Document;
  37
  38
  39 abstract public class SearchTerm {
  40   protected String  partOfEntity;
  41   protected String  paramName;
  42   protected String  matchField;
  43   protected String  dataField;
  44   protected String  templateVariable;
  45
  46   public SearchTerm(String anEntityPart, String aParamName, String aMatchField, String aDataField, String aTemplateVariable){
  47     //for more reusable SearchTerm types
  48     partOfEntity     = anEntityPart;
  49     paramName        = aParamName;
  50     matchField       = aMatchField;
  51     dataField        = aDataField;
  52     templateVariable = aTemplateVariable;
  53   }
  54
  55   public SearchTerm(){
  56     //do nothing, we'll get the values from the extending class definition instead
  57   }
  58
  59   abstract public void index(Document doc, Entity entity) throws Exception;
  60   abstract public String makeTerm(HttpServletRequest req);
  61   abstract public void returnMeta(Map result,Document doc);
  62
  63
  64 }