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

java.lang.Object
  uk.ac.ebi.adfconverter.common.data.tabulardata.HeaderItem

Direct Known Subclasses:

CorrectableHeaderItem

public class HeaderItem

extends java.lang.Object

This class represents an header item of a data table

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

Constructor Summary

HeaderItem()
Class contructor : creates an instance for convenience (empty constructor)

HeaderItem(java.lang.String name)
Class contructor : creates an instance with a given name of item

HeaderItem(java.lang.String name, int column)
Class contructor : creates an instance with a given name of item and a given column number

Method Summary

void	clear() Clears the object
boolean	equals(java.lang.Object o) Compares the object with another one mainly for searching in the headerlist
int	getColumnNumber() retrieves the column number of the item
java.lang.String	getName() retrieves the name of the item
java.lang.String	toString() Transforms object in String

Methods inherited from class java.lang.Object

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

Constructor Detail

HeaderItem

public HeaderItem()

Class contructor : creates an instance for convenience (empty constructor)

HeaderItem

public HeaderItem(java.lang.String name)

Class contructor : creates an instance with a given name of item

Parameters:

name - the name of the item

HeaderItem

public HeaderItem(java.lang.String name,
                  int column)

Class contructor : creates an instance with a given name of item and a given column number

Parameters:

name - the name of the item

column - the item column number

Method Detail

clear

public void clear()

Clears the object

equals

public boolean equals(java.lang.Object o)

Compares the object with another one mainly for searching in the headerlist

Parameters:

o - the wanted object to be compared

Returns:

a boolean indicating if the given object is equal to this one.

getColumnNumber

public int getColumnNumber()

retrieves the column number of the item

Returns:

the column number of this item

getName

public java.lang.String getName()

retrieves the name of the item

Returns:

the name of this item

toString

public java.lang.String toString()

Transforms object in String

Returns:

a string representation of the item