uk.ac.ebi.adfconverter.common.tools.file.reader
Class PlainTextFileReader

java.lang.Object
  uk.ac.ebi.adfconverter.common.tools.file.reader.ADFConverterFileReaderImpl
      uk.ac.ebi.adfconverter.common.tools.file.reader.PlainTextFileReader

All Implemented Interfaces:

ADFConverterFileReader

Direct Known Subclasses:

PlainTextDataFileReader

public class PlainTextFileReader

extends ADFConverterFileReaderImpl

Interface for all file format classes used in reading data

Version:

$Revision: 1 $ ADF MAGE-TOOL - MicroArray Informatics Team / European Bioinformatics Institute (EBI) ArrayExpress License: ============================================================================== Copyright (c) 2002 The European Bioinformatics Institute. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. The name ArrayExpress must not be used to endorse or promote products derived from this software without prior written permission. For written permission, please contact arrayexpress@ebi.ac.uk 4. Products derived from this software may not be called "ArrayExpress" nor may "ArrayExpress" appear in their names without prior written permission of the ArrayExpress developers. 5. Redistributions of any form whatsoever must retain the following acknowledgment: "This product includes software developed by ArrayExpress (http://www.ebi.ac.uk/arrayexpress)" THIS SOFTWARE IS PROVIDED BY THE ARRAYEXPRESS GROUP ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ARRAYEXPRESS GROUP OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. The European Bioinformatics Institute may publish revised and/or new versions of this license with new releases of ArrayExpress software. ==============================================================================

Author:

Pierre MARGUERITE

See Also:

DataTable

Constructor Summary

PlainTextFileReader(java.io.File datafile)
Contructor for reader of a given plain text file

PlainTextFileReader(java.io.File datafile, java.lang.String enc)
Contructor for reader of a given plain text file following a given encoding

Method Summary

void	closeFile() Closes a data text file.
DataBuffer	getLine() Retrieves a line from a data file Only when termination requirements have been met, the method should return a String object.
void	openFile() Opens a data file for reading or writing

Methods inherited from class uk.ac.ebi.adfconverter.common.tools.file.reader.ADFConverterFileReaderImpl

clear, finalize, getLineNumber

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PlainTextFileReader

public PlainTextFileReader(java.io.File datafile)

Contructor for reader of a given plain text file

Parameters:

datafile - the plain text file to read

PlainTextFileReader

public PlainTextFileReader(java.io.File datafile,
                           java.lang.String enc)

Contructor for reader of a given plain text file following a given encoding

Parameters:

datafile - the plain text file to read

enc - a character encoding for file reading

Method Detail

closeFile

public void closeFile()

Closes a data text file.

Specified by:

closeFile in interface ADFConverterFileReader

Specified by:

closeFile in class ADFConverterFileReaderImpl

getLine

public DataBuffer getLine()
                   throws java.io.IOException

Retrieves a line from a data file Only when termination requirements have been met, the method should return a String object.

Specified by:

getLine in interface ADFConverterFileReader

Specified by:

getLine in class ADFConverterFileReaderImpl

Returns:

line containing data items in one String

Throws:

java.io.IOException

openFile

public void openFile()
              throws java.io.IOException

Opens a data file for reading or writing

Specified by:

openFile in interface ADFConverterFileReader

Specified by:

openFile in class ADFConverterFileReaderImpl

Throws:

java.io.IOException - if an error occurs