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
5 * This file is part of Jalview.
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.
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.
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;
21 * API for a data provider that can be used with jalview.io.packed.ParsePackedSet
25 public interface DataProvider
28 * class of data expected to be provided by datasource
32 public enum JvDataType
35 * any alignment flatfile recognisable by jalview.io.IdentifyFile
39 * a jalview annotation file
43 * a GFF or Jalview features file
47 * a tree representation understood by the NewickFile parser
51 * any file that provides data that should be associated with a specified sequence.
57 * data to be parsed according to its type. Each call to getDataSource
58 * should return a new instance of the same data stream initialised to the
59 * beginning of the chunk of data that is to be parsed.
63 jalview.io.FileParse getDataSource();
66 * association context for data. Either null or a specific sequence.
70 Object getSequenceTarget();
77 DataProvider.JvDataType getType();