/**

  * Distribution License:

  * JSword is free software; you can redistribute it and/or modify it under

  * the terms of the GNU Lesser General Public License, version 2.1 or later

  * as published by the Free Software Foundation. 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 Lesser General Public License for more details.

  *

  * The License is available on the internet at:

  *      http://www.gnu.org/copyleft/lgpl.html

  * or by writing to:

  *      Free Software Foundation, Inc.

  *      59 Temple Place - Suite 330

  *      Boston, MA 02111-1307, USA

  *

  * © CrossWire Bible Society, 2007 - 2016

  *

  */

 package org.crosswire.jsword.index.lucene;

 import java.io.IOException;

 import org.apache.lucene.document.Document;

 import org.apache.lucene.index.IndexReader;

 import org.apache.lucene.search.Collector;

 import org.apache.lucene.search.Scorer;

 import org.apache.lucene.search.Searcher;

 import org.crosswire.jsword.passage.Key;

 import org.crosswire.jsword.passage.NoSuchVerseException;

 import org.crosswire.jsword.passage.VerseFactory;

 import org.crosswire.jsword.versification.Versification;

 /**

  * A simple collector of verses that stores the verses in a Key.

  * 

  * @see gnu.lgpl.License The GNU Lesser General Public License for details.

  * @author DM Smith

  */

 public class VerseCollector extends Collector {

     /**

      * Create a collector for the searcher that populates results.

      * @param v11n

      *            the versification to which referenced pertains

      * @param searcher 

      * @param results 

      */

     public VerseCollector(Versification v11n, Searcher searcher, Key results) {

         this.v11n = v11n;

         this.searcher = searcher;

         this.results = results;

     }

     /*

      * (non-Javadoc)

      * 

      * @see org.apache.lucene.search.Collector#acceptsDocsOutOfOrder()

      */

     @Override

     public boolean acceptsDocsOutOfOrder() {

         // Order is unimportant

         return true;

     }

     /*

      * (non-Javadoc)

      * 

      * @see org.apache.lucene.search.Collector#collect(int)

      */

     @Override

     public void collect(int docId) throws IOException {

         Document doc = searcher.doc(docBase + docId);

         try {

             Key key = VerseFactory.fromString(v11n, doc.get(LuceneIndex.FIELD_KEY));

             results.addAll(key);

         } catch (NoSuchVerseException e) {

             // Wrap the NoSuchVerseException in an IOException so it can be

             // gotten.

             IOException ioe = new IOException();

             ioe.initCause(e);

             throw ioe;

             // JDK6: Change to:

             // throw new IOException(e);

         }

     }

     /*

      * (non-Javadoc)

      * 

      * @see

      * org.apache.lucene.search.Collector#setNextReader(org.apache.lucene.index

      * .IndexReader, int)

      */

     @Override

     public void setNextReader(IndexReader reader, int docBase) throws IOException {

         this.docBase = docBase;

     }

     /*

      * (non-Javadoc)

      * 

      * @see

      * org.apache.lucene.search.Collector#setScorer(org.apache.lucene.search

      * .Scorer)

      */

     @Override

     public void setScorer(Scorer scorer) throws IOException {

         // This collector does no scoring. It collects all hits.

     }

     private int docBase;

     private Versification v11n;

     private Searcher searcher;

     private Key results;

 }