Package com.storedobject.core

Class JavaClass

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.JavaInnerClass

com.storedobject.core.JavaClass

All Implemented Interfaces:

Displayable, StringFiller, HasId

public final class JavaClass
extends JavaInnerClass

Representation of "Java Class".

Field Summary

Fields inherited from class com.storedobject.core.JavaInnerClass

name

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
JavaClass()	Constructor for internal use only
JavaClass(String name)	Constructor

Method Summary

Modifier and Type	Method	Description
void	accessed(TransactionManager tm)
static boolean	checkName(String name)
boolean	classChanged(CharSequence sourceCodeToCheck)
static void	columns(Columns columns)
String	compile()
static JavaClass	create(String name)
static String[]	displayColumns()
void	download()
static JavaClass	get(String name)
boolean	getGenerated()
ObjectIterator<JavaInnerClass>	getInnerClassList()
ObjectIterator<JavaInnerClass>	getInnerClassList(Transaction transaction)
String	getNotes()
static Package	getPackage(Class<?> clazz)
static Package	getPackage(String name)
StreamData	getSourceData()	Gets the "source data" of the Java Class
Id	getSourceDataId()	Gets the Id of the "source data" of this Java Class.
InputStream	getSourceStream()	Gets the "source data" stream.
int	getVersion()
static ObjectIterator<JavaClass>	list(String name)
static List<String>	listApplicationClasses()
static List<String>	listSystemClasses(char[] securityPassword)
static String[]	searchColumns()
void	setGenerated(boolean generated)
void	setNotes(String notes)
void	setSourceCode(CharSequence sourceCode)
void	setSourceData(BigDecimal idValue)	Sets the "source data" of the Java Class.
void	setVersion(int version)
String	upload()
String	upload(Transaction transaction)
void	validate()	The system invokes this method internally whenever the object gets saved to the DB (that means, while doing transactions).
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.JavaInnerClass

getClassData, getClassDataId, getClassStream, getName, getUniqueCondition, indices, setClassData, setName

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, toString, transacting, undelete, undelete, undeleted, updated, user, userId, 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

Constructor Details

JavaClass

public JavaClass(String name)

Constructor

Parameters:

name - Name of the class

JavaClass

public JavaClass()

Constructor for internal use only

Method Details

columns

public static void columns(Columns columns)

displayColumns

public static String[] displayColumns()

searchColumns

public static String[] searchColumns()

create

public static JavaClass create(String name)

checkName

public static boolean checkName(String name)

getVersion

@SetNotAllowed
public int getVersion()

setVersion

public void setVersion(int version)

getNotes

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

setNotes

public void setNotes(String notes)

getSourceDataId

@SetNotAllowed
public Id getSourceDataId()

Gets the Id of the "source data" of this Java Class.

Returns:

The Id of the "source data".

setSourceData

public void setSourceData(BigDecimal idValue)

Sets the "source data" of the Java Class.

Parameters:

idValue - The new "source data" Id.

getSourceData

public StreamData getSourceData()

Gets the "source data" of the Java Class

Returns:

The StreamData object that can provide "source data"

getSourceStream

public InputStream getSourceStream()

Gets the "source data" stream.

Returns:

The source data stream.

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 JavaInnerClass

Parameters:

tm - Current transaction manager.

Throws:

Exception - If data is invalid.

validate

public void validate()
              throws Exception

Description copied from class: StoredObject

The system invokes this method internally whenever the object gets saved to the DB (that means, while doing transactions). It will be invoked in all cases (while creating new objects and updating/deleting/undeleting existing objects). If this method raises any exceptions, the process of saving to the DB will be abandoned.

This method is not usually used for validating data (For that purpose, StoredObject.validateData(TransactionManager) is recommended). It is mainly used for validating the state of the object. Methods such as StoredObject.created(), StoredObject.updated(), StoredObject.deleted(), StoredObject.undeleted() etc., are used to check the specific states, but overridden methods may check for other "application-specific"/"business-specific" states.

This method is invoked only after one of the other operation-specific validate-methods is invoked depending on the save operation - StoredObject.validateInsert(), StoredObject.validateUpdate(), StoredObject.validateDelete(), StoredObject.validateUndelete().

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

Overrides:

validate in class JavaInnerClass

Throws:

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

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.

getInnerClassList

public ObjectIterator<JavaInnerClass> getInnerClassList()

getInnerClassList

public ObjectIterator<JavaInnerClass> getInnerClassList(Transaction transaction)

get

public static JavaClass get(String name)

list

public static ObjectIterator<JavaClass> list(String name)

download

public void download()
              throws Exception

Throws:

Exception

upload

public String upload(Transaction transaction)
              throws Exception

Throws:

Exception

upload

public String upload()
              throws Exception

Throws:

Exception

compile

public String compile()

classChanged

public boolean classChanged(CharSequence sourceCodeToCheck)
                     throws Exception

Throws:

Exception

setSourceCode

public void setSourceCode(CharSequence sourceCode)
                   throws Exception

Throws:

Exception

setGenerated

public void setGenerated(boolean generated)

getGenerated

public boolean getGenerated()

getPackage

public static Package getPackage(String name)

getPackage

public static Package getPackage(Class<?> clazz)

accessed

public void accessed(TransactionManager tm)
              throws Exception

Throws:

Exception

listApplicationClasses

public static List<String> listApplicationClasses()

listSystemClasses

public static List<String> listSystemClasses(char[] securityPassword)