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

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

public class CorrectableHeaderItem

extends HeaderItem

This class represents an header item of a data table which can be use for correct table following a structure

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

CorrectableHeaderItem()
Class contructor : creates an instance without name of item or column number name and column number must be set later

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

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

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

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

CorrectableHeaderItem(java.lang.String name, java.lang.String initialName, java.lang.String type, int column)
Class contructor : creates an instance with a given name of item

CorrectableHeaderItem(java.lang.String name, java.lang.String initialName, java.lang.String type, int column, java.lang.String subName)
Class contructor : creates an instance with a given name of item

Method Summary

void	clear() Clears th CorrectableHeaderItem object
boolean	equals(java.lang.Object o) Compares the object with another one mainly for searching in the headerlist
java.lang.String	getDataDelimiter() Retrieves the value delimiter of the item
java.lang.String	getFieldType() Retrieves the fieldtype of the item
java.lang.String	getInitialName() Retrieves the initial name of the item
java.lang.String	getPrefixSubName() Retreives the prefix delimiter for subname
java.lang.String	getSubName() Retrieves the subname of the item
java.lang.String	getSuffixSubName() Retrieves the suffix delimiter for subname
java.lang.String	getType() Retrieves the type of the item
java.lang.String	getValueDelimiter() Retrieves the inner value delimiter of the item
void	setDataDelimiter(java.lang.String _dataDelimiter) sets the datadelimiter of the item in case of multiple values in the field
void	setFieldType(java.lang.String _fieldType) sets the field type of the item
void	setName(java.lang.String _name) Sets the name of the item
void	setPrefixSubName(java.lang.String _prefix) Set the prefix delimiter for subname
void	setSubName(java.lang.String _name) sets the subname of the item
void	setSuffixSubName(java.lang.String _suffix) Set the suffix delimiter for subname
void	setType(java.lang.String _type) Sets the type of the item
void	setValueDelimiter(java.lang.String _valueDelimiter) sets the valuedelimiter of the item in case of multiple component of a value
java.lang.String	toString() Transforms object in String

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

getColumnNumber, getName

Methods inherited from class java.lang.Object

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

Constructor Detail

CorrectableHeaderItem

public CorrectableHeaderItem()

Class contructor : creates an instance without name of item or column number name and column number must be set later

CorrectableHeaderItem

public CorrectableHeaderItem(CorrectableHeaderItem item,
                             java.lang.String name,
                             java.lang.String type)

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

Parameters:

item - the item to correct

name - the name of the item before correction

type - the type of the item

CorrectableHeaderItem

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

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

Parameters:

item - the item to correct

name - the name of the item before correction

type - the type of the item

column - the column of the header item in the data table

CorrectableHeaderItem

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

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

Parameters:

name - the name of the item

column - the column of the header item in the data table

CorrectableHeaderItem

public CorrectableHeaderItem(java.lang.String name,
                             java.lang.String type,
                             int column)

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

Parameters:

name - the name of the item

type - the type of the item

column - the column of the header item in the data table

CorrectableHeaderItem

public CorrectableHeaderItem(java.lang.String name,
                             java.lang.String initialName,
                             java.lang.String type,
                             int column)

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

Parameters:

name - the name of the item

initialName - the name of the item before correction

type - the type of the item

column - the column of the header item in the data table

CorrectableHeaderItem

public CorrectableHeaderItem(java.lang.String name,
                             java.lang.String initialName,
                             java.lang.String type,
                             int column,
                             java.lang.String subName)

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

Parameters:

name - the name of the item

initialName - the name of the item before correction

type - the type of the item

column - the column of the header item in the data table

subName - the string contains usually between "[" and "]"

Method Detail

clear

public void clear()

Clears th CorrectableHeaderItem object

Overrides:

clear in class HeaderItem

equals

public boolean equals(java.lang.Object o)

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

Overrides:

equals in class HeaderItem

Parameters:

o - the wanted object to be compared

Returns:

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

getDataDelimiter

public java.lang.String getDataDelimiter()

Retrieves the value delimiter of the item

Returns:

the value delimiter

getFieldType

public java.lang.String getFieldType()

Retrieves the fieldtype of the item

Returns:

the type of item

getInitialName

public java.lang.String getInitialName()

Retrieves the initial name of the item

Returns:

the initial name of item

getPrefixSubName

public java.lang.String getPrefixSubName()

Retreives the prefix delimiter for subname

Returns:

the first delimiter of the subname in the name

getSubName

public java.lang.String getSubName()

Retrieves the subname of the item

Returns:

the subname of item

getSuffixSubName

public java.lang.String getSuffixSubName()

Retrieves the suffix delimiter for subname

Returns:

the second delimiter of the subname in the name

getType

public java.lang.String getType()

Retrieves the type of the item

Returns:

the type of item

getValueDelimiter

public java.lang.String getValueDelimiter()

Retrieves the inner value delimiter of the item

Returns:

the inner value delimiter

setDataDelimiter

public void setDataDelimiter(java.lang.String _dataDelimiter)

sets the datadelimiter of the item in case of multiple values in the field

Parameters:

_dataDelimiter - the data delimiter of the item

setFieldType

public void setFieldType(java.lang.String _fieldType)

sets the field type of the item

Parameters:

_fieldType - the field value type of item

setName

public void setName(java.lang.String _name)

Sets the name of the item

Parameters:

_name - the new name of the item

setPrefixSubName

public void setPrefixSubName(java.lang.String _prefix)

Set the prefix delimiter for subname

Parameters:

_prefix - the first delimiter of the subname in the name

setSubName

public void setSubName(java.lang.String _name)

sets the subname of the item

Parameters:

_name - subname of item

setSuffixSubName

public void setSuffixSubName(java.lang.String _suffix)

Set the suffix delimiter for subname

Parameters:

_suffix - the ending delimiter of the subname in the name

setType

public void setType(java.lang.String _type)

Sets the type of the item

Parameters:

_type - the type of item

setValueDelimiter

public void setValueDelimiter(java.lang.String _valueDelimiter)

sets the valuedelimiter of the item in case of multiple component of a value

Parameters:

_valueDelimiter - the value delimiter of the item

toString

public java.lang.String toString()

Transforms object in String

Overrides:

toString in class HeaderItem

Returns:

a string representation of the item