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

java.lang.Object
  uk.ac.ebi.adfconverter.common.data.tabulardata.DataTableHeader
      uk.ac.ebi.adfconverter.common.data.tabulardata.CorrectableDataTableHeader

public class CorrectableDataTableHeader

extends DataTableHeader

This Class represents the list of data table headers which can be modify

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

Constructor Summary

CorrectableDataTableHeader()
Constructor of the headerItem class

CorrectableDataTableHeader(int capacity)
Constructor of the headerItem class with an initial capacity for the header list

Method Summary

void	addItem(CorrectableHeaderItem item) Adds an item to the header list
void	addItem(CorrectableHeaderItem item, int index) Adds an item to the header list
int	getFirstItemColumnByType(java.lang.String itemType) retrieve the column of the first item in the header list with a given type
java.util.ArrayList	getItemColumnByFieldType(java.lang.String fieldType) retrieve all items from the header list with a given field type
java.util.ArrayList	getItemColumnByType(java.lang.String itemType) retrieve all items from the header list with a given type
java.util.ArrayList	getItemsByLabel(java.lang.String label) retrieve all items from the header list with a given label
void	removeItem(CorrectableHeaderItem item) Removes an given item from the header list
void	removeItem(int index) Removes an item at a given position from the header list

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

addItem, addItem, clear, contains, getItem, getItem, getItemColumn, getItemColumnByLabel, getItems, getLineNumber, InitNextItem, nextItem, removeItem, setLineNumber, size, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CorrectableDataTableHeader

public CorrectableDataTableHeader()

Constructor of the headerItem class

CorrectableDataTableHeader

public CorrectableDataTableHeader(int capacity)

Constructor of the headerItem class with an initial capacity for the header list

Parameters:

capacity - the initial capacity of the list

Method Detail

addItem

public void addItem(CorrectableHeaderItem item)

Adds an item to the header list

Parameters:

item - the new item to add

addItem

public void addItem(CorrectableHeaderItem item,
                    int index)

Adds an item to the header list

Parameters:

item - the new item to add

index - the position of the item in the header file

getFirstItemColumnByType

public int getFirstItemColumnByType(java.lang.String itemType)

retrieve the column of the first item in the header list with a given type

Parameters:

itemType - the type of wanted items

Returns:

the position in the header of the first found Item by it item type

getItemColumnByFieldType

public java.util.ArrayList getItemColumnByFieldType(java.lang.String fieldType)

retrieve all items from the header list with a given field type

Parameters:

fieldType - the field type of wanted items

Returns:

the list of items with the specified field type

getItemColumnByType

public java.util.ArrayList getItemColumnByType(java.lang.String itemType)

retrieve all items from the header list with a given type

Parameters:

itemType - the type of wanted items

Returns:

the list of items with the specified type

getItemsByLabel

public java.util.ArrayList getItemsByLabel(java.lang.String label)

retrieve all items from the header list with a given label

Parameters:

label - the label of wanted items

Returns:

the list of items with the specified label

removeItem

public void removeItem(CorrectableHeaderItem item)

Removes an given item from the header list

Parameters:

item - the new item to remove

removeItem

public void removeItem(int index)

Removes an item at a given position from the header list

Overrides:

removeItem in class DataTableHeader

Parameters:

index - the item position