JAL-1481 relevant todo re warning user for broken regex
[jalview.git] / src / jalview / io / packed / SimpleDataProvider.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
3  * Copyright (C) 2014 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 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  * The Jalview Authors are detailed in the 'AUTHORS' file.
18  */
19 package jalview.io.packed;
20
21 import jalview.io.FileParse;
22
23 /**
24  * minimal implementation of the DataProvider interface. Allows a FileParse
25  * datasource to be specified as one of the DataProvider.JvDataType content
26  * types, with or without some other associated object as external reference.
27  */
28 public class SimpleDataProvider implements DataProvider
29 {
30   DataProvider.JvDataType jvtype;
31
32   FileParse source;
33
34   Object assocseq;
35
36   /**
37    * create a SimpleDataProvider
38    * 
39    * @param type
40    *          - contents of resource accessible via fp
41    * @param fp
42    *          - datasource
43    * @param assoc
44    *          - external object that fp's content should be associated with (may
45    *          be null)
46    */
47   public SimpleDataProvider(DataProvider.JvDataType type, FileParse fp,
48           Object assoc)
49   {
50     jvtype = type;
51     source = fp;
52     assocseq = assoc;
53   }
54
55   @Override
56   public FileParse getDataSource()
57   {
58     return source;
59   }
60
61   @Override
62   public Object getSequenceTarget()
63   {
64     return assocseq;
65   }
66
67   @Override
68   public DataProvider.JvDataType getType()
69   {
70     return jvtype;
71   }
72
73 }