Package com.storedobject.core

Class ReportDefinition

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.Name

com.storedobject.core.ReportDefinition

All Implemented Interfaces:

Displayable, HasName, StringFiller, HasId

@Table(tab="Report Definition")
public class ReportDefinition
extends Name

Field Summary

Fields inherited from class com.storedobject.core.Name

name

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
ReportDefinition()

Method Summary

Modifier and Type	Method	Description
static void	columns(Columns columns)
static ReportDefinition	create(Class<? extends StoredObject> dataClass, Iterable<String> columns)
static ReportDefinition	create(Class<? extends StoredObject> dataClass, String... columns)
static ReportDefinition	get(String name)
int	getBaseFontSize()
String	getBaseFontSizeValue()
static String	getBaseFontSizeValue(int value)
static String[]	getBaseFontSizeValues()
Class<? extends StoredObject>	getClassForData()
Class<? extends Executable>	getClassForLogic(boolean excel)
final List<ReportColumnDefinition>	getColumns()
String	getCondition()	Set the condition to be applied while retrieving the object instances from the database.
String	getDataClass()
String	getDescription()
String	getFilter()	Get the filter variables with comparison indicators.
boolean	getIncludeSubclasses()
String	getLogicClass()
String	getOrderBy()
int	getOrientation()
String	getOrientationValue()
static String	getOrientationValue(int value)
static String[]	getOrientationValues()
boolean	getPrintDescription()
<T extends StoredObject> QueryBuilder<T>	getQueryBuilder()
<T extends StoredObject> QueryBuilder<T>	getQueryBuilder(String extraCondition)
<T extends StoredObject> QueryBuilder<T>	getQueryBuilder(String extraCondition, String orderBy)
String	getTitle()
static int	hints()
static void	indices(Indices indices)
static String[]	links()
static ObjectIterator<ReportDefinition>	list(String name)
<T extends StoredObject> ObjectIterator<T>	listObjects()
<T extends StoredObject> ObjectIterator<T>	listObjects(String extraCondition)
<T extends StoredObject> ObjectIterator<T>	listObjects(String extraCondition, String orderBy)
void	setBaseFontSize(int baseFontSize)
void	setCondition(String condition)	Set the condition to be applied while retrieving the object instances from the database.
void	setCustomColumnSupplier(Supplier<StringList> customColumnSupplier)
void	setDataClass(String dataClass)
void	setDescription(String description)
void	setExecutable(Executable executable)
void	setFilter(String filter)	Set the filter variables with filter conditions.
void	setIncludeSubclasses(boolean includeSubclasses)
void	setLogicClass(String logicClass)
void	setOrderBy(String orderBy)
void	setOrientation(int orientation)
void	setPrintDescription(boolean printDescription)
void	setTitle(String title)
void	validateData(TransactionManager tm)	This will be invoked by the system whenever the object is saved to the DB.

Methods inherited from class com.storedobject.core.Name

getName, getUniqueCondition, setName, toString

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, fill, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, getAttachment, getAttachmentId, getChildren, 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, 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, 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, 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

ReportDefinition

public ReportDefinition()

Method Details

columns

public static void columns(Columns columns)

indices

public static void indices(Indices indices)

get

public static ReportDefinition get(String name)

list

public static ObjectIterator<ReportDefinition> list(String name)

hints

public static int hints()

links

public static String[] links()

setTitle

public void setTitle(String title)

getTitle

@Column(order=200)
public String getTitle()

setDescription

public void setDescription(String description)

getDescription

@Column(style="(large)",
        order=300)
public String getDescription()

setPrintDescription

public void setPrintDescription(boolean printDescription)

getPrintDescription

@Column(order=400)
public boolean getPrintDescription()

setDataClass

public void setDataClass(String dataClass)

getDataClass

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

setIncludeSubclasses

public void setIncludeSubclasses(boolean includeSubclasses)

getIncludeSubclasses

@Column(order=600)
public boolean getIncludeSubclasses()

setCondition

public void setCondition(String condition)

Set the condition to be applied while retrieving the object instances from the database.

Parameters:

condition - SQL-style condition.

getCondition

@Column(style="(large)",
        required=false,
        order=700,
        caption="SQL-style Condition")
public String getCondition()

Set the condition to be applied while retrieving the object instances from the database.

Returns:

SQL-style condition.

setFilter

public void setFilter(String filter)

Set the filter variables with filter conditions.

The filter variables are defined in separate lines. Each filter variable can be specified as just the attribute name or the attribute name followed by its comparison indicators.

Comparison indicators specify how the comparison is done. It is indicated by 2 characters - "EQ" for "equal to", "LT" for "less than", "GT" for "greater than", "LE" for "less than or equal to", "NE" for "not equal to" etc. If an invalid comparison indicator is specified or if no indicator is specified, "EQ" is assumed. The comparison indicator must be separated from the field attribute by a slash "/" character. A star "*" (asterisk character) may be added to indicate that the field is mandatory when value is being accepted from the user.

 Example: (Assuming Person as the data class)
 Age/LT*
 Example: (Assuming Person as the data class)
 Gender/EQ
 Age/GT
 

The captions of the filter fields may be customized by adding " AS " followed by the customized caption.

 Example: (Assuming Person as the data class)
 Gender/EQ AS Gender equal to
 Age/GT AS Age greater than
 

Sub-fields may be accessed using the platform-specific "dot" notation.

 Example: (Assuming SystemUser as the data class)
 Person.Gender/EQ AS Gender equal to
 

Parameters:

filter - Filter variable details.

getFilter

@Column(style="(large)",
        required=false,
        order=800,
        caption="Attributes with Comparison Indicators")
public String getFilter()

Get the filter variables with comparison indicators. (See setFilter(String)).

Returns:

Filter variable details.

setOrderBy

public void setOrderBy(String orderBy)

getOrderBy

@Column(required=false,
        order=900)
public String getOrderBy()

setLogicClass

public void setLogicClass(String logicClass)

getLogicClass

@Column(required=false,
        order=1000)
public String getLogicClass()

setBaseFontSize

public void setBaseFontSize(int baseFontSize)

getBaseFontSize

@Column(order=1100)
public int getBaseFontSize()

getBaseFontSizeValues

public static String[] getBaseFontSizeValues()

getBaseFontSizeValue

public static String getBaseFontSizeValue(int value)

getBaseFontSizeValue

public String getBaseFontSizeValue()

setOrientation

public void setOrientation(int orientation)

getOrientation

@Column(order=1200)
public int getOrientation()

getOrientationValues

public static String[] getOrientationValues()

getOrientationValue

public static String getOrientationValue(int value)

getOrientationValue

public String getOrientationValue()

validateData

public void validateData(TransactionManager tm)
                  throws Exception

Description copied from class: StoredObject

This will be invoked by the system whenever the object is saved to the DB. It will be invoked in all cases, while creating new objects and updating/deleting/un-deleting 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 Name

Parameters:

tm - Current transaction manager.

Throws:

Exception - If data is invalid.

getClassForData

public Class<? extends StoredObject> getClassForData()

getClassForLogic

public Class<? extends Executable> getClassForLogic(boolean excel)

getColumns

public final List<ReportColumnDefinition> getColumns()

create

public static ReportDefinition create(Class<? extends StoredObject> dataClass,
 String... columns)

create

public static ReportDefinition create(Class<? extends StoredObject> dataClass,
 Iterable<String> columns)

setExecutable

public void setExecutable(Executable executable)

setCustomColumnSupplier

public void setCustomColumnSupplier(Supplier<StringList> customColumnSupplier)

listObjects

public <T extends StoredObject> ObjectIterator<T> listObjects()

listObjects

public <T extends StoredObject> ObjectIterator<T> listObjects(String extraCondition)

listObjects

public <T extends StoredObject> ObjectIterator<T> listObjects(String extraCondition,
 String orderBy)

getQueryBuilder

public <T extends StoredObject> QueryBuilder<T> getQueryBuilder()

getQueryBuilder

public <T extends StoredObject> QueryBuilder<T> getQueryBuilder(String extraCondition)

getQueryBuilder

public <T extends StoredObject> QueryBuilder<T> getQueryBuilder(String extraCondition,
 String orderBy)