/*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
- * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, 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 <http://www.gnu.org/licenses/>.
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview. If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
*/
package jalview.io;
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;
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 javax.xml.parsers.ParserConfigurationException;
-
-import org.xml.sax.SAXException;
-
-import fr.orsay.lri.varna.exceptions.ExceptionFileFormatOrSyntax;
-import fr.orsay.lri.varna.exceptions.ExceptionLoadingFailed;
-import fr.orsay.lri.varna.exceptions.ExceptionPermissionDenied;
-
/**
* DOCUMENT ME!
*
/**
* annotation to be added to generated alignment object
*/
- protected Vector annotations;
+ protected Vector<AlignmentAnnotation> annotations;
+
+ /**
+ * SequenceGroups to be added to the alignment object
+ */
+ protected List<SequenceGroup> seqGroups;
/**
* Properties to be added to generated alignment object
boolean jvSuffix = true;
+ private boolean parseCalled;
+
/**
* Creates a new AlignFile object.
*/
public AlignFile()
{
- // Shouldn't we init data structures
- 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();
}
/**
* Filename to read from.
* @param type
* What type of file to read from (File, URL)
- * @throws SAXException
- * @throws ParserConfigurationException
- * @throws ExceptionFileFormatOrSyntax
- * @throws ExceptionLoadingFailed
- * @throws ExceptionPermissionDenied
*/
- public AlignFile(String inFile, String type) throws IOException, ExceptionFileFormatOrSyntax, ParserConfigurationException, SAXException, ExceptionPermissionDenied, ExceptionLoadingFailed
+ 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.
*
* @param source
* @throws IOException
- * @throws SAXException
- * @throws ParserConfigurationException
- * @throws ExceptionFileFormatOrSyntax
- * @throws ExceptionLoadingFailed
- * @throws ExceptionPermissionDenied
*/
- public AlignFile(FileParse source) throws IOException, ExceptionFileFormatOrSyntax, ParserConfigurationException, SAXException, ExceptionPermissionDenied, ExceptionLoadingFailed
+ 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++ ) {
- seqs.get(i).setIndex(i);
+ for (int i = 0, c = seqs.size(); i < c; i++)
+ {
+ seqs.get(i).setIndex(i);
}
}
+
/**
* Return the seqs Vector
*/
return seqs;
}
+ public List<SequenceGroup> getSeqGroups()
+ {
+ return seqGroups;
+ }
+
/**
* Return the Sequences in the seqs Vector as an array of Sequences
*/
for (int i = 0; i < seqs.size(); i++)
{
- s[i] = (SequenceI) seqs.elementAt(i);
+ s[i] = seqs.elementAt(i);
}
return s;
* Rna.GetBasePairsFromAlignmentAnnotation(annotations.elementAt(i));
* Rna.HelixMap(pairArray);
*/
- AlignmentAnnotation an = (AlignmentAnnotation) annotations
+ AlignmentAnnotation an = annotations
.elementAt(i);
an.validateRangeAndDisplay();
al.addAnnotation(an);
}
+ public void addSeqGroups(AlignmentI al)
+ {
+ this.seqGroups = al.getGroups();
+
+ }
+
/**
* Add any additional information extracted from the file to the alignment
* properties.
{
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)
{
*/
protected void initData()
{
- seqs = new Vector();
- annotations = new Vector();
+ seqs = new Vector<SequenceI>();
+ annotations = new Vector<AlignmentAnnotation>();
+ seqGroups = new ArrayList<SequenceGroup>();
+ parseCalled=false;
}
/**
*/
protected void setSeqs(SequenceI[] s)
{
- seqs = new Vector();
+ seqs = new Vector<SequenceI>();
for (int i = 0; i < s.length; i++)
{
/**
* This method must be implemented to parse the contents of the file.
- * @throws ExceptionFileFormatOrSyntax
- * @throws SAXException
- * @throws ParserConfigurationException
- * @throws ExceptionLoadingFailed
- * @throws ExceptionPermissionDenied
*/
- public abstract void parse() throws IOException, ExceptionFileFormatOrSyntax, ParserConfigurationException, SAXException, ExceptionPermissionDenied, ExceptionLoadingFailed;
+ public abstract void parse() throws IOException;
/**
* Print out in alignment file format the Sequences in the seqs Vector.
/**
* vector of String[] treeName, newickString pairs
*/
- Vector newickStrings = null;
+ Vector<String[]> newickStrings = null;
protected void addNewickTree(String treeName, String newickString)
{
if (newickStrings == null)
{
- newickStrings = new Vector();
+ newickStrings = new Vector<String[]>();
}
newickStrings.addElement(new String[]
{ treeName, newickString });
protected int getTreeCount()
{
- if (newickStrings == null)
- {
- return 0;
- }
- return newickStrings.size();
+ return newickStrings == null ? 0 : newickStrings.size();
}
}
git://source.jalview.org / jalview.git / blobdiff