X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2Fjalview%2Fio%2FAlignFile.java;h=5d8a29784e718d4f80c76e29d77a71f5f68cecfd;hb=b8f13fd9ac44853d6510eac85edb60b117dc4620;hp=81d0ae48a503265a04942f4c41b7490de6b9cc53;hpb=2bd43f464e725844b02a106c2d2f187c2c3655a6;p=jalview.git diff --git a/src/jalview/io/AlignFile.java b/src/jalview/io/AlignFile.java index 81d0ae4..5d8a297 100755 --- a/src/jalview/io/AlignFile.java +++ b/src/jalview/io/AlignFile.java @@ -1,32 +1,40 @@ /* - * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8) - * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle + * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$) + * Copyright (C) $$Year-Rel$$ The Jalview Authors * * This file is part of Jalview. * * Jalview is free software: you can redistribute it and/or * modify it under the terms of the GNU General Public License - * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. + * as published by the Free Software Foundation, either version 3 + * of the License, or (at your option) any later version. * * Jalview is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty * of MERCHANTABILITY or FITNESS FOR A PARTICULAR * PURPOSE. See the GNU General Public License for more details. * - * You should have received a copy of the GNU General Public License along with Jalview. If not, see . + * You should have received a copy of the GNU General Public License + * along with Jalview. If not, see . + * The Jalview Authors are detailed in the 'AUTHORS' file. */ package jalview.io; -import jalview.datamodel.Alignment; -import jalview.datamodel.AlignmentAnnotation; -import jalview.datamodel.Sequence; -import jalview.datamodel.SequenceI; - import java.io.IOException; +import java.util.ArrayList; import java.util.Enumeration; import java.util.Hashtable; +import java.util.List; import java.util.Vector; +import jalview.datamodel.Alignment; +import jalview.datamodel.AlignmentAnnotation; +import jalview.datamodel.AlignmentI; +import jalview.datamodel.Sequence; +import jalview.datamodel.SequenceGroup; +import jalview.datamodel.SequenceI; +import jalview.util.MessageManager; + /** * DOCUMENT ME! * @@ -47,7 +55,12 @@ public abstract class AlignFile extends FileParse /** * annotation to be added to generated alignment object */ - protected Vector annotations; + protected Vector annotations; + + /** + * SequenceGroups to be added to the alignment object + */ + protected List seqGroups; /** * Properties to be added to generated alignment object @@ -60,13 +73,17 @@ public abstract class AlignFile extends FileParse boolean jvSuffix = true; + private boolean parseCalled; + /** * Creates a new AlignFile object. */ public AlignFile() { - // Shouldn't we init data structures (JBPNote: not sure - initData is for initialising the structures used for reading from a datasource, and the bare constructor hasn't got any datasource) - initData(); + // Shouldn't we init data structures (JBPNote: not sure - initData is for + // initialising the structures used for reading from a datasource, and the + // bare constructor hasn't got any datasource) + initData(); } /** @@ -79,16 +96,28 @@ public abstract class AlignFile extends FileParse */ public AlignFile(String inFile, String type) throws IOException { + this(true, inFile, type); + } + + /** + * Constructor which (optionally delays) parsing of data from a file of some specified type. + * + * @param parseImmediately + * if false, need to call 'doParse()' to begin parsing data + * @param inFile + * Filename to read from. + * @param type + * What type of file to read from (File, URL) + * @throws IOException + */ + public AlignFile(boolean parseImmediately, String inFile, String type) throws IOException + { super(inFile, type); initData(); - 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); + if (parseImmediately) { + doParse(); } } - /** * Attempt to read from the position where some other parsing process left * off. @@ -98,8 +127,36 @@ public abstract class AlignFile extends FileParse */ public AlignFile(FileParse source) throws IOException { + this(true,source); + } + /** + * Construct a new parser to read from the position where some other parsing process left + * + * @param parseImmediately + * if false, need to call 'doParse()' to begin parsing data + * @param source + */ + public AlignFile(boolean parseImmediately, FileParse source) throws IOException + { super(source); initData(); + if (parseImmediately) { + doParse(); + } + } + /** + * called if parsing was delayed till after parser was constructed + * @throws IOException + */ + public void doParse() throws IOException + { + if (parseCalled) + { + throw new IOException( + "Implementation error: Parser called twice for same data.\n" + + "Need to call initData() again before parsing can be reattempted."); + } + parseCalled=true; parse(); // sets the index of each sequence in the alignment for (int i = 0, c = seqs.size(); i < c; i++) @@ -108,6 +165,7 @@ public abstract class AlignFile extends FileParse } } + /** * Return the seqs Vector */ @@ -116,6 +174,11 @@ public abstract class AlignFile extends FileParse return seqs; } + public List getSeqGroups() + { + return seqGroups; + } + /** * Return the Sequences in the seqs Vector as an array of Sequences */ @@ -125,7 +188,7 @@ public abstract class AlignFile extends FileParse for (int i = 0; i < seqs.size(); i++) { - s[i] = (SequenceI) seqs.elementAt(i); + s[i] = seqs.elementAt(i); } return s; @@ -149,7 +212,7 @@ public abstract class AlignFile extends FileParse * Rna.GetBasePairsFromAlignmentAnnotation(annotations.elementAt(i)); * Rna.HelixMap(pairArray); */ - AlignmentAnnotation an = (AlignmentAnnotation) annotations + AlignmentAnnotation an = annotations .elementAt(i); an.validateRangeAndDisplay(); al.addAnnotation(an); @@ -157,6 +220,12 @@ public abstract class AlignFile extends FileParse } + public void addSeqGroups(AlignmentI al) + { + this.seqGroups = al.getGroups(); + + } + /** * Add any additional information extracted from the file to the alignment * properties. @@ -191,8 +260,7 @@ public abstract class AlignFile extends FileParse { if (key == null) { - throw new Error( - "Implementation error: Cannot have null alignment property key."); + throw new Error(MessageManager.getString("error.implementation_error_cannot_have_null_alignment")); } if (value == null) { @@ -219,8 +287,10 @@ public abstract class AlignFile extends FileParse */ protected void initData() { - seqs = new Vector(); - annotations = new Vector(); + seqs = new Vector(); + annotations = new Vector(); + seqGroups = new ArrayList(); + parseCalled=false; } /** @@ -231,7 +301,7 @@ public abstract class AlignFile extends FileParse */ protected void setSeqs(SequenceI[] s) { - seqs = new Vector(); + seqs = new Vector(); for (int i = 0; i < s.length; i++) { @@ -291,13 +361,13 @@ public abstract class AlignFile extends FileParse /** * vector of String[] treeName, newickString pairs */ - Vector newickStrings = null; + Vector newickStrings = null; protected void addNewickTree(String treeName, String newickString) { if (newickStrings == null) { - newickStrings = new Vector(); + newickStrings = new Vector(); } newickStrings.addElement(new String[] { treeName, newickString }); @@ -305,11 +375,7 @@ public abstract class AlignFile extends FileParse protected int getTreeCount() { - if (newickStrings == null) - { - return 0; - } - return newickStrings.size(); + return newickStrings == null ? 0 : newickStrings.size(); } }