moos.ssds.model
Interface IRecordVariable

All Superinterfaces:

IDescription, java.io.Serializable, ValueObject

All Known Implementing Classes:

RecordVariable

public interface IRecordVariable

extends java.io.Serializable, IDescription, ValueObject

Author:

kgomes To change the template for this generated type comment go to Window>Preferences>Java>Code Generation>Code and Comments

Method Summary

boolean	equals(java.lang.Object o)
long	getColumnIndex() Gets the columnIndex attribute of the RecordVariable object.
java.lang.String	getDescription()
java.lang.String	getFormat() Gets the format attribute of the RecordVariable object
java.lang.Long	getId() Gets the id attribute of the RecordVariable object
java.lang.String	getLongName() Gets the longName attribute of the RecordVariable object
java.lang.String	getMissingValue() Gets the missingValue attribute of the RecordVariable object
java.lang.String	getName() Gets the name attribute of the RecordVariable object
java.lang.String	getParseRegExp() Get the regular expression used to parse the data if is needs one
IStandardUnit	getStandardUnit()
java.lang.Long	getStandardUnitId()
IStandardVariable	getStandardVariable() Gets the variable attribute of the RecordVariable object
java.lang.Long	getStandardVariableId() Gets the variableId attribute of the RecordVariable object
java.lang.String	getUnits() Gets the recordDescription attribute of the RecordVariable object
java.lang.String	getValidMax() Gets the validMax attribute of the RecordVariable object
java.lang.String	getValidMin() Gets the validMin attribute of the RecordVariable object
void	setColumnIndex(long i) Sets the columnIndex attribute of the RecordVariable object
void	setDescription(java.lang.String description)
void	setFormat(java.lang.String s) Sets the format attribute of the RecordVariable object
void	setId(java.lang.Long id) Sets the id attribute of the RecordVariable object
void	setLongName(java.lang.String s) Sets the longName attribute of the RecordVariable object
void	setMissingValue(java.lang.String s) Sets the missingValue attribute of the RecordVariable object
void	setName(java.lang.String s) Sets the name attribute of the RecordVariable object
void	setParseRegExp(java.lang.String parseRegExp) This method sets the regular expression used to parse the variable
void	setRecordDescription(IRecordDescription rd) Sets the recordDescription attribute of the RecordVariable object.
void	setRecordDescriptionId(java.lang.Long id) Sets the recordDescriptionId attribute of the RecordVariable object
void	setStandardUnit(IStandardUnit standardUnit)
void	setStandardUnitId(java.lang.Long standardUnitId)
void	setStandardVariable(IStandardVariable v) Sets the variable attribute of the RecordVariable object
void	setStandardVariableId(java.lang.Long id) Sets the variableId attribute of the RecordVariable object
void	setUnits(java.lang.String units) Sets the units attribute of the RecordVariable object
void	setValidMax(java.lang.String s) Sets the validMax attribute of the RecordVariable object
void	setValidMin(java.lang.String s) Sets the validMin attribute of the RecordVariable object
java.lang.String	toString() If you don't know what toString() does you probaly shouldn't be writing Java code ;-) WARNING: The format of the string may change at anytime do the capricous whims of the developers.

Method Detail

getColumnIndex

public long getColumnIndex()

Gets the columnIndex attribute of the RecordVariable object.

Returns:

The columnIndex value. -1 if it hasnot been defined. The indices are 1-based (i.e. NOT 0-based like java arrays)

getFormat

public java.lang.String getFormat()

Gets the format attribute of the RecordVariable object

Returns:

The format value

getId

public java.lang.Long getId()

Gets the id attribute of the RecordVariable object

Specified by:

getId in interface ValueObject

Returns:

The id value

getLongName

public java.lang.String getLongName()

Gets the longName attribute of the RecordVariable object

Returns:

The longName value

getMissingValue

public java.lang.String getMissingValue()

Gets the missingValue attribute of the RecordVariable object

Returns:

The missingValue value

getName

public java.lang.String getName()

Gets the name attribute of the RecordVariable object

Specified by:

getName in interface IDescription

Returns:

The name value

getUnits

public java.lang.String getUnits()

Gets the recordDescription attribute of the RecordVariable object

Returns:

The recordDescription value

getValidMax

public java.lang.String getValidMax()

Gets the validMax attribute of the RecordVariable object

Returns:

The validMax value

getValidMin

public java.lang.String getValidMin()

Gets the validMin attribute of the RecordVariable object

Returns:

The validMin value

getParseRegExp

public java.lang.String getParseRegExp()

Get the regular expression used to parse the data if is needs one

Returns:

getStandardVariable

public IStandardVariable getStandardVariable()

Gets the variable attribute of the RecordVariable object

Returns:

The variable value

getStandardVariableId

public java.lang.Long getStandardVariableId()

Gets the variableId attribute of the RecordVariable object

Returns:

The variableId value

setColumnIndex

public void setColumnIndex(long i)

Sets the columnIndex attribute of the RecordVariable object

Parameters:

i - The new columnIndex value

setFormat

public void setFormat(java.lang.String s)

Sets the format attribute of the RecordVariable object

Parameters:

s - The new format value

setId

public void setId(java.lang.Long id)

Sets the id attribute of the RecordVariable object

Specified by:

setId in interface ValueObject

Parameters:

id - The new id value

setLongName

public void setLongName(java.lang.String s)

Sets the longName attribute of the RecordVariable object

Parameters:

s - The new longName value

setMissingValue

public void setMissingValue(java.lang.String s)

Sets the missingValue attribute of the RecordVariable object

Parameters:

s - The new missingValue value

setName

public void setName(java.lang.String s)

Sets the name attribute of the RecordVariable object

Specified by:

setName in interface IDescription

Parameters:

s - The new name value

setRecordDescription

public void setRecordDescription(IRecordDescription rd)

Sets the recordDescription attribute of the RecordVariable object. This method should only be called by RecordDescription.addRecordVariable(), so access to this is package local

Parameters:

rd - The new recordDescription value

setRecordDescriptionId

public void setRecordDescriptionId(java.lang.Long id)

Sets the recordDescriptionId attribute of the RecordVariable object

Parameters:

id - The new recordDescriptionId value

setUnits

public void setUnits(java.lang.String units)

Sets the units attribute of the RecordVariable object

Parameters:

units - The new units value

setValidMax

public void setValidMax(java.lang.String s)

Sets the validMax attribute of the RecordVariable object

Parameters:

s - The new validMax value

setValidMin

public void setValidMin(java.lang.String s)

Sets the validMin attribute of the RecordVariable object

Parameters:

s - The new validMin value

setParseRegExp

public void setParseRegExp(java.lang.String parseRegExp)

This method sets the regular expression used to parse the variable

Parameters:

parseRegExp - is the string used to parse the variable

setStandardVariable

public void setStandardVariable(IStandardVariable v)

Sets the variable attribute of the RecordVariable object

Parameters:

v - The new variable value

setStandardVariableId

public void setStandardVariableId(java.lang.Long id)

Sets the variableId attribute of the RecordVariable object

Parameters:

id - The new variableId value

toString

public java.lang.String toString()

If you don't know what toString() does you probaly shouldn't be writing Java code ;-) WARNING: The format of the string may change at anytime do the capricous whims of the developers. Do not write code that parses this toString for information. You have been warned.

Returns:

A string

setDescription

public void setDescription(java.lang.String description)

Specified by:

setDescription in interface IDescription

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface IDescription

getStandardUnitId

public java.lang.Long getStandardUnitId()

Returns:

setStandardUnitId

public void setStandardUnitId(java.lang.Long standardUnitId)

Parameters:

standardUnitId -

getStandardUnit

public IStandardUnit getStandardUnit()

Returns:

setStandardUnit

public void setStandardUnit(IStandardUnit standardUnit)

Parameters:

standardUnit -

equals

public boolean equals(java.lang.Object o)