Package com.storedobject.tools

Class ColumnDefinition

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.tools.ColumnDefinition

All Implemented Interfaces:

Displayable, StringFiller, Detail, HasId

@Table(title="Attribute Definition")
public class ColumnDefinition
extends StoredObject
implements Detail

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
ColumnDefinition()

Method Summary

Modifier and Type	Method	Description
static String	browseOrder()
static void	columns(Columns columns)
static String[]	displayColumns()
static String	getAlterValue(String dbType, String variable, String oldType)
String	getCaption()
String	getColumnParam()
String	getColumnType()
String	getDefaultValue()
static String	getDefaultValue(String dbType)
boolean	getDisplayOnly()
int	getDisplayOrder()
boolean	getEmptyAllowed()
String	getEncryptKey()
String	getInitString()
String	getName()
String	getNotes()
String	getParameters()
boolean	getSetAllowed()
String	getStyles()
String	getTabName()
int	getType()
String	getTypeValue()
static String	getTypeValue(int value)
static String[]	getTypeValues()
Id	getUniqueId()	Get the Id of the class instance that makes this instance unique.
Object	getUniqueValue()	Get the unique value that determines the uniqueness of the detail entries.
boolean	isDetailOf(Class<? extends StoredObject> masterClass)	Check if the given class is a "master" for this class.
void	setCaption(String caption)
void	setDisplayOnly(boolean readOnly)
void	setDisplayOrder(int order)
void	setEmptyAllowed(boolean emptyAllowed)
void	setName(String name)
void	setNotes(String notes)
void	setParameters(String parameters)
void	setSetAllowed(boolean setAllowed)
void	setStyles(String styles)
void	setTabName(String tabName)
void	setType(int type)
String	toString()	String representation of the instance.
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, 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, migrateLink, migrateLink, 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, validateDelete, 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

Constructor Details

ColumnDefinition

public ColumnDefinition()

Method Details

columns

public static void columns(Columns columns)

displayColumns

public static String[] displayColumns()

browseOrder

public static String browseOrder()

setEmptyAllowed

public void setEmptyAllowed(boolean emptyAllowed)

getEmptyAllowed

public boolean getEmptyAllowed()

setDisplayOnly

public void setDisplayOnly(boolean readOnly)

getDisplayOnly

public boolean getDisplayOnly()

setName

public void setName(String name)

getName

public String getName()

getNotes

@Column(required=false,
        style="(large)")
public String getNotes()

setNotes

public void setNotes(String notes)

getInitString

public String getInitString()

setDisplayOrder

public void setDisplayOrder(int order)

getDisplayOrder

@Column(required=false)
public int getDisplayOrder()

setSetAllowed

public void setSetAllowed(boolean setAllowed)

getSetAllowed

public boolean getSetAllowed()

setParameters

public void setParameters(String parameters)

getParameters

@Column(required=false)
public String getParameters()

setStyles

public void setStyles(String styles)

getStyles

@Column(required=false,
        caption="Display Styles")
public String getStyles()

setType

public void setType(int type)

getType

public int getType()

getTypeValues

public static String[] getTypeValues()

getTypeValue

public static String getTypeValue(int value)

getTypeValue

public String getTypeValue()

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 this method raises any exception, 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.

getEncryptKey

public String getEncryptKey()

getUniqueId

public Id getUniqueId()

Description copied from interface: Detail

Get the Id of the class instance that makes this instance unique. (By default, generally, the Id of this instance is returned).

Specified by:

getUniqueId in interface Detail

Returns:

Id of the class instance that makes this instance unique.

getColumnType

public String getColumnType()

getColumnParam

public String getColumnParam()

setTabName

public void setTabName(String tabName)

getTabName

@Column(required=false)
public String getTabName()

getDefaultValue

public static String getDefaultValue(String dbType)

getDefaultValue

public String getDefaultValue()

getAlterValue

public static String getAlterValue(String dbType,
 String variable,
 String oldType)

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.

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.

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.

setCaption

public void setCaption(String caption)

getCaption

@Column(required=false)
public String getCaption()