Package com.storedobject.tools

Class TableDefinition

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.tools.TableDefinition

All Implemented Interfaces:

Displayable, StringFiller, HasId

@Table(tab="Data Class")
public class TableDefinition
extends StoredObject

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
TableDefinition()

Method Summary

Modifier and Type	Method	Description
ArrayList<String>	alterTable(TransactionManager tm)
boolean	classChanged()
boolean	classChanged(JavaClass jc)
static void	columns(Columns columns)
static void	compareDefinitions(TransactionManager tm, InputStream data, StyledBuilder message)
boolean	compile()
boolean	deploy(TransactionManager tm, char[] securityPassword)
boolean	deploy(TransactionManager tm, char[] securityPassword, boolean checkOldLoaded)
boolean	deployLogic(TransactionManager tm)
boolean	deployLogic(TransactionManager tm, boolean checkOldLoaded)
boolean	deployTable(TransactionManager tm, char[] securityPassword)
static String[]	displayColumns()
boolean	generateInterfaceCode()
void	generateJavaCode(Writer writer)
void	generateJavaCode(Writer writer, boolean close)
void	generateJavaCode(Writer writer, boolean close, boolean withComment)
static TableDefinition	get(String className)
boolean	getAbstractClass()
String	getAnchorColumns()
String	getBrowseColumns()
String	getClassName()
String	getConstructorBlock()
String	getDisplayColumns()
String	getExtraConstructors()
String	getExtraImports()
String	getExtraMethods()
int	getFormStyle()
String	getFormStyleValue()
static String	getFormStyleValue(int formStyle)
static String[]	getFormStyleValues()
String	getFormTitle()
String	getInterfaces()
String	getNotes()
String	getParentClassName()
String	getParentTableName()
String	getProtectedColumns()
String	getSchemaName(TransactionManager tm)
String	getSearchColumns()
boolean	getSmall()
boolean	getSmallList()
String	getTableName(TransactionManager tm)
String	getTabName()
String	getUniqueCondition()	Gets the unique index condition of this object.
String	getValidateBlock()
String	getVariablesBlock()
boolean	hasDetailInterface()
static void	indices(Indices indices)
boolean	isAccountType()
boolean	isCoreType(String type)
boolean	isCorrectionNeeded()
boolean	isMasterObject()
boolean	isNameType()
static String[]	links()
static ObjectIterator<TableDefinition>	list(String className)
static void	loadDefinitions(TransactionManager tm, InputStream data, StyledBuilder message)
static String[]	protectedColumns()
static String[]	searchColumns()
void	setAbstractClass(boolean abstractClass)
void	setAnchorColumns(String anchorColumns)
void	setBrowseColumns(String browseColumns)
void	setClassName(String className)
void	setConstructorBlock(String constructorBlock)
void	setDisplayColumns(String displayColumns)
void	setExtraConstructors(String extraConstructors)
void	setExtraImports(String extraImports)
void	setExtraMethods(String extraMethods)
void	setFormStyle(int formStyle)
void	setFormTitle(String formTitle)
void	setInterfaces(String interfaces)
void	setNotes(String notes)
void	setParentClassName(String parentClassName)
void	setProtectedColumns(String protectedColumns)
void	setSearchColumns(String searchColumns)
void	setSmall(boolean small)
void	setSmallList(boolean smallList)
void	setTabName(String tabName)
void	setValidateBlock(String validateBlock)
void	setVariablesBlock(String variablesBlock)
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, 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, 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

TableDefinition

public TableDefinition()

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.

displayColumns

public static String[] displayColumns()

searchColumns

public static String[] searchColumns()

protectedColumns

public static String[] protectedColumns()

links

public static String[] links()

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.

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.

isCorrectionNeeded

public boolean isCorrectionNeeded()

generateInterfaceCode

public boolean generateInterfaceCode()

hasDetailInterface

public boolean hasDetailInterface()

isMasterObject

public boolean isMasterObject()

setClassName

public void setClassName(String className)

getClassName

public String getClassName()

setParentClassName

public void setParentClassName(String parentClassName)

getParentClassName

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

setAbstractClass

public void setAbstractClass(boolean abstractClass)

getAbstractClass

public boolean getAbstractClass()

getParentTableName

public String getParentTableName()

getTableName

public String getTableName(TransactionManager tm)

getSchemaName

public String getSchemaName(TransactionManager tm)

setFormTitle

public void setFormTitle(String formTitle)

getFormTitle

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

setFormStyle

public void setFormStyle(int formStyle)

getFormStyle

public int getFormStyle()

getFormStyleValues

public static String[] getFormStyleValues()

getFormStyleValue

public static String getFormStyleValue(int formStyle)

getFormStyleValue

public String getFormStyleValue()

setTabName

public void setTabName(String tabName)

getTabName

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

compile

public boolean compile()

generateJavaCode

public void generateJavaCode(Writer writer)
                      throws Exception

Throws:

Exception

isCoreType

public boolean isCoreType(String type)

isAccountType

public boolean isAccountType()

isNameType

public boolean isNameType()

generateJavaCode

public void generateJavaCode(Writer writer,
 boolean close)
                      throws Exception

Throws:

Exception

generateJavaCode

public void generateJavaCode(Writer writer,
 boolean close,
 boolean withComment)
                      throws Exception

Throws:

Exception

setExtraImports

public void setExtraImports(String extraImports)

getExtraImports

public String getExtraImports()

setExtraConstructors

public void setExtraConstructors(String extraConstructors)

getExtraConstructors

public String getExtraConstructors()

setExtraMethods

public void setExtraMethods(String extraMethods)

getExtraMethods

public String getExtraMethods()

setConstructorBlock

public void setConstructorBlock(String constructorBlock)

getConstructorBlock

public String getConstructorBlock()

setValidateBlock

public void setValidateBlock(String validateBlock)

getValidateBlock

public String getValidateBlock()

setInterfaces

public void setInterfaces(String interfaces)

getInterfaces

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

setVariablesBlock

public void setVariablesBlock(String variablesBlock)

getVariablesBlock

public String getVariablesBlock()

setDisplayColumns

public void setDisplayColumns(String displayColumns)

getDisplayColumns

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

setSearchColumns

public void setSearchColumns(String searchColumns)

getSearchColumns

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

setBrowseColumns

public void setBrowseColumns(String browseColumns)

getBrowseColumns

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

setProtectedColumns

public void setProtectedColumns(String protectedColumns)

getProtectedColumns

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

setAnchorColumns

public void setAnchorColumns(String anchorColumns)

getAnchorColumns

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

setSmall

public void setSmall(boolean small)

getSmall

public boolean getSmall()

setSmallList

public void setSmallList(boolean smallList)

getSmallList

public boolean getSmallList()

getNotes

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

setNotes

public void setNotes(String notes)

get

public static TableDefinition get(String className)

list

public static ObjectIterator<TableDefinition> list(String className)

alterTable

public ArrayList<String> alterTable(TransactionManager tm)
                             throws Exception

Throws:

Exception

classChanged

public boolean classChanged()
                     throws Exception

Throws:

Exception

classChanged

public boolean classChanged(JavaClass jc)
                     throws Exception

Throws:

Exception

deploy

public boolean deploy(TransactionManager tm,
 char[] securityPassword)
               throws Exception

Throws:

Exception

deploy

public boolean deploy(TransactionManager tm,
 char[] securityPassword,
 boolean checkOldLoaded)
               throws Exception

Throws:

Exception

deployLogic

public boolean deployLogic(TransactionManager tm)
                    throws Exception

Throws:

Exception

deployLogic

public boolean deployLogic(TransactionManager tm,
 boolean checkOldLoaded)
                    throws Exception

Throws:

Exception

deployTable

public boolean deployTable(TransactionManager tm,
 char[] securityPassword)
                    throws Exception

Throws:

Exception

loadDefinitions

public static void loadDefinitions(TransactionManager tm,
 InputStream data,
 StyledBuilder message)
                            throws Exception

Throws:

Exception

compareDefinitions

public static void compareDefinitions(TransactionManager tm,
 InputStream data,
 StyledBuilder message)
                               throws Exception

Throws:

Exception