Package com.storedobject.iot

Class ValueDefinition<VT>

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.iot.ValueDefinition<VT>

All Implemented Interfaces:

Displayable, StringFiller, Detail, HasId

Direct Known Subclasses:

AlarmSwitch, ValueLimit

public abstract class ValueDefinition<VT>
extends StoredObject
implements Detail

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
ValueDefinition()

Method Summary

Modifier and Type	Method	Description
static void	columns(Columns columns)
protected VT	convertValue(Object value)
boolean	getActive()
boolean	getAlert()
String	getAlertMessage()
abstract String	getAlertMessage(int alarmLevel)	Get alert message for the value alarm level
String	getCaption()
String	getCaption(int ordinality, int layoutStyle)
String	getCaption(Unit unit)
boolean	getCommand()
Class<? extends Data>	getDataClass()
String	getImagePrefix()
int	getImageX()
int	getImageX(int ordinality, int layoutStyle)
int	getImageX(Unit unit)
int	getImageY()
int	getImageY(int ordinality, int layoutStyle)
int	getImageY(Unit unit)
String	getLabel()
String	getLabel(int ordinality, int layoutStyle)
String	getLabel(Unit unit)
<IOT extends Data> IOT	getLatestData(Id unitId)
String	getName()
String	getShortName()
boolean	getShowChart()
boolean	getShowImage()
int	getSignificance()
String	getTooltip()
String	getTooltip(int ordinality, int layoutStyle)
String	getTooltip(Unit unit)
Object	getUniqueValue()	Get the unique value that determines the uniqueness of the detail entries.
Class<? extends Unit>	getUnitClass()
final VT	getValue(Id unitId)
Method	getValueMethodForGet()
Method	getValueMethodForSet()
final Object	getValueObject(Id unitId)
boolean	isDetailOf(Class<? extends StoredObject> masterClass)	Check if the given class is a "master" for this class.
static String[]	links()
void	savePosition(Transaction t, int imageX, int imageY, Unit unit)
static String[]	searchColumns()
void	setActive(boolean active)
void	setAlert(boolean alert)
void	setAlertMessage(String alertMessage)
void	setCaption(String caption)
void	setCommand(boolean command)
void	setImagePrefix(String imagePrefix)
void	setImageX(int imageX)
void	setImageY(int imageY)
void	setLabel(String label)
void	setName(String name)
void	setShowChart(boolean showChart)
void	setShowImage(boolean showImage)
void	setSignificance(int significance)
void	setTooltip(String tooltip)
String	toString()	String representation of the instance.
void	validateData(TransactionManager tm)	The system will invoke this whenever the object is saved to the DB.
void	validateDelete()	This method will be invoked whenever an existing instance is deleted from the database.

Methods inherited from class com.storedobject.core.StoredObject

addLink, addLink, addLink, addLink, addLink, addLink, addLink, addLink, checkCurrency, checkCurrency, checkForDuplicate, checkForDuplicate, checkTimeZone, checkTransaction, clearObjectLinks, contemporary, copy, copy, count, count, count, count, count, count, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, create, created, delete, delete, delete, deleted, directUpdate, equals, exists, exists, exists, exists, exists, existsFileData, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsMaster, existsMaster, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, family, family, family, family, fill, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, getActor, getAttachment, getAttachmentId, getChildren, getContemporaryOf, getDeleted, getDeleted, getExistsCondition, getExistsCondition, getFileData, getFileData, getHistorical, getId, getKeyIndex, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getNotExistsCondition, getNotExistsCondition, getParent, getParent, getParent, getParentId, getParentId, getParentId, getRelated, getRelated, getTransaction, getTransactionId, getTransactionIP, getUnique, getUniqueCondition, hashCode, inserted, isModified, isVirtual, list, list, list, list, list, list, list, list, list, list, list, list, list, listDeletedIds, listFileData, listFileData, listHistory, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listTree, listTree, listTree, listTree, listViaQuery, listViaQuery, load, load, load, load, loadAttributesFrom, loaded, loading, makeNew, makeVirtual, migrate, moduleName, nextVersion, objectLink, objectLink, objectLink, objectLinks, objectLinks, old, person, previousVersion, previousVersion, query, query, query, query, query, query, query, query, query, query, query, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, reload, reload, reloaded, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeReverseLinks, removeReverseLinks, save, save, save, save, save, save, save, save, save, save, save, save, save, save, save, saved, saving, setMaster, setRawValue, setTransaction, stringify, tableName, timestamp, toCode, toDisplay, transacting, undelete, undelete, undeleted, updated, user, userId, validate, validateChildAttach, validateChildDetach, validateChildUpdate, validateInsert, validateParentAttach, validateParentDetach, validateParentUpdate, validateUndelete, validateUpdate, valueEquals

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.storedobject.core.Detail

copyValuesFrom, getId, getUniqueId

Constructor Details

ValueDefinition

public ValueDefinition()

Method Details

columns

public static void columns(Columns columns)

searchColumns

public static String[] searchColumns()

links

public static String[] links()

setName

public void setName(String name)

getName

@Column(order=100)
public String getName()

setCaption

public void setCaption(String caption)

getCaption

@Column(required=false,
        order=200)
public String getCaption()

setLabel

public void setLabel(String label)

getLabel

@Column(required=false,
        order=250)
public String getLabel()

setTooltip

public void setTooltip(String tooltip)

getTooltip

@Column(required=false,
        order=260)
public String getTooltip()

setAlertMessage

public void setAlertMessage(String alertMessage)

getAlertMessage

@Column(required=false,
        order=270)
public String getAlertMessage()

setSignificance

public void setSignificance(int significance)

getSignificance

@Column(required=false,
        order=300)
public int getSignificance()

setAlert

public void setAlert(boolean alert)

getAlert

@Column(order=5700)
public boolean getAlert()

setCommand

public void setCommand(boolean command)

getCommand

@Column(order=5800)
public boolean getCommand()

setActive

public void setActive(boolean active)

getActive

@Column(order=5900)
public boolean getActive()

setShowChart

public void setShowChart(boolean showChart)

getShowChart

@Column(order=6900)
public boolean getShowChart()

setShowImage

public void setShowImage(boolean showImage)

getShowImage

@Column(order=7000)
public boolean getShowImage()

setImageX

public void setImageX(int imageX)

getImageX

@Column(order=7100,
        required=false)
public int getImageX()

setImageY

public void setImageY(int imageY)

getImageY

@Column(order=7200,
        required=false)
public int getImageY()

setImagePrefix

public void setImagePrefix(String imagePrefix)

getImagePrefix

@Column(order=7500,
        required=false)
public String getImagePrefix()

validateData

public void validateData(TransactionManager tm)
                  throws Exception

Description copied from class: StoredObject

The system will invoke this whenever the object is saved to the DB. It will be invoked in all cases while creating new objects and updating/deleting/undeleting existing objects. If any exception is raised by this method, the process of saving to the DB will be abandoned.

Note: This method is mainly used to validate the data of all attributes of the object, and it may be used by others for validating the object. For example, front-end data-entry systems can use this method for validating the object.

Overrides:

validateData in class StoredObject

Parameters:

tm - Current transaction manager.

Throws:

Exception - If data is invalid.

validateDelete

public void validateDelete()
                    throws Exception

Description copied from class: StoredObject

This method will be invoked whenever an existing instance is deleted from the database. So, it will be called within an active transaction. Child classes can override this method to do validation when an existing instance is deleted from the database.

Note: When overridden "super" should be called, otherwise, a "design error" will occur.

Also, see StoredObject.validate().

Overrides:

validateDelete in class StoredObject

Throws:

Exception - By raising an exception from this method, the current transaction can be abandoned.

getUniqueValue

public Object getUniqueValue()

Description copied from interface: Detail

Get the unique value that determines the uniqueness of the detail entries. By default, null is returned so that no uniqueness can be checked using this. (In most cases, Detail.getUniqueId() may be enough unless some other type of values need to be checked).

Specified by:

getUniqueValue in interface Detail

Returns:

Return the value to determine the uniqueness of the detail entries.

isDetailOf

public boolean isDetailOf(Class<? extends StoredObject> masterClass)

Description copied from interface: Detail

Check if the given class is a "master" for this class. (Must return a consistent value).

Specified by:

isDetailOf in interface Detail

Parameters:

masterClass - Class to check.

Returns:

True if it is a "master" to this detail class. Otherwise, false.

getDataClass

public Class<? extends Data> getDataClass()

getUnitClass

public Class<? extends Unit> getUnitClass()

getValueMethodForGet

public Method getValueMethodForGet()

getValueMethodForSet

public Method getValueMethodForSet()

getLatestData

public <IOT extends Data> IOT getLatestData(Id unitId)

getValueObject

public final Object getValueObject(Id unitId)

getValue

public final VT getValue(Id unitId)

convertValue

protected VT convertValue(Object value)

toString

public String toString()

Description copied from class: StoredObject

String representation of the instance. Mostly used for logging purposes.

Overrides:

toString in class StoredObject

Returns:

String representation of the instance.

getShortName

public String getShortName()

getImageX

public int getImageX(Unit unit)

getImageX

public int getImageX(int ordinality,
 int layoutStyle)

getImageY

public int getImageY(Unit unit)

getImageY

public int getImageY(int ordinality,
 int layoutStyle)

getLabel

public String getLabel(Unit unit)

getLabel

public String getLabel(int ordinality,
 int layoutStyle)

getTooltip

public String getTooltip(Unit unit)

getTooltip

public String getTooltip(int ordinality,
 int layoutStyle)

getCaption

public String getCaption(Unit unit)

getCaption

public String getCaption(int ordinality,
 int layoutStyle)

savePosition

public void savePosition(Transaction t,
 int imageX,
 int imageY,
 Unit unit)
                  throws Exception

Throws:

Exception

getAlertMessage

public abstract String getAlertMessage(int alarmLevel)

Get alert message for the value alarm level

Parameters:

alarmLevel - Level. 0 = Normal, -1 = Low, -2 = Lower, -3 = Lowest, 1 = High, 2 = Higher, 3 = Highest

Returns:

Alert message.