affyfusion-109/src/affymetrix/calvin/parsers/CELFileReader.java

Code
Comments
Other
Rev Date Author Line
11 13 Sep 07 nicklas 1 /////////////////////////////////////////////////////////////////
11 13 Sep 07 nicklas 2 //
11 13 Sep 07 nicklas 3 // Copyright (C) 2005 Affymetrix, Inc.
11 13 Sep 07 nicklas 4 //
11 13 Sep 07 nicklas 5 // This library is free software; you can redistribute it and/or modify
11 13 Sep 07 nicklas 6 // it under the terms of the GNU Lesser General Public License as published
11 13 Sep 07 nicklas 7 // by the Free Software Foundation; either version 2.1 of the License,
11 13 Sep 07 nicklas 8 // or (at your option) any later version.
11 13 Sep 07 nicklas 9 //
11 13 Sep 07 nicklas 10 // This library is distributed in the hope that it will be useful, but
11 13 Sep 07 nicklas 11 // WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
11 13 Sep 07 nicklas 12 // or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
11 13 Sep 07 nicklas 13 // for more details.
11 13 Sep 07 nicklas 14 //
11 13 Sep 07 nicklas 15 // You should have received a copy of the GNU Lesser General Public License
11 13 Sep 07 nicklas 16 // along with this library; if not, write to the Free Software Foundation, Inc.,
11 13 Sep 07 nicklas 17 // 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 
11 13 Sep 07 nicklas 18 //
11 13 Sep 07 nicklas 19 /////////////////////////////////////////////////////////////////
11 13 Sep 07 nicklas 20
11 13 Sep 07 nicklas 21 package affymetrix.calvin.parsers;
11 13 Sep 07 nicklas 22
11 13 Sep 07 nicklas 23 import affymetrix.calvin.data.*;
11 13 Sep 07 nicklas 24
11 13 Sep 07 nicklas 25 /** This class reads a CEL data file. It is an interpreter class.*/
11 13 Sep 07 nicklas 26 public class CELFileReader
11 13 Sep 07 nicklas 27 {
11 13 Sep 07 nicklas 28   /** Constructor */
11 13 Sep 07 nicklas 29   public CELFileReader() {
11 13 Sep 07 nicklas 30             fileName = null;
11 13 Sep 07 nicklas 31         }
11 13 Sep 07 nicklas 32
11 13 Sep 07 nicklas 33   /** Gets the name of the input file.
11 13 Sep 07 nicklas 34    *
11 13 Sep 07 nicklas 35    * @return The name of the file to read.
11 13 Sep 07 nicklas 36    */
11 13 Sep 07 nicklas 37   public String getFilename() { return fileName; }
11 13 Sep 07 nicklas 38
11 13 Sep 07 nicklas 39   /** Sets the name of the input file.
11 13 Sep 07 nicklas 40    *
11 13 Sep 07 nicklas 41    * @param name The name of the file to read.
11 13 Sep 07 nicklas 42    */
11 13 Sep 07 nicklas 43   public void setFilename(String name) { fileName = name; }
11 13 Sep 07 nicklas 44
11 13 Sep 07 nicklas 45   /** Reads the file header of the generic file and reads all the DataSetHeader information.
11 13 Sep 07 nicklas 46    *
11 13 Sep 07 nicklas 47    * @param data A reference to a GenericData object that will receive information from the file.
11 13 Sep 07 nicklas 48    * @exception affymetrix_calvin_exceptions::FileNotFoundException The file does not exist.
11 13 Sep 07 nicklas 49    * @exception affymetrix_calvin_exceptions::InvalidVersionException The file version does not match.
11 13 Sep 07 nicklas 50    * @exception affymetrix_calvin_exceptions::InvalidFileTypeException The file is not of the right type.
11 13 Sep 07 nicklas 51    */
11 13 Sep 07 nicklas 52   public void read(CELData data) throws FileNotFoundException, InvalidVersionException, InvalidFileTypeException {
11 13 Sep 07 nicklas 53             data.clear();
11 13 Sep 07 nicklas 54             GenericFileReader reader = new GenericFileReader();
11 13 Sep 07 nicklas 55             if (fileName == null)
11 13 Sep 07 nicklas 56                 fileName = data.getFilename();
11 13 Sep 07 nicklas 57             reader.setFilename(fileName);
11 13 Sep 07 nicklas 58             reader.readHeader(data.getGenericData(), ReadHeaderOption.ReadAllHeaders);
11 13 Sep 07 nicklas 59         }
11 13 Sep 07 nicklas 60
11 13 Sep 07 nicklas 61   /** Name of the file to read */
11 13 Sep 07 nicklas 62   private String fileName;
11 13 Sep 07 nicklas 63
11 13 Sep 07 nicklas 64 }