repicea.io

Class FormatHeader<P extends FormatField>

java.lang.Object

repicea.io.FormatHeader<P>

Direct Known Subclasses:

CSVHeader, DBFHeader, SQLHeader

public abstract class FormatHeader<P extends FormatField>
extends java.lang.Object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FormatHeader()

Method Summary

Modifier and Type	Method and Description
protected void	addField(P field) This method adds a field into the field list and synchronizes the field index.
P	getField(int index) This method returns the field contained at the specified index in the list of fields.
protected java.util.List<P>	getFieldList() This method returns the list of fields contained in the header.
int	getIndexOfThisField(java.lang.String fieldName) This method returns the index of a particular field.
int	getNumberOfFields()
protected int	getNumberOfRecords() This method returns the number of records in the file.
protected void	setFieldList(java.util.List<P> fieldList) This method sets the list of fields
protected void	setNumberOfRecords(int numberOfRecords)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FormatHeader

protected FormatHeader()

Method Detail

addField

protected void addField(P field)

This method adds a field into the field list and synchronizes the field index.

Parameters:

field - the FormatField instance to be added

getFieldList

protected java.util.List<P> getFieldList()

This method returns the list of fields contained in the header.

Returns:

a Vector of FormatReaderField instances

getIndexOfThisField

public int getIndexOfThisField(java.lang.String fieldName)

This method returns the index of a particular field.

Parameters:

fieldName - the name of the field

Returns:

the index of the field or -1 if there is no field that matches the fieldName parameter.

setFieldList

protected void setFieldList(java.util.List<P> fieldList)

This method sets the list of fields

Parameters:

fieldList - a List of FormatField instances

getField

public P getField(int index)

This method returns the field contained at the specified index in the list of fields.

Parameters:

index - the index of the field (an integer)

Returns:

a FormatReaderField instance

getNumberOfFields

public int getNumberOfFields()

getNumberOfRecords

protected int getNumberOfRecords()

This method returns the number of records in the file.

Returns:

an integer

setNumberOfRecords

protected void setNumberOfRecords(int numberOfRecords)