loggerForms.controlDescriptions

Class ControlDescription

java.lang.Object

loggerForms.ItemDescription

loggerForms.controlDescriptions.ControlDescription

Direct Known Subclasses:

CdChar, CdCheckbox, CdCounter, CdDouble, CdInteger, CdLatLong, CdLatLongTime, CdLookup, CdNMEAChar, CdNMEAFloat, CdNMEAInt, CdShort, CdSingle, CdSubForm, CdTime, CdTimestamp, CdxHSpace, CdxNewline, CdxStatic, CdxVSpace

public abstract class ControlDescription
extends ItemDescription

Author:

GrahamWeatherup

Method Summary

Methods

Modifier and Type	Method and Description
org.w3c.dom.Element	createXMLDataElement(org.w3c.dom.Document doc, FormsDataUnit formsDataUnit, java.lang.Object data) Create an XML element containging the control information and data for network communication.
org.w3c.dom.Element	createXMLDataItem(org.w3c.dom.Document doc, java.lang.String name, java.lang.Object value) Create an xml element with a single data value.
java.lang.Object	extractXMLElementData(org.w3c.dom.Element el, java.lang.String value) Extract data values from an XML Element.
void	fillXMLDataElement(org.w3c.dom.Document doc, org.w3c.dom.Element el, java.lang.Object data) Write an xml element with an actual data value.
java.lang.String	formatDataItem(java.lang.Object data) format the data item, primarily used for the table of data.
ControlTypes	getEType()
FormsTableItem[]	getFormsTableItems() needs overridden for 1-many/many-many/many-a relationship
java.lang.String	getHint()
java.lang.String	getItemWarning() To be used by control Description for to check necessary fields exist
boolean	isInput()
static ControlDescription	makeCd(FormDescription formDescription, ItemInformation itemInformation)
javax.swing.JPanel	makeComponent(LoggerForm loggerForm) can now be incorporated in make control if control descriptions hold Class/data arrays of 0 size
abstract LoggerControl	makeControl(LoggerForm loggerForm)
java.lang.Object	moveDataFromTableItems() Get data from a database table item.
void	moveDataToTableItems(java.lang.Object data) Move data into the database table items

Methods inherited from class loggerForms.ItemDescription

addItemError, getAdcChannel, getAdcGain, getAnalogueAdd, getAnalogueMultiply, getAutoclear, getAutoUpdate, getColour, getControlOnSubform, getDbTitle, getDefaultValue, getForceGps, getFormDescription, getGetControlData, getHeight, getId, getItemErrors, getItemInformation, getLength, getMaxValue, getMinValue, getNmeaModule, getNmeaPosition, getNmeaString, getNumDBColumns, getOrder, getPlot, getPostTitle, getReadOnly, getRequired, getSendControlName, getTitle, getTopic, getType, setAutoUpdate, setItemErrors, setLength

Methods inherited from class java.lang.Object

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

Method Detail

getFormsTableItems

public FormsTableItem[] getFormsTableItems()

needs overridden for 1-many/many-many/many-a relationship

Returns:

getEType

public ControlTypes getEType()

Returns:

the eType

makeCd

public static ControlDescription makeCd(FormDescription formDescription,
                        ItemInformation itemInformation)

Returns:

FormsTableItems related to this controlDescription

isInput

public boolean isInput()

makeControl

public abstract LoggerControl makeControl(LoggerForm loggerForm)

makeComponent

public javax.swing.JPanel makeComponent(LoggerForm loggerForm)

can now be incorporated in make control if control descriptions hold Class/data arrays of 0 size

Parameters:

loggerForm -

Returns:

getHint

public java.lang.String getHint()

Overrides:

getHint in class ItemDescription

Returns:

the hint

moveDataToTableItems

public void moveDataToTableItems(java.lang.Object data)

Move data into the database table items

Parameters:

data - object of data - must be of a suitable type for this control

moveDataFromTableItems

public java.lang.Object moveDataFromTableItems()

Get data from a database table item.

Returns:

data object - will be in a type suitable for that control.

createXMLDataElement

public final org.w3c.dom.Element createXMLDataElement(org.w3c.dom.Document doc,
                                       FormsDataUnit formsDataUnit,
                                       java.lang.Object data)

Create an XML element containging the control information and data for network communication.
These need a fixed format so this is final, however, you can override fillXMLDataElement for controls which have > 1 data value (e.g. a LatLong)

Parameters:

doc - Parent XML document

Returns:

XML element

fillXMLDataElement

public void fillXMLDataElement(org.w3c.dom.Document doc,
                      org.w3c.dom.Element el,
                      java.lang.Object data)

Write an xml element with an actual data value.

Parameters:

doc -

el -

data -

createXMLDataItem

public final org.w3c.dom.Element createXMLDataItem(org.w3c.dom.Document doc,
                                    java.lang.String name,
                                    java.lang.Object value)

Create an xml element with a single data value.

Parameters:

doc -

name -

value -

Returns:

extractXMLElementData

public java.lang.Object extractXMLElementData(org.w3c.dom.Element el,
                                     java.lang.String value)

Extract data values from an XML Element. Unlike the function that writes the elements using toString() this will have to be more complicated to create the correct type of data.
Controls with non standard data types will have to override this.

Parameters:

el - XML Element

value - Value - quicker and easier for basic controls. Others may have to do a more complex extraction from the Element.

Returns:

Extracted object or null if data were null of there was a mismatch.

formatDataItem

public java.lang.String formatDataItem(java.lang.Object data)

format the data item, primarily used for the table of data.

Parameters:

data -

Returns:

getItemWarning

public java.lang.String getItemWarning()

Description copied from class: ItemDescription

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

Overrides:

getItemWarning in class ItemDescription

Returns:

null if ok otherwise warning string