uk.ac.ebi.adfconverter.common.data.tabulardata
Class CorrectableDataTable

java.lang.Object
  uk.ac.ebi.adfconverter.common.data.tabulardata.DataTable
      uk.ac.ebi.adfconverter.common.data.tabulardata.CorrectableDataTable

public class CorrectableDataTable

extends DataTable

Object representing a collection of dataRow

Version:

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

Field Summary

Fields inherited from class uk.ac.ebi.adfconverter.common.data.tabulardata.DataTable

HORIZONTALTABLE, TEXTFILE, UNKNOWNFILE, VERTICALTABLE, WORKBOOKFILE

Constructor Summary

CorrectableDataTable()
Creates a new CorrectableDataTable instance.

CorrectableDataTable(java.io.File file)
Creates a new CorrectableDataTable instance.

CorrectableDataTable(java.lang.String enc, java.io.File file)
Creates a new CorrectableDataTable instance.

Method Summary

void	clear() Clears the current object, the datatable.
boolean	containsHeader() Checks if header indicator has been turned on using containsHeader(boolean). .
void	containsHeader(boolean _header) Sets the indicator for header row.
DataTableHeader	getHeader() Retrieves table header
void	setHeader(CorrectableDataTableHeader header) sets the header of the table
java.lang.String	toString() represents the table as String

Methods inherited from class uk.ac.ebi.adfconverter.common.data.tabulardata.DataTable

addRow, contains, getEnc, getFile, getFileFormat, getFileName, getFilePath, getFileType, getFormat, getHorizontalOrientation, getOrientation, getRow, getRows, getTableOrientationFormat, getTextFile, getUnknownFileFormat, getVerticalOrientation, getWorkBookFile, hasNext, InitNextRow, isEmpty, nextRow, removeRow, removeRow, setFile, setFileName, setFileType, setFormat, setHeader, setOrientation, size

Methods inherited from class java.lang.Object

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

Constructor Detail

CorrectableDataTable

public CorrectableDataTable()

Creates a new CorrectableDataTable instance. with the default character encoding

CorrectableDataTable

public CorrectableDataTable(java.io.File file)

Creates a new CorrectableDataTable instance. with a default character encoding

Parameters:

file - an File value: the file containing this data

CorrectableDataTable

public CorrectableDataTable(java.lang.String enc,
                            java.io.File file)

Creates a new CorrectableDataTable instance.

Parameters:

enc - a String value: Java character encoding in which the data strings are written.

file - an File value: the file containing this data

Method Detail

clear

public void clear()

Clears the current object, the datatable. removes the header and rows

Overrides:

clear in class DataTable

containsHeader

public boolean containsHeader()

Checks if header indicator has been turned on using containsHeader(boolean). .

Overrides:

containsHeader in class DataTable

Returns:

True, if table header indicator has been set to true. False, otherwise.

containsHeader

public void containsHeader(boolean _header)

Sets the indicator for header row.

Overrides:

containsHeader in class DataTable

Parameters:

_header - True if the table contains a header row. False, otherwise.

getHeader

public DataTableHeader getHeader()

Retrieves table header

Overrides:

getHeader in class DataTable

Returns:

the header table

setHeader

public void setHeader(CorrectableDataTableHeader header)

sets the header of the table

Parameters:

header - the header table

toString

public java.lang.String toString()

represents the table as String

Overrides:

toString in class DataTable

Returns:

a String representation of the table