JAL-161 JAL-4173 allow trees embedded as NH tags in stockholm to be loaded as trees...

[jalview.git] / src / jalview / io / AlignFile.java

diff --git a/src/jalview/io/AlignFile.java b/src/jalview/io/AlignFile.java
index d333c64..1bea24b 100755 (executable)
--- a/src/jalview/io/AlignFile.java
+++ b/src/jalview/io/AlignFile.java
@@ -20,13 +20,6 @@
  */
 package jalview.io;
 
-import jalview.datamodel.AlignmentAnnotation;
-import jalview.datamodel.AlignmentI;
-import jalview.datamodel.Sequence;
-import jalview.datamodel.SequenceGroup;
-import jalview.datamodel.SequenceI;
-import jalview.util.MessageManager;
-
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Enumeration;
@@ -34,13 +27,22 @@ import java.util.Hashtable;
 import java.util.List;
 import java.util.Vector;
 
+import jalview.datamodel.AlignmentAnnotation;
+import jalview.datamodel.AlignmentI;
+import jalview.datamodel.Sequence;
+import jalview.datamodel.SequenceGroup;
+import jalview.datamodel.SequenceI;
+import jalview.util.MessageManager;
+import jalview.util.StringUtils;
+
 /**
  * DOCUMENT ME!
  * 
  * @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,13 +67,28 @@ 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;
 
-  private boolean parseCalled;
+  /**
+   * true if parse() has been called
+   */
+  private boolean parseCalled = false;
+
+  private boolean parseImmediately = true;
+
+  private boolean dataClosed = false;
+
+  /**
+   * @return if doParse() was called at construction time
+   */
+  protected boolean isParseImmediately()
+  {
+    return parseImmediately;
+  }
 
   /**
    * Creates a new AlignFile object.
@@ -98,7 +115,7 @@ public abstract class AlignFile extends FileParse implements AlignmentFileI
    * @param sourceType
    *          What type of file to read from (File, URL, Pasted String)
    */
-  public AlignFile(String dataObject, DataSourceType sourceType)
+  public AlignFile(Object dataObject, DataSourceType sourceType)
           throws IOException
   {
     this(true, dataObject, sourceType);
@@ -116,10 +133,10 @@ public abstract class AlignFile extends FileParse implements AlignmentFileI
    *          What type of file to read from (File, URL)
    * @throws IOException
    */
-  public AlignFile(boolean parseImmediately, String dataObject,
-          DataSourceType sourceType)
-          throws IOException
+  public AlignFile(boolean parseImmediately, Object dataObject,
+          DataSourceType sourceType) throws IOException
   {
+    // BH allows File or String
     super(dataObject, sourceType);
     initData();
     if (parseImmediately)
@@ -151,11 +168,22 @@ public abstract class AlignFile extends FileParse implements AlignmentFileI
   public AlignFile(boolean parseImmediately, FileParse source)
           throws IOException
   {
+    this(parseImmediately, source, true);
+  }
+
+  public AlignFile(boolean parseImmediately, FileParse source,
+          boolean closeData) throws IOException
+  {
     super(source);
     initData();
+
+    // stash flag in case parse needs to know if it has to autoconfigure or was
+    // configured after construction
+    this.parseImmediately = parseImmediately;
+
     if (parseImmediately)
     {
-      doParse();
+      doParse(closeData);
     }
   }
 
@@ -166,6 +194,11 @@ public abstract class AlignFile extends FileParse implements AlignmentFileI
    */
   public void doParse() throws IOException
   {
+    doParse(true);
+  }
+
+  public void doParse(boolean closeData) throws IOException
+  {
     if (parseCalled)
     {
       throw new IOException(
@@ -174,10 +207,10 @@ 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++)
+    if (closeData && !dataClosed)
     {
-      seqs.get(i).setIndex(i);
+      dataIn.close();
+      dataClosed = true;
     }
   }
 
@@ -281,9 +314,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)
     {
@@ -347,7 +379,7 @@ public abstract class AlignFile extends FileParse implements AlignmentFileI
   {
     Sequence seq = null;
     id = id.trim();
-    int space = id.indexOf(" ");
+    int space = StringUtils.indexOfFirstWhitespace(id);
     if (space > -1)
     {
       seq = new Sequence(id.substring(0, space), "");
@@ -401,12 +433,24 @@ public abstract class AlignFile extends FileParse implements AlignmentFileI
     newickStrings.addElement(new String[] { treeName, newickString });
   }
 
-  protected int getTreeCount()
+  @Override
+  public int getTreeCount()
   {
     return newickStrings == null ? 0 : newickStrings.size();
   }
 
   @Override
+  public boolean hasTrees()
+  {
+    return getTreeCount()>0;
+  }
+  
+  @Override
+  public List<String[]> getNewickTrees()
+  {
+    return newickStrings;
+  }
+  @Override
   public void addGroups(AlignmentI al)
   {
 
@@ -416,4 +460,8 @@ public abstract class AlignFile extends FileParse implements AlignmentFileI
     }
   }
 
+  protected void addSequence(SequenceI seq)
+  {
+    seqs.add(seq);
+  }
 }