Package com.storedobject.iot

Class UnitDefinition

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.iot.UnitDefinition

All Implemented Interfaces:

Displayable, StringFiller, HasChildren, HasId

public final class UnitDefinition
extends StoredObject
implements HasChildren

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
UnitDefinition()

Method Summary

Modifier and Type	Method	Description
static void	columns(Columns columns)
static void	generateLimitsAndAlarms(TransactionManager tm)
String	getCaption()
Class<? extends Data>	getDataClass()
String	getDataClassName()
static UnitDefinition	getFor(Class<? extends Unit> uClass, Class<? extends Data> dClass)
static UnitDefinition	getFor(String uClassName, String dClassName)
int	getSignificance()
String	getUniqueCondition()	Gets the unique index condition of this object.
Class<? extends Unit>	getUnitClass()
String	getUnitClassName()
UnitType	getUnitType()
Id	getUnitTypeId()
int	getUpdateFrequency()
static int	hints()
static void	indices(Indices indices)
static String[]	links()
void	saved()	This method is invoked whenever an instance is saved/deleted/resurrected.
void	setCaption(String caption)
void	setDataClassName(String dataClassName)
void	setSignificance(int significance)
void	setUnitType(Id unitTypeId)
void	setUnitType(UnitType unitType)
void	setUnitType(BigDecimal idValue)
void	setUpdateFrequency(int updateFrequency)
void	validateChildAttach(StoredObject child, int linkType)	Do validation when a child is attached.
void	validateData(TransactionManager tm)	The system will invoke this whenever the object is saved to the DB.

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, 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, saving, setMaster, setRawValue, setTransaction, stringify, tableName, timestamp, toCode, toDisplay, toString, transacting, undelete, undelete, undeleted, updated, user, userId, validate, validateChildDetach, validateChildUpdate, validateDelete, validateInsert, validateParentAttach, validateParentDetach, validateParentUpdate, validateUndelete, validateUpdate, valueEquals

Methods inherited from class java.lang.Object

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

Constructor Details

UnitDefinition

public UnitDefinition()

Method Details

columns

public static void columns(Columns columns)

indices

public static void indices(Indices indices)

getUniqueCondition

public String getUniqueCondition()

Description copied from class: StoredObject

Gets the unique index condition of this object.

Overrides:

getUniqueCondition in class StoredObject

Returns:

Unique index condition.

hints

public static int hints()

links

public static String[] links()

setUnitType

public void setUnitType(Id unitTypeId)

setUnitType

public void setUnitType(BigDecimal idValue)

setUnitType

public void setUnitType(UnitType unitType)

getUnitTypeId

@SetNotAllowed
@Column(order=100)
public Id getUnitTypeId()

getUnitType

public UnitType getUnitType()

getUnitClassName

public String getUnitClassName()

setSignificance

public void setSignificance(int significance)

getSignificance

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

setDataClassName

public void setDataClassName(String dataClassName)

getDataClassName

@Column(order=500)
public String getDataClassName()

setUpdateFrequency

public void setUpdateFrequency(int updateFrequency)

getUpdateFrequency

@Column(order=600,
        required=false,
        caption="Update Frequency (In Seconds)")
public int getUpdateFrequency()

setCaption

public void setCaption(String caption)

getCaption

@Column(order=700)
public String getCaption()

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.

getUnitClass

public Class<? extends Unit> getUnitClass()

saved

public void saved()
           throws Exception

Description copied from class: StoredObject

This method is invoked whenever an instance is saved/deleted/resurrected. It can be overridden to take care of any additional actions required by the application.

Overrides:

saved in class StoredObject

Throws:

Exception - When error occurs or invalidate state exists so that transaction will be abandoned.

getDataClass

public Class<? extends Data> getDataClass()

validateChildAttach

public void validateChildAttach(StoredObject child,
 int linkType)
                         throws Exception

Description copied from class: StoredObject

Do validation when a child is attached.

Note: This method will be invoked only if this class implements HasChildren.

Overrides:

validateChildAttach in class StoredObject

Parameters:

child - Child to validate.

linkType - Link type.

Throws:

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

getFor

public static UnitDefinition getFor(Class<? extends Unit> uClass,
 Class<? extends Data> dClass)

getFor

public static UnitDefinition getFor(String uClassName,
 String dClassName)

generateLimitsAndAlarms

public static void generateLimitsAndAlarms(TransactionManager tm)
                                    throws Exception

Throws:

Exception