src/main/java/jp/sourceforge/stigmata/ComparisonResultSet.java

   1 package jp.sourceforge.stigmata;
   2
   3 /*
   4  * $Id$
   5  */
   6
   7 import java.util.Iterator;
   8
   9 /**
  10  * result set of birthmark comparison.
  11  *
  12  * @author Haruaki TAMADA
  13  * @version $Revision$
  14  */
  15 public interface ComparisonResultSet extends Iterable<ComparisonPair>{
  16     /**
  17      * the birthmark environment.
  18      */
  19     public BirthmarkEnvironment getEnvironment();
  20
  21     /**
  22      * the birthmark context.
  23      */
  24     public BirthmarkContext getContext();
  25
  26     /**
  27      * a iterator for {@link ComparisonPair <code>ComparisonPair</code>}.
  28      */
  29     public Iterator<ComparisonPair> iterator();
  30
  31     /**
  32      * a comparison pair at given index.
  33      */
  34     public ComparisonPair getPairAt(int index);
  35
  36     /**
  37      * all comparison pairs.
  38      */
  39     public ComparisonPair[] getPairs();
  40
  41     /**
  42      * comparison pair count of this instance has.
  43      */
  44     public int getPairCount();
  45
  46     /**
  47      * comparison source.
  48      */
  49     public BirthmarkSet[] getPairSources();
  50
  51     /**
  52      * returns an array of comparison sources.
  53      */
  54     public Iterator<BirthmarkSet> pairSources();
  55 }