src/jalview/io/packed/SimpleDataProvider.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  * minimal implementation of the DataProvider interface. Allows a FileParse
  27  * datasource to be specified as one of the DataProvider.JvDataType content
  28  * types, with or without some other associated object as external reference.
  29  */
  30 public class SimpleDataProvider implements DataProvider
  31 {
  32   DataProvider.JvDataType jvtype;
  33
  34   FileParse source;
  35
  36   Object assocseq;
  37
  38   /**
  39    * create a SimpleDataProvider
  40    *
  41    * @param type
  42    *          - contents of resource accessible via fp
  43    * @param fp
  44    *          - datasource
  45    * @param assoc
  46    *          - external object that fp's content should be associated with (may
  47    *          be null)
  48    */
  49   public SimpleDataProvider(DataProvider.JvDataType type, FileParse fp,
  50           Object assoc)
  51   {
  52     jvtype = type;
  53     source = fp;
  54     assocseq = assoc;
  55   }
  56
  57   @Override
  58   public FileParse getDataSource()
  59   {
  60     return source;
  61   }
  62
  63   @Override
  64   public Object getSequenceTarget()
  65   {
  66     return assocseq;
  67   }
  68
  69   @Override
  70   public DataProvider.JvDataType getType()
  71   {
  72     return jvtype;
  73   }
  74
  75 }