Package com.storedobject.core

Class ClassAttribute<T extends StoredObject>

java.lang.Object

com.storedobject.core.ClassAttribute<T>

Type Parameters:

T - Class type.

public final class ClassAttribute<T extends StoredObject>
extends Object

Class attribute of a StoredObject class contains metadata information about the class that is not applicable to normal Java classes. Metadata information is used for determining the behavior of the object instances when displayed it on the screen, stored in the database etc.

Author:

Syam

Method Summary

Modifier and Type	Method	Description
StringList	browseColumns()	Retrieves a list of column names that can be browsed, taking into account metadata restrictions such as secret fields.
String	browseOrder()	Retrieves the browse order.
StringList	displayColumns()	Retrieves the list of display columns.
Method[]	fileMethods()	Get the "file" methods of this.
static ClassAttribute<?>	get(int family)	Get the class attribute instance for the given family (each StoredObject class has a unique family code).
static <O extends StoredObject> ClassAttribute<O>	get(Class<O> objectClass)	Get the class attribute instance for the given object class.
static <O extends StoredObject> ClassAttribute<O>	get(O object)	Get the class attribute instance for the given object instance.
String	getActionPrefix()	Retrieves the action prefix.
List<String>	getAllAttributes()	Get all attributes that can be used by end-developers (for reporting/displaying etc.)
StringList	getAnchors()	Get anchors defined for this.
StringList	getAttributes()	Get the list of attributes.
StringList	getExtraFields()	Get extra fields of this.
ExtraInfoDefinition	getExtraInfo()
int	getFamily()	Retrieves the family identifier.
UIFieldMetadata	getFieldMetadata(String fieldName)	Get the UI field metadata for a given attribute name.
UIFieldMetadata	getFieldMetadata(String fieldName, boolean external)	Get the UI field metadata for a given attribute name.
String	getFormLayout()	Get the "form layout" information of this.
int	getFormStyle()	Get the "form style" of this.
Method	getMethod(String attributeName)	Get the "get" method for the given attribute.
String	getModuleName()	Get the module name.
Class<T>	getObjectClass()	Class of this.
ClassAttribute<?>	getParent()	Get the parent of this.
String	getTableName()	Get the table name.
String	getTitle()	Get the "title" of this.
int	hints()
int	howBig(boolean any)	Get an indication about how big this database table is.
StringList	links()
<C extends T> List<Class<C>>	listChildClasses(boolean fullTree)	Get the list of child classes of this.
static String	moduleName(Class<? extends StoredObject> objectClass)
StringList	protectedColumns()	Retrieves the list of protected column names.
StringList	searchColumns()	Retrieves the list of search columns to be used in the application.
Method	setMethod(String attributeName)	Get the "set" method for the given attribute.
int	statusUI()
static String	tableName(Class<? extends StoredObject> objectClass)
boolean	writeAllowed(String attributeName)	Whether write is allowed for the given attribute or not.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

writeAllowed

public boolean writeAllowed(String attributeName)

Whether write is allowed for the given attribute or not.

Parameters:

attributeName - Name of the attribute.

Returns:

True/false.

getFieldMetadata

public UIFieldMetadata getFieldMetadata(String fieldName)

Get the UI field metadata for a given attribute name.

Parameters:

fieldName - Name of the attribute.

Returns:

UI field metadata.

getFieldMetadata

public UIFieldMetadata getFieldMetadata(String fieldName,
 boolean external)

Get the UI field metadata for a given attribute name.

Parameters:

fieldName - Name of the attribute.

external - True for considering externally defined metadata.

Returns:

UI field metadata.

getAllAttributes

public List<String> getAllAttributes()

Get all attributes that can be used by end-developers (for reporting/displaying etc.)

Returns:

List of attributes.

getMethod

public Method getMethod(String attributeName)

Get the "get" method for the given attribute.

Parameters:

attributeName - Name of the attribute.

Returns:

"Get" method or null if it doesn't exist.

setMethod

public Method setMethod(String attributeName)

Get the "set" method for the given attribute.

Parameters:

attributeName - Name of the attribute.

Returns:

"Set" method or null if it doesn't exist.

fileMethods

public Method[] fileMethods()

Get the "file" methods of this. File methods are those "get" methods that return StreamData or FileData instances.

Returns:

Array of file methods.

getAttributes

public StringList getAttributes()

Get the list of attributes.

Returns:

Attributes.

getModuleName

public String getModuleName()

Get the module name.

Returns:

Module name.

getTableName

public String getTableName()

Get the table name.

Returns:

Table name.

getObjectClass

public Class<T> getObjectClass()

Class of this.

Returns:

Object class.

listChildClasses

public <C extends T> List<Class<C>> listChildClasses(boolean fullTree)

Get the list of child classes of this.

Type Parameters:

C - Type of child classes.

Parameters:

fullTree - If passed true, the full tree of child classes will be included.

Returns:

List of child classes.

getExtraInfo

public ExtraInfoDefinition getExtraInfo()

getParent

public ClassAttribute<?> getParent()

Get the parent of this.

Returns:

Parent if nay. Otherwise, null is returned.

getFormStyle

public int getFormStyle()

Get the "form style" of this. For internal use only.

Returns:

Form style.

getTitle

public String getTitle()

Get the "title" of this. For internal use only.

Returns:

Title.

getFormLayout

public String getFormLayout()

Get the "form layout" information of this. For internal use only.

Returns:

Form layout information.

getExtraFields

public StringList getExtraFields()

Get extra fields of this. For internal use only.

Returns:

List of extra fields.

howBig

public int howBig(boolean any)

Get an indication about how big this database table is. For internal use only.

Parameters:

any - Whether to check the subclasses or not.

Returns:

Hint about how big the database table is.

getAnchors

public StringList getAnchors()

Get anchors defined for this.

Returns:

List of anchors defined.

get

public static ClassAttribute<?> get(int family)

Get the class attribute instance for the given family (each StoredObject class has a unique family code).

Parameters:

family - Family of the class.

Returns:

Class attribute instance or null if it doesn't exit.

get

public static <O extends StoredObject>
ClassAttribute<O> get(O object)

Get the class attribute instance for the given object instance.

Parameters:

object - Object instance.

Returns:

Class attribute instance or null if it doesn't exit.

get

public static <O extends StoredObject>
ClassAttribute<O> get(Class<O> objectClass)

Get the class attribute instance for the given object class.

Parameters:

objectClass - Object class.

Returns:

Class attribute instance or null if it doesn't exit.

tableName

public static String tableName(Class<? extends StoredObject> objectClass)

moduleName

public static String moduleName(Class<? extends StoredObject> objectClass)

getFamily

public int getFamily()

Retrieves the family identifier.

Returns:

the family identifier as an integer.

getActionPrefix

public String getActionPrefix()

Retrieves the action prefix. If the action prefix is explicitly set and non-empty, it is returned. Otherwise, it attempts to invoke the static and public method `actionPrefixForUI` from the associated class to determine the value. If no valid action prefix is determined, it defaults to null.

Returns:

the action prefix as a non-empty string, or null if no valid prefix is available.

displayColumns

public StringList displayColumns()

Retrieves the list of display columns.

Returns:

A list of display column names as a StringList.

searchColumns

public StringList searchColumns()

Retrieves the list of search columns to be used in the application.

Returns:

A list of search columns after determining and sanitizing the appropriate values.

protectedColumns

public StringList protectedColumns()

Retrieves the list of protected column names. If there are no protected columns, it returns an empty list.

Returns:

a StringList containing protected column names, or an empty StringList if none exist.

browseColumns

public StringList browseColumns()

Retrieves a list of column names that can be browsed, taking into account metadata restrictions such as secret fields. The method ensures that sensitive or secret fields are excluded from the result. If no display columns are defined, it defaults to returning a list containing "Id".

Returns:

A `StringList` representing the columns available for browsing.

browseOrder

public String browseOrder()

Retrieves the browse order.

Returns:

The browse order as a string.

links

public StringList links()

hints

public int hints()

statusUI

public int statusUI()