X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;ds=inline;f=src%2Fjalview%2Fio%2FIdentifyFile.java;h=4b6f8e40a9b0da997593a5f088033967ebfaf60d;hb=ff8c06845590fd9fd423aa59809dcce9610ab295;hp=7293ac6927a9310c8dc49e54f3ffca815efeb765;hpb=4932106f045349290d58ab38d216dff31fd9afce;p=jalview.git
diff --git a/src/jalview/io/IdentifyFile.java b/src/jalview/io/IdentifyFile.java
index 7293ac6..4b6f8e4 100755
--- a/src/jalview/io/IdentifyFile.java
+++ b/src/jalview/io/IdentifyFile.java
@@ -1,25 +1,26 @@
/*
- * Jalview - A Sequence Alignment Editor and Viewer
- * Copyright (C) 2007 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
*
- * This program is free software; you can redistribute it and/or
+ * 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 2
+ * as published by the Free Software Foundation, either version 3
* of the License, or (at your option) any later version.
*
- * This program 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.
+ * 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 this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
+ * along with Jalview. If not, see .
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
*/
package jalview.io;
-import java.io.*;
-import java.net.*;
+import java.io.IOException;
/**
* DOCUMENT ME!
@@ -30,189 +31,398 @@ import java.net.*;
public class IdentifyFile
{
/**
- * Identify a datasource's file content.
- * @note Do not use this method
- * for stream sources - create a FileParse object instead.
+ * Identify a datasource's file content.
+ *
+ * @note Do not use this method for stream sources - create a FileParse object
+ * instead.
*
- * @param file DOCUMENT ME!
- * @param protocol DOCUMENT ME!
- * @return ID String
+ * @param file
+ * @param sourceType
+ * @return
+ * @throws FileFormatException
*/
- public String Identify(String file, String protocol)
+ public FileFormatI identify(String file, DataSourceType sourceType)
+ throws FileFormatException
{
+ String emessage = "UNIDENTIFIED FILE PARSING ERROR";
FileParse parser = null;
- try {
- parser = new FileParse(file, protocol);
- if (parser.isValid()) {
- return Identify(parser);
+ try
+ {
+ parser = new FileParse(file, sourceType);
+ if (parser.isValid())
+ {
+ return identify(parser);
}
- } catch (Exception e) {
+ } catch (Exception e)
+ {
System.err.println("Error whilst identifying");
e.printStackTrace(System.err);
+ emessage = e.getMessage();
+ }
+ if (parser != null)
+ {
+ throw new FileFormatException(parser.errormessage);
}
- if (parser!=null)
- return parser.errormessage;
- return "UNIDENTIFIED FILE PARSING ERROR";
+ throw new FileFormatException(emessage);
+ }
+
+ public FileFormatI identify(FileParse source) throws FileFormatException
+ {
+ return identify(source, true);
+ // preserves original behaviour prior to version 2.3
}
- public String Identify(FileParse source) {
- return Identify(source, true); // preserves original behaviour prior to version 2.3
+
+ public FileFormatI identify(AlignmentFileReaderI file, boolean closeSource)
+ throws IOException
+ {
+ FileParse fp = new FileParse(file.getInFile(), file.getDataSourceType());
+ return identify(fp, closeSource);
}
+
/**
- * Identify contents of source, closing it or resetting source to start afterwards.
+ * Identify contents of source, closing it or resetting source to start
+ * afterwards.
+ *
* @param source
* @param closeSource
- * @return filetype string
+ * @return (best guess at) file format
+ * @throws FileFormatException
*/
- public String Identify(FileParse source, boolean closeSource) {
- String reply = "PFAM";
+ public FileFormatI identify(FileParse source, boolean closeSource)
+ throws FileFormatException
+ {
+ FileFormatI reply = FileFormat.Pfam;
String data;
- int length=0;
- boolean lineswereskipped=false;
- boolean isBinary = false; // true if length is non-zero and non-printable characters are encountered
- try {
- while ( (data = source.nextLine()) != null)
+ int bytesRead = 0;
+ int trimmedLength = 0;
+ boolean lineswereskipped = false;
+ boolean isBinary = false; // true if length is non-zero and non-printable
+ // characters are encountered
+ try
+ {
+ if (!closeSource)
{
- length+=data.length();
+ source.mark();
+ }
+ while ((data = source.nextLine()) != null)
+ {
+ bytesRead += data.length();
+ trimmedLength += data.trim().length();
if (!lineswereskipped)
{
- for (int i=0;!isBinary && i-1 || fileStr.lastIndexOf(".zip")>-1)
- {
- reply = "Jalview";
- }
- }
- if (!lineswereskipped && data.startsWith("PK")) {
- reply="Jalview"; // archive.
+ String fileStr = source.inFile.getName();
+ // possibly a Jalview archive.
+ if (fileStr.lastIndexOf(".jar") > -1
+ || fileStr.lastIndexOf(".zip") > -1)
+ {
+ reply = FileFormat.Jalview;
+ }
+ }
+ if (!lineswereskipped && data.startsWith("PK"))
+ {
+ reply = FileFormat.Jalview; // archive.
break;
}
}
data = data.toUpperCase();
- if ( (data.indexOf("# STOCKHOLM") > -1))
+ if (data.startsWith(ScoreMatrixFile.SCOREMATRIX))
{
- reply = "STH";
-
+ reply = FileFormat.ScoreMatrix;
break;
}
-
- if ((data.length() < 1) || (data.indexOf("#") == 0))
- {
- lineswereskipped=true;
- continue;
- }
-
- if (data.indexOf("PILEUP") > -1)
+ if (data.startsWith("##GFF-VERSION"))
{
- reply = "PileUp";
-
+ // GFF - possibly embedded in a Jalview features file!
+ reply = FileFormat.Features;
break;
}
-
- if ( (data.indexOf("//") == 0) ||
- ( (data.indexOf("!!") > -1) &&
- (data.indexOf("!!") < data.indexOf(
- "_MULTIPLE_ALIGNMENT "))))
+ if (looksLikeFeatureData(data))
{
- reply = "MSF";
-
+ reply = FileFormat.Features;
break;
}
- else if (data.indexOf("CLUSTAL") > -1)
+ if (data.indexOf("# STOCKHOLM") > -1)
{
- reply = "CLUSTAL";
-
+ reply = FileFormat.Stockholm;
break;
}
- else if ( (data.indexOf(">P1;") > -1) ||
- (data.indexOf(">DL;") > -1))
+ if (data.indexOf("_ENTRY.ID") > -1
+ || data.indexOf("_AUDIT_AUTHOR.NAME") > -1
+ || data.indexOf("_ATOM_SITE.") > -1)
{
- reply = "PIR";
-
+ reply = FileFormat.MMCif;
break;
}
- else if (data.indexOf(">") > -1)
+ // if (data.indexOf(">") > -1)
+ if (data.startsWith(">"))
{
- // could be BLC file, read next line to confirm
+ // FASTA, PIR file or BLC file
+ boolean checkPIR = false, starterm = false;
+ if ((data.indexOf(">P1;") > -1) || (data.indexOf(">DL;") > -1))
+ {
+ // watch for PIR file attributes
+ checkPIR = true;
+ reply = FileFormat.PIR;
+ }
+ // could also be BLC file, read next line to confirm
data = source.nextLine();
if (data.indexOf(">") > -1)
{
- reply = "BLC";
+ reply = FileFormat.BLC;
}
else
{
- //Is this a single line BLC file?
- source.nextLine();
+ // Is this a single line BLC file?
+ String data1 = source.nextLine();
String data2 = source.nextLine();
- if (data2 != null
- && data.indexOf("*") > -1
- && data.indexOf("*") == data2.indexOf("*"))
+ int c1;
+ if (checkPIR)
{
- reply = "BLC";
+ starterm = (data1 != null && data1.indexOf("*") > -1)
+ || (data2 != null && data2.indexOf("*") > -1);
+ }
+ if (data2 != null && (c1 = data.indexOf("*")) > -1)
+ {
+ if (c1 == 0 && c1 == data2.indexOf("*"))
+ {
+ reply = FileFormat.BLC;
+ }
+ else
+ {
+ reply = FileFormat.Fasta; // possibly a bad choice - may be
+ // recognised as
+ // PIR
+ }
+ // otherwise can still possibly be a PIR file
}
else
{
- reply = "FASTA";
+ reply = FileFormat.Fasta;
+ // TODO : AMSA File is indicated if there is annotation in the
+ // FASTA file - but FASTA will automatically generate this at the
+ // mo.
+ if (!checkPIR)
+ {
+ break;
+ }
}
}
+ // final check for PIR content. require
+ // >P1;title\n\nterminated sequence to occur at least once.
+
+ // TODO the PIR/fasta ambiguity may be the use case that is needed to
+ // have
+ // a 'Parse as type XXX' parameter for the applet/application.
+ if (checkPIR)
+ {
+ String dta = null;
+ if (!starterm)
+ {
+ do
+ {
+ try
+ {
+ dta = source.nextLine();
+ } catch (IOException ex)
+ {
+ }
+ if (dta != null && dta.indexOf("*") > -1)
+ {
+ starterm = true;
+ }
+ } while (dta != null && !starterm);
+ }
+ if (starterm)
+ {
+ reply = FileFormat.PIR;
+ break;
+ }
+ else
+ {
+ reply = FileFormat.Fasta; // probably a bad choice!
+ }
+ }
+ // read as a FASTA (probably)
+ break;
+ }
+ int lessThan = data.indexOf("<");
+ if ((lessThan > -1)) // possible Markup Language data i.e HTML,
+ // RNAML, XML
+ {
+ String upper = data.toUpperCase();
+ if (upper.substring(lessThan).startsWith(" -1)
+ {
+ reply = FileFormat.Json;
+ break;
+ }
+ if ((data.length() < 1) || (data.indexOf("#") == 0))
+ {
+ lineswereskipped = true;
+ continue;
+ }
+
+ if (data.indexOf("PILEUP") > -1)
+ {
+ reply = FileFormat.Pileup;
+
+ break;
+ }
+
+ if ((data.indexOf("//") == 0)
+ || ((data.indexOf("!!") > -1) && (data.indexOf("!!") < data
+ .indexOf("_MULTIPLE_ALIGNMENT "))))
+ {
+ reply = FileFormat.MSF;
+
+ break;
+ }
+ else if (data.indexOf("CLUSTAL") > -1)
+ {
+ reply = FileFormat.Clustal;
+
break;
}
- else if (data.indexOf("HEADER") == 0 ||
- data.indexOf("ATOM") == 0)
+
+ else if (data.indexOf("HEADER") == 0 || data.indexOf("ATOM") == 0)
{
- reply = "PDB";
+ reply = FileFormat.PDB;
break;
}
- else if (!lineswereskipped
- && data.charAt(0)!='*'
- && data.charAt(0)!=' '
- && data.indexOf(":") < data.indexOf(",")) // && data.indexOf(",") -1
+ && commaPos > -1 && colonPos < commaPos;
+ // && data.indexOf(",") [ ...]");
}