Coverage Report - org.crosswire.jsword.index.IndexPolicy
 
Classes in this File Line Coverage Branch Coverage Complexity
IndexPolicy
N/A
N/A
1
 
 1  
 /**
 2  
  * Distribution License:
 3  
  * JSword is free software; you can redistribute it and/or modify it under
 4  
  * the terms of the GNU Lesser General Public License, version 2.1 or later
 5  
  * as published by the Free Software Foundation. This program is distributed
 6  
  * in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
 7  
  * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 8  
  * See the GNU Lesser General Public License for more details.
 9  
  *
 10  
  * The License is available on the internet at:
 11  
  *      http://www.gnu.org/copyleft/lgpl.html
 12  
  * or by writing to:
 13  
  *      Free Software Foundation, Inc.
 14  
  *      59 Temple Place - Suite 330
 15  
  *      Boston, MA 02111-1307, USA
 16  
  *
 17  
  * © CrossWire Bible Society, 2005 - 2016
 18  
  *
 19  
  */
 20  
 package org.crosswire.jsword.index;
 21  
 
 22  
 /**
 23  
  * An IndexPolicy allows for controlling the overall behavior
 24  
  * of Index creation. This class will change from time to time
 25  
  * so it is important to derive from IndexPolicyAdapter to
 26  
  * provide application resiliency.
 27  
  *
 28  
  * @see gnu.lgpl.License The GNU Lesser General Public License for details.
 29  
  * @author DM Smith
 30  
  */
 31  
 public interface IndexPolicy {
 32  
     /**
 33  
      * Indicates whether Strong's Numbers should be included in the index.
 34  
      * Adapter default: true;
 35  
      * 
 36  
      * @return true if Strong's Numbers should be indexed
 37  
      */
 38  
     boolean isStrongsIndexed();
 39  
 
 40  
     /**
 41  
      * Indicates whether Strong's Numbers should be included in the index.
 42  
      * Adapter default: true;
 43  
      * 
 44  
      * @return true if Strong's Numbers should be indexed
 45  
      */
 46  
     boolean isMorphIndexed();
 47  
 
 48  
     /**
 49  
      * Indicates whether Strong's Numbers should be included in the index.
 50  
      * Adapter default: true;
 51  
      * 
 52  
      * @return true if Notes should be indexed
 53  
      */
 54  
     boolean isNoteIndexed();
 55  
 
 56  
     /**
 57  
      * Indicates whether Titles and Introductions should be included in the index.
 58  
      * Adapter default: true;
 59  
      * 
 60  
      * @return true if Titles and Introductions should be indexed
 61  
      */
 62  
     boolean isTitleIndexed();
 63  
 
 64  
     /**
 65  
      * Indicates whether Cross References should be included in the index.
 66  
      * Adapter default: true;
 67  
      * 
 68  
      * @return true if Cross References should be indexed
 69  
      */
 70  
     boolean isXrefIndexed();
 71  
 
 72  
     /**
 73  
      * The maximum size of the RAM Buffer in megabytes that
 74  
      * the underlying indexer may use during index creation.
 75  
      * Adapter default: 16.
 76  
      * 
 77  
      * @return the size of the RAM Buffer.
 78  
      */
 79  
     int getRAMBufferSize();
 80  
 
 81  
     /**
 82  
      * Indicates whether one Book can be indexed at a time.
 83  
      * When false, there is no upper bound on the number of
 84  
      * Books at any one time. Adapter default: false.
 85  
      * 
 86  
      * @return whether there can only be one Book indexed at a time.
 87  
      */
 88  
     boolean isSerial();
 89  
 }