src/jalview/io/FileFormatI.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;
  22
  23 import jalview.datamodel.AlignmentI;
  24
  25 import java.io.IOException;
  26
  27 public interface FileFormatI
  28 {
  29   AlignmentFileReaderI getReader(FileParse source) throws IOException;
  30
  31   AlignmentFileWriterI getWriter(AlignmentI al);
  32
  33   boolean isComplexAlignFile();
  34
  35   /**
  36    * Answers the display name of the file format (as for example shown in menu
  37    * options). This name should not be locale (language) dependent.
  38    */
  39   String getName();
  40
  41   /**
  42    * Returns a comma-separated list of file extensions associated with the
  43    * format
  44    *
  45    * @return
  46    */
  47   String getExtensions();
  48
  49   /**
  50    * Answers true if the format is one that Jalview can read. This implies that
  51    * the format provides an implementation for getReader which can parse a data
  52    * source for sequence data. Readable formats are included in the options in
  53    * the open file dialogue.
  54    *
  55    * @return
  56    */
  57   boolean isReadable();
  58
  59   /**
  60    * Answers true if the format is one that Jalview can write. This implies that
  61    * the object returned by getWriter provides an implementation of the print()
  62    * method. Writable formats are included in the options in the Save As file
  63    * dialogue, and the 'output to Textbox' option (if text format).
  64    *
  65    * @return
  66    */
  67   boolean isWritable();
  68
  69   /**
  70    * Answers true if the format is one that Jalview can output as text, e.g. to
  71    * a text box
  72    *
  73    * @return
  74    */
  75   boolean isTextFormat();
  76
  77   /**
  78    * Answers true if the file format is one that provides 3D structure data
  79    *
  80    * @return
  81    */
  82   boolean isStructureFile();
  83 }