src/jalview/io/packed/DataProvider.java

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