org.openepics.cable.services.dl

Class DSHeader

java.lang.Object

org.openepics.cable.services.dl.DSHeader

All Implemented Interfaces:

Serializable

public class DSHeader
extends Object
implements Serializable

This holds header definition of loaded data. It is used internally by RecordStream to assemble records.

Author:

Vasu Vuppala, Sunil Sah

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
void	addHeader(DSHeader header) Appends the definition of the given header to this one.
void	clear() Clears all stored definitions.
int	getColumnIndex(String name) Returns the index of a column.
String	getColumnLabel(String name) Returns the label of a column.
Iterable<String>	getColumnNames()
boolean	hasDefinitions()
void	setColumn(String name, int index, String label) Stores a column definition.

Methods inherited from class java.lang.Object

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

Method Detail

getColumnIndex

public int getColumnIndex(String name)

Returns the index of a column.

Parameters:

name - the column name

Returns:

0-based index

getColumnLabel

public String getColumnLabel(String name)

Returns the label of a column.

Parameters:

name - the column name

Returns:

the column label (A, B, ...)

setColumn

public void setColumn(String name,
                      int index,
                      String label)

Stores a column definition.

Parameters:

name - the column name

index - the column index, 0 based

label - the column label (A, B, ...)

hasDefinitions

public boolean hasDefinitions()

Returns:

true if any definitions stored in the header, else false

getColumnNames

public Iterable<String> getColumnNames()

Returns:

the defined column names

clear

public void clear()

Clears all stored definitions.

addHeader

public void addHeader(DSHeader header)

Appends the definition of the given header to this one.

Parameters:

header - the header to append