X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fio%2FFileFormatI.java;h=e6f390dd58f7696f607c42f67eacb1689bbffb5e;hb=968c3bcde941e502fcf7d497343600f4f58f6c9a;hp=c9d56ae4c0e030a3e9911908278693f7a274225b;hpb=8dd4255a671e95df3fc6d6bc4d5d6b172f682c5d;p=jalview.git diff --git a/src/jalview/io/FileFormatI.java b/src/jalview/io/FileFormatI.java index c9d56ae..e6f390d 100644 --- a/src/jalview/io/FileFormatI.java +++ b/src/jalview/io/FileFormatI.java @@ -1,19 +1,63 @@ package jalview.io; +import jalview.datamodel.AlignmentI; + import java.io.IOException; public interface FileFormatI { + AlignmentFileReaderI getReader(FileParse source) throws IOException; - AlignmentFileI getAlignmentFile(String inFile, DataSourceType sourceType) - throws IOException; - - AlignmentFileI getAlignmentFile(FileParse source) throws IOException; - - AlignmentFileI getAlignmentFile(); + AlignmentFileWriterI getWriter(AlignmentI al); boolean isComplexAlignFile(); - String getShortDescription(); - + /** + * Answers the display name of the file format (as for example shown in menu + * options). This name should not be locale (language) dependent. + */ + String getName(); + + /** + * Returns a comma-separated list of file extensions associated with the + * format + * + * @return + */ + String getExtensions(); + + /** + * Answers true if the format is one that Jalview can read. This implies that + * the format provides an implementation for getReader which can parse a data + * source for sequence data. Readable formats are included in the options in + * the open file dialogue. + * + * @return + */ + boolean isReadable(); + + /** + * Answers true if the format is one that Jalview can write. This implies that + * the object returned by getWriter provides an implementation of the print() + * method. Writable formats are included in the options in the Save As file + * dialogue, and the 'output to Textbox' option (if text format). + * + * @return + */ + boolean isWritable(); + + /** + * Answers true if the format is one that Jalview can output as text, e.g. to + * a text box + * + * @return + */ + boolean isTextFormat(); + + /** + * Answers true if the file format is one that provides 3D structure data + * + * @return + */ + boolean isStructureFile(); }