Package loggerForms

Class ItemDescription

java.lang.Object

loggerForms.ItemDescription

Direct Known Subclasses:

ControlDescription, PropertyDescription

public abstract class ItemDescription
extends Object

Constructor Summary

Constructors

Constructor	Description
ItemDescription(FormDescription formDescription, ItemInformation itemInformation)

Method Summary

Modifier and Type	Method	Description
void	addItemError()	Add one to the item error count.
Integer	getAdcChannel()
Integer	getAdcGain()
Float	getAnalogueAdd()
Float	getAnalogueMultiply()
Boolean	getAutoclear()
Integer	getAutoUpdate()
String	getColour()
String	getControlOnSubform()
String	getDbTitle()	Return the database title.
String	getDefaultValue()
Boolean	getForceGps()
FormDescription	getFormDescription()
String	getGetControlData()
Integer	getHeight()
String	getHint()
Integer	getId()
int	getItemErrors()
ItemInformation	getItemInformation()
String	getItemWarning()	To be used by control Description for to check necessary fields exist
Integer	getLength()
Float	getMaxValue()
Float	getMinValue()
String	getNmeaModule()
Integer	getNmeaPosition()
String	getNmeaString()
int	getNumDBColumns()
Integer	getOrder()
Boolean	getPlot()
String	getPostTitle()
Boolean	getReadOnly()
Boolean	getRequired()
String	getSendControlName()
String	getTitle()
String	getTopic()
String	getType()
void	setAutoUpdate(Integer autoUpdate)
void	setItemErrors(int itemErrors)
void	setLength(Integer length)

Methods inherited from class java.lang.Object

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

Constructor Details

ItemDescription

public ItemDescription(FormDescription formDescription,
 ItemInformation itemInformation)

Method Details

getItemInformation

public ItemInformation getItemInformation()

Returns:

the itemInformation

setItemErrors

public void setItemErrors(int itemErrors)

Parameters:

itemErrors - the itemErrors to set

addItemError

public void addItemError()

Add one to the item error count.

getItemErrors

public int getItemErrors()

Returns:

the itemErrors

getItemWarning

public String getItemWarning()

To be used by control Description for to check necessary fields exist

Returns:

null if ok otherwise warning string

getId

public Integer getId()

Returns:

the id

getOrder

public Integer getOrder()

Returns:

the order

getType

public String getType()

Returns:

the type

getTitle

public String getTitle()

Returns:

the title

getPostTitle

public String getPostTitle()

Returns:

the postTitle

getNumDBColumns

public int getNumDBColumns()

getDbTitle

public String getDbTitle()

Return the database title. It's perfectly acceptable for this not to have been filled in in which case return the main title of the control. If that is also null, then it will cause an error.

Returns:

the dbTitle

getLength

public Integer getLength()

Returns:

the length

getTopic

public String getTopic()

Returns:

the topic

getNmeaModule

public String getNmeaModule()

Returns:

the nmeaString

getNmeaString

public String getNmeaString()

Returns:

the nmeaString

getNmeaPosition

public Integer getNmeaPosition()

Returns:

the nmeaPosition

getRequired

public Boolean getRequired()

Returns:

the required

getAutoUpdate

public Integer getAutoUpdate()

Returns:

the autoUpdate

setAutoUpdate

public void setAutoUpdate(Integer autoUpdate)

Parameters:

the - autoUpdate

getAutoclear

public Boolean getAutoclear()

Returns:

the autoclear

getForceGps

public Boolean getForceGps()

Returns:

the forceGps

getHint

public String getHint()

Returns:

the hint

getAdcChannel

public Integer getAdcChannel()

Returns:

the adcChannel

getAdcGain

public Integer getAdcGain()

Returns:

the adcGain

getAnalogueMultiply

public Float getAnalogueMultiply()

Returns:

the analogueMultiply

getAnalogueAdd

public Float getAnalogueAdd()

Returns:

the analogueAdd

getPlot

public Boolean getPlot()

Returns:

the plot

getHeight

public Integer getHeight()

Returns:

the height

getColour

public String getColour()

Returns:

the colour

getMinValue

public Float getMinValue()

Returns:

the minValue

getMaxValue

public Float getMaxValue()

Returns:

the maxValue

getReadOnly

public Boolean getReadOnly()

Returns:

the readOnly

getSendControlName

public String getSendControlName()

Returns:

the sendControlName

getControlOnSubform

public String getControlOnSubform()

Returns:

the controlOnSubform

getGetControlData

public String getGetControlData()

Returns:

the getControlData

getDefaultValue

public String getDefaultValue()

Returns:

the defaultField

setLength

public void setLength(Integer length)

Parameters:

length - the length to set

getFormDescription

public FormDescription getFormDescription()

Returns:

the motherFormDescription