JAL-2909 Wire up coordinates dialog with bam file reader
[jalview.git] / src / jalview / io / AlignFile.java
index 6d6ab5c..c931cb8 100755 (executable)
@@ -40,7 +40,8 @@ import java.util.Vector;
  * @author $author$
  * @version $Revision$
  */
-public abstract class AlignFile extends FileParse implements AlignmentFileI
+public abstract class AlignFile extends FileParse
+        implements AlignmentFileReaderI, AlignmentFileWriterI
 {
   int noSeqs = 0;
 
@@ -65,14 +66,12 @@ public abstract class AlignFile extends FileParse implements AlignmentFileI
   /**
    * Properties to be added to generated alignment object
    */
-  protected Hashtable properties;
+  private Hashtable properties;
 
   long start;
 
   long end;
 
-  boolean jvSuffix = true;
-
   private boolean parseCalled;
 
   /**
@@ -86,6 +85,12 @@ public abstract class AlignFile extends FileParse implements AlignmentFileI
     initData();
   }
 
+  public AlignFile(SequenceI[] seqs)
+  {
+    this();
+    setSeqs(seqs);
+  }
+
   /**
    * Constructor which parses the data from a file of some specified type.
    * 
@@ -113,8 +118,7 @@ public abstract class AlignFile extends FileParse implements AlignmentFileI
    * @throws IOException
    */
   public AlignFile(boolean parseImmediately, String dataObject,
-          DataSourceType sourceType)
-          throws IOException
+          DataSourceType sourceType) throws IOException
   {
     super(dataObject, sourceType);
     initData();
@@ -170,11 +174,6 @@ public abstract class AlignFile extends FileParse implements AlignmentFileI
     }
     parseCalled = true;
     parse();
-    // sets the index of each sequence in the alignment
-    for (int i = 0, c = seqs.size(); i < c; i++)
-    {
-      seqs.get(i).setIndex(i);
-    }
   }
 
   /**
@@ -277,9 +276,8 @@ public abstract class AlignFile extends FileParse implements AlignmentFileI
   {
     if (key == null)
     {
-      throw new Error(
-              MessageManager
-                      .getString("error.implementation_error_cannot_have_null_alignment"));
+      throw new Error(MessageManager.getString(
+              "error.implementation_error_cannot_have_null_alignment"));
     }
     if (value == null)
     {
@@ -306,9 +304,9 @@ public abstract class AlignFile extends FileParse implements AlignmentFileI
    */
   protected void initData()
   {
-    seqs = new Vector<SequenceI>();
-    annotations = new Vector<AlignmentAnnotation>();
-    seqGroups = new ArrayList<SequenceGroup>();
+    seqs = new Vector<>();
+    annotations = new Vector<>();
+    seqGroups = new ArrayList<>();
     parseCalled = false;
   }
 
@@ -321,7 +319,7 @@ public abstract class AlignFile extends FileParse implements AlignmentFileI
   @Override
   public void setSeqs(SequenceI[] s)
   {
-    seqs = new Vector<SequenceI>();
+    seqs = new Vector<>();
 
     for (int i = 0; i < s.length; i++)
     {
@@ -335,18 +333,6 @@ public abstract class AlignFile extends FileParse implements AlignmentFileI
   public abstract void parse() throws IOException;
 
   /**
-   * Print out in alignment file format the Sequences in the seqs Vector.
-   */
-  @Override
-  public abstract String print();
-
-  @Override
-  public void addJVSuffix(boolean b)
-  {
-    jvSuffix = b;
-  }
-
-  /**
    * A general parser for ids.
    * 
    * @String id Id to be parsed
@@ -378,14 +364,21 @@ public abstract class AlignFile extends FileParse implements AlignmentFileI
   }
 
   /**
-   * Creates the output id. Adds prefix Uniprot format source|id And suffix
-   * Jalview /start-end
+   * Creates the output id. Adds prefix Uniprot format source|id and optionally
+   * suffix Jalview /start-end
+   * 
+   * @param jvsuffix
    * 
    * @String id Id to be parsed
    */
+  String printId(SequenceI seq, boolean jvsuffix)
+  {
+    return seq.getDisplayId(jvsuffix);
+  }
+
   String printId(SequenceI seq)
   {
-    return seq.getDisplayId(jvSuffix);
+    return printId(seq, true);
   }
 
   /**
@@ -397,7 +390,7 @@ public abstract class AlignFile extends FileParse implements AlignmentFileI
   {
     if (newickStrings == null)
     {
-      newickStrings = new Vector<String[]>();
+      newickStrings = new Vector<>();
     }
     newickStrings.addElement(new String[] { treeName, newickString });
   }
@@ -417,4 +410,17 @@ public abstract class AlignFile extends FileParse implements AlignmentFileI
     }
   }
 
+  protected void addSequence(SequenceI seq)
+  {
+    seqs.add(seq);
+  }
+
+  @Override
+  public Object[] preprocess()
+  {
+    // most AlignFiles will not need to return any preprocessing information
+    // those that do should override this method
+    return null;
+  }
+
 }