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 the com.oreilly.servlet library, any library
  22  * licensed under the Apache Software License, The Sun (tm) Java Advanced
  23  * Imaging library (JAI), The Sun JIMI library (or with modified versions of
  24  * the above that use the same license as the above), and distribute linked
  25  * combinations including the two.  You must obey the GNU General Public
  26  * License in all respects for all of the code used other than the above
  27  * mentioned libraries.  If you modify this file, you may extend this exception
  28  * to your version of the file, but you are not obligated to do so.  If you do
  29  * not wish to do so, delete this exception statement from your version.
  30  */
  31
  32 package mircoders.search;
  33
  34 import java.util.*;
  35
  36 import javax.servlet.*;
  37 import javax.servlet.http.*;
  38
  39 import mir.entity.*;
  40 import mircoders.entity.*;
  41 import mircoders.storage.*;
  42
  43 import org.apache.lucene.index.*;
  44 import org.apache.lucene.document.Document;
  45
  46 import freemarker.template.*;
  47
  48
  49 abstract public class SearchTerm {
  50
  51   public static String  partOfEntity;
  52   public static String  paramName;
  53   public static String  matchField;
  54   public static String  dataField;
  55   public static String  templateVariable;
  56
  57   public SearchTerm(String anEntityPart,String aParamName,String aMatchField,String aDataField, String aTemplateVariable){
  58     //for more reusable SearchTerm types
  59     partOfEntity     = anEntityPart;
  60     paramName        = aParamName;
  61     matchField       = aMatchField;
  62     dataField        = aDataField;
  63     templateVariable = aTemplateVariable;
  64   }
  65
  66   public SearchTerm(){
  67     //do nothing, we'll get the values from the extending class definition instead
  68   }
  69
  70   abstract public void index(Document doc, Entity entity) throws Exception;
  71   abstract public String makeTerm(HttpServletRequest req);
  72   abstract public void returnMeta(SimpleHash result,Document doc);
  73
  74
  75 }