org.openepics.cable.services.dl

Class DSRecord

java.lang.Object

org.openepics.cable.services.dl.DSRecord

public class DSRecord
extends Object

This represents a control or data record with context information. The data is stored as field name-value pairs. The control record is specified by the command of the record.

Author:

Vasu Vuppala, Sunil Sah

Constructor Summary

Constructors

Constructor and Description
DSRecord() Constructs an empty record with no fields defined and command set to none.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears all fields on this record.
DSCommand	getCommand()
Object	getField(Object name) Returns the value of the field
int	getRowIndex()
String	getRowLabel()
void	setCommand(DSCommand command) Sets the command on this record.
void	setField(String name, Object value) Sets the field to a value.
void	setRowIndex(int rowIndex)
void	setRowLabel(String rowLabel)

Methods inherited from class java.lang.Object

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

Constructor Detail

DSRecord

public DSRecord()

Constructs an empty record with no fields defined and command set to none.

Method Detail

setField

public void setField(String name,
                     Object value)

Sets the field to a value.

Parameters:

name - the field name

value - Arbitrary object to represent the value. The value cannot be null.

getField

public Object getField(Object name)

Returns the value of the field

Parameters:

name - the field name; if not a string, it is converted to string

Returns:

the value

Throws:

IllegalArgumentException - if the field by this name was not set, or name is null

clear

public void clear()

Clears all fields on this record.

getCommand

public DSCommand getCommand()

Returns:

the command of this record

setCommand

public void setCommand(DSCommand command)

Sets the command on this record.

Parameters:

command - the command to set

getRowIndex

public int getRowIndex()

Returns:

the -based row index of this record

setRowIndex

public void setRowIndex(int rowIndex)

Parameters:

rowIndex - the 0-based row index to set

getRowLabel

public String getRowLabel()

Returns:

the name of the row Name

setRowLabel

public void setRowLabel(String rowLabel)

Parameters:

rowLabel - the rowName to set