extensions/net.sf.basedb.varsearch/trunk/src/net/sf/basedb/varsearch/index/Indexer.java

Code
Comments
Other
Rev Date Author Line
6540 17 Jan 22 nicklas 1 package net.sf.basedb.varsearch.index;
6540 17 Jan 22 nicklas 2
6540 17 Jan 22 nicklas 3 import java.util.concurrent.Callable;
6540 17 Jan 22 nicklas 4
6545 21 Jan 22 nicklas 5 import net.sf.basedb.core.ArrayDesign;
6540 17 Jan 22 nicklas 6 import net.sf.basedb.core.RawBioAssay;
6540 17 Jan 22 nicklas 7
6540 17 Jan 22 nicklas 8 /**
6540 17 Jan 22 nicklas 9   Indexer implementations know how to index the variants for
6540 17 Jan 22 nicklas 10   a single raw bioassay. Instances are created by {@link 
6540 17 Jan 22 nicklas 11   LuceneIndex#createIndexer(org.apache.lucene.index.IndexWriter, int, RawBioAssay, java.util.List)}
6540 17 Jan 22 nicklas 12   and are typically executed in a multi-threaded environment.
6540 17 Jan 22 nicklas 13   
6540 17 Jan 22 nicklas 14 */
6540 17 Jan 22 nicklas 15 public interface Indexer 
6540 17 Jan 22 nicklas 16   extends Callable<Indexer>
6540 17 Jan 22 nicklas 17 {
6540 17 Jan 22 nicklas 18
6540 17 Jan 22 nicklas 19   /**
6540 17 Jan 22 nicklas 20     Get the number of variants that was indexed.
6540 17 Jan 22 nicklas 21   */
6540 17 Jan 22 nicklas 22   public int getNumVariants();
6540 17 Jan 22 nicklas 23   
6540 17 Jan 22 nicklas 24   /**
6540 17 Jan 22 nicklas 25     Get the number of genotypes that was indexed.
6540 17 Jan 22 nicklas 26   */
6540 17 Jan 22 nicklas 27   public int getNumGenotypes();
6540 17 Jan 22 nicklas 28   
6540 17 Jan 22 nicklas 29   /**
6540 17 Jan 22 nicklas 30     Get the raw bioassay that was indexed.
6540 17 Jan 22 nicklas 31   */
6540 17 Jan 22 nicklas 32   public RawBioAssay getRawBioAssay();
6540 17 Jan 22 nicklas 33   
6540 17 Jan 22 nicklas 34   /**
6545 21 Jan 22 nicklas 35     Get the array design that was indexed.
6545 21 Jan 22 nicklas 36   */
6545 21 Jan 22 nicklas 37   public ArrayDesign getArrayDesign();
6545 21 Jan 22 nicklas 38   
6545 21 Jan 22 nicklas 39   /**
6540 17 Jan 22 nicklas 40     Return TRUE if the indexing was aborted before it was completed.
6540 17 Jan 22 nicklas 41   */
6540 17 Jan 22 nicklas 42   public boolean wasAborted();
6540 17 Jan 22 nicklas 43   
6540 17 Jan 22 nicklas 44 }

Generated on Tue Nov 21 03:38:24 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)