src/jalview/io/packed/DataProvider.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.io.packed;
  22
  23 import jalview.io.FileParse;
  24
  25 /**
  26  * API for a data provider that can be used with
  27  * jalview.io.packed.ParsePackedSet
  28  *
  29  * @author JimP
  30  *
  31  */
  32 public interface DataProvider
  33 {
  34   /**
  35    * class of data expected to be provided by datasource
  36    *
  37    * @author JimP
  38    *
  39    */
  40   public enum JvDataType
  41   {
  42     /**
  43      * any alignment flatfile recognisable by jalview.io.IdentifyFile
  44      */
  45     ALIGNMENT,
  46     /**
  47      * a jalview annotation file
  48      */
  49     ANNOTATION,
  50     /**
  51      * a GFF or Jalview features file
  52      */
  53     FEATURES,
  54     /**
  55      * a tree representation understood by the NewickFile parser
  56      */
  57     TREE,
  58     /**
  59      * any file that provides data that should be associated with a specified
  60      * sequence.
  61      */
  62     SEQASSOCATED;
  63   }
  64
  65   /**
  66    * data to be parsed according to its type. Each call to getDataSource should
  67    * return a new instance of the same data stream initialised to the beginning
  68    * of the chunk of data that is to be parsed.
  69    *
  70    * @return
  71    */
  72   FileParse getDataSource();
  73
  74   /**
  75    * association context for data. Either null or a specific sequence.
  76    *
  77    * @return
  78    */
  79   Object getSequenceTarget();
  80
  81   /**
  82    * type of data
  83    *
  84    * @return
  85    */
  86   DataProvider.JvDataType getType();
  87 }