uk.ac.ebi.adfconverter.common.tools.file.converter
Interface TextLineConverter

public interface TextLineConverter

Interface for converting file line in 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

Method Summary

DataRow	convertLine(DataBuffer line) Converts a line of data into a DataRow object which contains each data item in individual cells.
DataRow	convertLine(DataBuffer line, int length) Converts a line of data into a DataRow object which contains each data item in individual cells.
DataRow	convertLine(java.lang.String line) Converts a line of data into a DataRow object which contains each data item in individual cells.
DataRow	convertLine(java.lang.String line, int length) Converts a line of data into a DataRow object which contains each data item in individual cells.
DataBuffer	format(DataRow row) Formats the data contained in the DataRow object into a line of data following the text file format.
DataBuffer	format(DataTableHeader header) Formats the header item list object into a line of data following the text file format.

Method Detail

convertLine

public DataRow convertLine(DataBuffer line)

Converts a line of data into a DataRow object which contains each data item in individual cells. If the line of data does not terminate properly, the method must return null and keep the currently parsed row in memory for further processing. Only when termination requirements have been met, the method should return a DataRow object.

Parameters:

line - line containing data items.

Returns:

a DataRow object containing data items in individual cells.

convertLine

public DataRow convertLine(DataBuffer line,
                           int length)

Converts a line of data into a DataRow object which contains each data item in individual cells. If the line of data does not terminate properly, the method must return null and keep the currently parsed row in memory for further processing. Only when termination requirements have been met, the method should return a DataRow object.

Parameters:

line - line containing data items.

length - the maximal size of the row

Returns:

a DataRow object containing data items in individual cells.

convertLine

public DataRow convertLine(java.lang.String line)

Converts a line of data into a DataRow object which contains each data item in individual cells. If the line of data does not terminate properly, the method must return null and keep the currently parsed row in memory for further processing. Only when termination requirements have been met, the method should return a DataRow object.

Parameters:

line - line containing data items.

Returns:

a DataRow object containing data items in individual cells.

convertLine

public DataRow convertLine(java.lang.String line,
                           int length)

Converts a line of data into a DataRow object which contains each data item in individual cells. If the line of data does not terminate properly, the method must return null and keep the currently parsed row in memory for further processing. Only when termination requirements have been met, the method should return a DataRow object.

Parameters:

line - line containing data items.

length - the maximal size of the row

Returns:

a DataRow object containing data items in individual cells.

format

public DataBuffer format(DataRow row)

Formats the data contained in the DataRow object into a line of data following the text file format.

Parameters:

row - a DataRow object containing data

Returns:

String representing data items contained in DataRow object.

format

public DataBuffer format(DataTableHeader header)

Formats the header item list object into a line of data following the text file format.

Parameters:

header - a DataTableHeader object containing header data

Returns:

String representing header items contained in DataTableHeader object.