source: trunk/java-client/org/nzdl/gsdl/util/NzdlConstants.java@ 2922

/*
 *    NzdlConstants.java
 *    Copyright (C) 2001 New Zealand Digital Library Project
 *
 *    This program is free software; you can redistribute it and/or modify
 *    it under the terms of the GNU General Public License as published by
 *    the Free Software Foundation; either version 2 of the License, or
 *    (at your option) any later version.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU General Public License for more details.
 *
 *    You should have received a copy of the GNU General Public License
 *    along with this program; if not, write to the Free Software
 *    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

//the package we're in
package org.nzdl.gsdl.util;

/**
 * Contains default values for: query and other stuff.
 *
 * @author Stuart Yeates   ([email protected])
 * @author Aziz Mahoui     ([email protected])
 * @author Gordon Paynter  ([email protected])
 * @author Dave Nichols    ([email protected])
 * @author George Buchanan ([email protected])
 * @version $Revision: 2922 $
 */
public interface NzdlConstants {

  String DEFAULT_QUERY_TERM   = "";
  String DEFAULT_QUERY_TYPE   = "ranked";
  boolean DEFAULT_CASE_FOLDING = true;
  boolean DEFAULT_STEMMING     = false;
  String DEFAULT_CASE_FOLDING_STRING = "true";
  String DEFAULT_STEMMING_STRING     = "false";
  boolean DEFAULT_QUERY_META  = false;
  String BOOLEAN_STRING = "boolean";
  String RANKED_STRING = "ranked";
 


  /* Greenstone metadata names */


  String LONG_COLLECTION_NAME = "collectionname";
  String ICON = "iconcollection";
  String SMALL_ICON = "iconcollectionsmall";
  String COLLECTION_DESCRIPTION = "collectionextra";
 
 

  int    DEFAULT_START_RESULTS = 1;
  int    DEFAULT_END_RESULTS   = 10;
  int    DEFAULT_MAX_DOCS      = 200;

    /* preferences not under explicit dialog/user control */
    

    String STEMMING = "stemming";
    String CASE_FOLDING = "casefolding";
    String QUERYTYPE = "querytype";


  /* Preference Strings */
  
  String DISPLAY_FIRST_DOC = "Automatically display the first document";
  String RAW_TEXT = "Always display raw text (don't interpret HTML)";
  String MULTIPLE_SERVERS =  "Connect to multiple servers";
  String LOG_SERVICE = "Log at the NzdlService level";
  String CACHE_CORBA = "Cache corba requests";
  String SAVE_DOCS = "Save documents";
  
/* these appear to have been generated by 
the idlj compiler but not any more - so 
they are are being placed here */

public static final int FRtermFreq = 1;
public static final int FRmatchterms = 2;
public static final int FROID = 4 ;
public static final int FRsubcol = 8;
public static final int FRranking = 16;
public static final int FRdocFreq = 32;
public static final int FRmetadata = 64;
public static final int FRfullTextBrowse = 128;

/* The constants above are based on these definitions from the C++ receptionist

#define FRtermFreq   1
#define FRmatchTerms 2
#define FROID        4
#define FRsubCol     8
#define FRranking    16
#define FRdocFreq    32
#define FRmetadata   64
// used to indicate a full text browse query for mgpp
#define FRfullTextBrowse  128

*/

}