loggerForms

Class ItemDescription

java.lang.Object

loggerForms.ItemDescription

Direct Known Subclasses:

ControlDescription, PropertyDescription

public abstract class ItemDescription
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ItemDescription(FormDescription formDescription, ItemInformation itemInformation)

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ItemDescription

public ItemDescription(FormDescription formDescription,
               ItemInformation itemInformation)

Method Detail

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 java.lang.String getItemWarning()

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

Returns:

null if ok otherwise warning string

getId

public java.lang.Integer getId()

Returns:

the id

getOrder

public java.lang.Integer getOrder()

Returns:

the order

getType

public java.lang.String getType()

Returns:

the type

getTitle

public java.lang.String getTitle()

Returns:

the title

getPostTitle

public java.lang.String getPostTitle()

Returns:

the postTitle

getNumDBColumns

public int getNumDBColumns()

getDbTitle

public java.lang.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 java.lang.Integer getLength()

Returns:

the length

getTopic

public java.lang.String getTopic()

Returns:

the topic

getNmeaModule

public java.lang.String getNmeaModule()

Returns:

the nmeaString

getNmeaString

public java.lang.String getNmeaString()

Returns:

the nmeaString

getNmeaPosition

public java.lang.Integer getNmeaPosition()

Returns:

the nmeaPosition

getRequired

public java.lang.Boolean getRequired()

Returns:

the required

getAutoUpdate

public java.lang.Integer getAutoUpdate()

Returns:

the autoUpdate

setAutoUpdate

public void setAutoUpdate(java.lang.Integer autoUpdate)

Parameters:

the - autoUpdate

getAutoclear

public java.lang.Boolean getAutoclear()

Returns:

the autoclear

getForceGps

public java.lang.Boolean getForceGps()

Returns:

the forceGps

getHint

public java.lang.String getHint()

Returns:

the hint

getAdcChannel

public java.lang.Integer getAdcChannel()

Returns:

the adcChannel

getAdcGain

public java.lang.Integer getAdcGain()

Returns:

the adcGain

getAnalogueMultiply

public java.lang.Float getAnalogueMultiply()

Returns:

the analogueMultiply

getAnalogueAdd

public java.lang.Float getAnalogueAdd()

Returns:

the analogueAdd

getPlot

public java.lang.Boolean getPlot()

Returns:

the plot

getHeight

public java.lang.Integer getHeight()

Returns:

the height

getColour

public java.lang.String getColour()

Returns:

the colour

getMinValue

public java.lang.Float getMinValue()

Returns:

the minValue

getMaxValue

public java.lang.Float getMaxValue()

Returns:

the maxValue

getReadOnly

public java.lang.Boolean getReadOnly()

Returns:

the readOnly

getSendControlName

public java.lang.String getSendControlName()

Returns:

the sendControlName

getControlOnSubform

public java.lang.String getControlOnSubform()

Returns:

the controlOnSubform

getGetControlData

public java.lang.String getGetControlData()

Returns:

the getControlData

getDefaultValue

public java.lang.String getDefaultValue()

Returns:

the defaultField

setLength

public void setLength(java.lang.Integer length)

Parameters:

length - the length to set

getFormDescription

public FormDescription getFormDescription()

Returns:

the motherFormDescription