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

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