com.aspc.DBObj.Report

Class DBReport

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.Report.DBReport

All Implemented Interfaces:

SecondaryCacheGroup

public class DBReport
extends DBObject

A report is a made up of a query and a layout. The query is made up of a series of criteria which is made up of a series of clauses.

Notes

core

data model
THREAD MODE: MIXED, SINGLE-THREADED when called from MutableDataSource else MULTI-THREADED

Since:

May 28, 2001, 10:42 AM

Author:

Jason McGrath

Nested Class Summary

Nested classes/interfaces inherited from class com.aspc.DBObj.DBObject

DBObject.DenormalizeAction

Field Summary

Fields

Modifier and Type	Field and Description
static GlobalId	DBCLASS_GID A report is a made up of a query and a layout.
static java.lang.String	DBCLASS_NAME A report is a made up of a query and a layout.
static java.lang.String	DEBUG_EXTRA_INFO_IN_THREAD System property to control if we should put much more info into the thread name ?
static Version	VERSION

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
DBReport(DBClass def, DataSource dataSource) Std.

Method Summary

Modifier and Type	Method and Description
static DBReport	create(MutableDataSource mds) Make a new instance of this class.
DBReportCriteria	createCriteria() Adds a new criteria to the report
DBResult	doSearch(DataSource rds, DBCriteria prefCriteria, java.lang.String prefSortOrder) Builds a result set based on the settings/criteria on this report
DBResult	doSearch(DataSource rds, DBCriteria prefCriteria, java.lang.String prefSortOrder, SDBReportLayout layout) Builds a result set based on the settings/criteria on this report
DBResult	doSearch(DataSource rds, DBCriteria prefCriteria, java.lang.String prefSortOrder, SDBReportLayout layout, java.lang.Object plugin) Builds a result set based on the settings/criteria on this report
protected void	extCheckDeleteAccess() Additional access checking for delete access of this object.
protected void	extCheckModifyAccess() Additional access checking for write access of this object.
protected GlobalKey	extGetDerivedGlobalKey(DBField field, FldParams params) OVERRIDE This method to return a derived global key.
protected void	extPreValidate() OVERRIDE To add functionality to before validation is called.
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for a particular field.
DBClassAbstract	findBaseClass(java.lang.String... args) The base class.
DBReportFolder	findFolderId(java.lang.String... args) Folder Id.
static DBReport	findKey(DataSource ds, int key) Find the target for this class by the primary key
SDBReportScreen	findLayout(java.lang.String... args) Specifies the report layout to be used when displaying the search results.
DBClassAbstract	findLinkedClass(java.lang.String... args) The linked class.
static java.lang.Object	findPlugin(java.lang.String className) get the plugin
java.lang.String	getAdditionalCriteria(java.lang.String... args)
java.util.Date	getArchiveTS(java.lang.String... args)
java.lang.String	getAttributes(java.lang.String... args)
DBClassAbstract	getBaseClass(java.lang.String... args)
GlobalKey	getBaseClassGid() Determines the GID of the base class
DBClassConcrete	getBaseDBClassConcrete() Determines the class associated with this report
ExportFieldDef[]	getColumns(DBResult result) Determines which columns should appear on a the report
java.lang.String	getDescription(java.lang.String... args)
java.lang.String	getExtraCriteria(java.lang.String... args)
DBReportFolder	getFolderId(java.lang.String... args)
int	getID(java.lang.String... args)
SDBReportScreen	getLayout(java.lang.String... args)
DBClassAbstract	getLinkedClass(java.lang.String... args)
java.lang.String	getName(java.lang.String... args)
int	getOne(java.lang.String... args)
DBQuery	getQuery(DataSource rds, DBCriteria prefCriteria)
java.lang.String	getRawBaseClass(java.lang.String... args)
int	getSeqNr(java.lang.String... args)
java.lang.String	getSortCriteria(java.lang.String... args)
java.lang.String	getSortField(java.lang.String... args)
boolean	isFinalFg(java.lang.String... args)
boolean	isKeyWordCriteria(java.lang.String... args)
boolean	isSortDesc(java.lang.String... args)
DBReportCriteria[]	listCriterias() Returns the list of criteria associated with this report
static DBQuery<DBReport>	makeQuery(DataSource ds) Make a new QUERY for this class.
DBReport	setAdditionalCriteria(java.lang.String value, java.lang.String... args)
DBReport	setArchiveTS(java.util.Date value, java.lang.String... args)
DBReport	setAttributes(java.lang.String value, java.lang.String... args)
DBReport	setBaseClass(com.aspc.dal.dbobj.DBClassAbstract value, java.lang.String... args)
DBReport	setDescription(java.lang.String value, java.lang.String... args)
DBReport	setExtraCriteria(java.lang.String value, java.lang.String... args)
DBReport	setFinalFg(boolean value, java.lang.String... args)
DBReport	setFolderId(com.aspc.dal.dbobj.folders.DBReportFolder value, java.lang.String... args)
DBReport	setID(int value, java.lang.String... args)
DBReport	setKeyWordCriteria(boolean value, java.lang.String... args)
DBReport	setLayout(com.supertracker.dal.screenobj.SDBReportScreen value, java.lang.String... args)
DBReport	setName(java.lang.String value, java.lang.String... args)
DBReport	setRawBaseClass(java.lang.String value, java.lang.String... args)
DBReport	setSeqNr(int value, java.lang.String... args)
DBReport	setSortCriteria(java.lang.String value, java.lang.String... args)
DBReport	setSortDesc(boolean value, java.lang.String... args)
DBReport	setSortField(java.lang.String value, java.lang.String... args)

Methods inherited from class com.aspc.DBObj.DBObject

addReloadEventListener, archiveCheck, autoEnterCreate, calculateValue, calculateValue, calculateValue, callingRestoreByJournal, changeThreadMode, checkCreateAccess, checkDelete, checkDeleteAccess, checkModifyAccess, checkModifyAccess, checkReadAccess, clearCache, copy, copyFields, copyIncludeField, copyInwardLinks, delete, denormalizedResult, displayLogName, displayName, displayValue, doSearch, dump, equals, eventDataLoaded, eventFieldUpdated, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetDerivedValue, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, extValidateRecord, fetchLinkHolder, findGlobalKey, findGlobalKey, findGlobalKey, findGlobalKey, findLinkedObject, findLinkedObject, findLinkedObject, findRawData, fireEventDataLoaded, fixUp, forceLockedTransaction, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getChangedFieldInfo, getChangedFields, getDate, getDate, getDate, getDate, getDate, getDefaultValue, getDisableOnChangeEvent, getDouble, getDouble, getDouble, getDouble, getDouble, getFieldDouble, getFieldInt, getFieldLong, getFieldString, getFormattedString, getFormattedString, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getInt, getInt, getInt, getInt, getInt, getInt, getInwardLinkage, getKeyString, getKeyValue, getLinkedObject, getLinkedObject, getLinkedObject, getLinkedObjectByKey, getLinkedRowId, getLinkedRowId, getLinkedRowIdByData, getLinkHolder, getLockedTransaction, getLong, getLong, getLong, getLong, getLong, getLong, getMutableArrayValue, getMutableArrayValue, getOriginalKey, getOriginalValue, getOriginalValue, getProcessedValue, getPureValue, getRawData, getRawValue, getRawValue, getRowId, getRowKey, getSecondaryCacheGroupKey, getSrcLayerID, getString, getString, getString, getString, getString, getString, getValue, getValue, getValue, getValue, hasAutoChanged, hasAutoChanged, hasChanged, hasChangedByUser, hasChangedByUserField, hasChangedByUserField, hasFieldChanged, hasFieldChanged, hashCode, hasStoredResult, iCheckDeleteAccess, iCheckModifyAccess, iCheckReadAccess, iGetDenormalizedMap, iGetRawValue, iPlaceDenormalizedResult, iPostSaveOrDeleteRecord, iPreSaveOrDeleteRecord, iPreValidate, iRaiseEvents, iSaveOrDeleteRecord, isBrokenLink, isBrokenLink, isChanged, isDataCacheKnownToBeDirty, isDeleted, isEmpty, iSetValue, isForceReindex, isKeyWordField, isMandatory, isNew, isNull, isNull, isOnChange, isReindex, iValidateRecord, lastTouched, makeArchiveDataLoader, makeClone, makeDataLoader, makeDenormalizedDoc, makeLinkedArray, makeModifyAccessException, makeSearchPlan, makeWriteProvider, manualDenormalizeOnSave, markSavePoint, optLockedTransaction, registerWatchedObject, reindex, releaseDenormalized, removeReloadEventListener, restoreByJournal, rollbackTo, setBoolean, setBoolean, setBoolean, setBoolean, setDisableOnChangeEvent, setDouble, setDouble, setInt, setInt, setLong, setLong, setRawData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, touch, undelete, validateField, validateRecord, validateSubType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

A report is a made up of a query and a layout. The query is made up of a series of criteria which is made up of a series of clauses.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

A report is a made up of a query and a layout. The query is made up of a series of criteria which is made up of a series of clauses.

DEBUG_EXTRA_INFO_IN_THREAD

public static final java.lang.String DEBUG_EXTRA_INFO_IN_THREAD

System property to control if we should put much more info into the thread name ?

See Also:

Constant Field Values

VERSION

public static final Version VERSION

Constructor Detail

DBReport

public DBReport(DBClass def,
                DataSource dataSource)
         throws java.lang.Exception

Std. DBObject constructor.

Parameters:

def - The class of this object

dataSource - The datasource for this object

Throws:

java.lang.Exception - A serious problem occurred

Method Detail

getID

@CheckReturnValue
public int getID(java.lang.String... args)

setID

@Nonnull
public DBReport setID(int value,
                               java.lang.String... args)
                        throws java.lang.Exception

Throws:

java.lang.Exception

getAdditionalCriteria

@CheckReturnValue
 @Nonnull
public java.lang.String getAdditionalCriteria(java.lang.String... args)

setAdditionalCriteria

@Nonnull
public DBReport setAdditionalCriteria(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getArchiveTS

@CheckReturnValue
 @Nullable
public java.util.Date getArchiveTS(java.lang.String... args)

setArchiveTS

@Nonnull
public DBReport setArchiveTS(java.util.Date value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getAttributes

@CheckReturnValue
 @Nonnull
public java.lang.String getAttributes(java.lang.String... args)

setAttributes

@Nonnull
public DBReport setAttributes(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getBaseClass

@CheckReturnValue
 @Nullable
public DBClassAbstract getBaseClass(java.lang.String... args)

findBaseClass

@CheckReturnValue
 @Nonnull
public final DBClassAbstract findBaseClass(java.lang.String... args)
                                                                throws NotFoundException

The base class.

--> DBClassAbstract (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

DBClassAbstract

Throws:

NotFoundException - DBClassAbstract was not found

setBaseClass

@Nonnull
public DBReport setBaseClass(com.aspc.dal.dbobj.DBClassAbstract value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getDescription

@CheckReturnValue
 @Nonnull
public java.lang.String getDescription(java.lang.String... args)

setDescription

@Nonnull
public DBReport setDescription(java.lang.String value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getExtraCriteria

@CheckReturnValue
 @Nonnull
public java.lang.String getExtraCriteria(java.lang.String... args)

setExtraCriteria

@Nonnull
public DBReport setExtraCriteria(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

isFinalFg

@CheckReturnValue
public boolean isFinalFg(java.lang.String... args)

setFinalFg

@Nonnull
public DBReport setFinalFg(boolean value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getFolderId

@CheckReturnValue
 @Nullable
public DBReportFolder getFolderId(java.lang.String... args)

findFolderId

@CheckReturnValue
 @Nonnull
public final DBReportFolder findFolderId(java.lang.String... args)
                                                              throws NotFoundException

Folder Id.

--> DBReportFolder (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

DBReportFolder

Throws:

NotFoundException - DBReportFolder was not found

setFolderId

@Nonnull
public DBReport setFolderId(com.aspc.dal.dbobj.folders.DBReportFolder value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

isKeyWordCriteria

@CheckReturnValue
public boolean isKeyWordCriteria(java.lang.String... args)

setKeyWordCriteria

@Nonnull
public DBReport setKeyWordCriteria(boolean value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getLayout

@CheckReturnValue
 @Nullable
public SDBReportScreen getLayout(java.lang.String... args)

findLayout

@CheckReturnValue
 @Nonnull
public final SDBReportScreen findLayout(java.lang.String... args)
                                                             throws NotFoundException

Specifies the report layout to be used when displaying the search results.

--> SDBReportScreen (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

SDBReportScreen

Throws:

NotFoundException - SDBReportScreen was not found

setLayout

@Nonnull
public DBReport setLayout(com.supertracker.dal.screenobj.SDBReportScreen value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getLinkedClass

@CheckReturnValue
 @Nullable
public DBClassAbstract getLinkedClass(java.lang.String... args)

findLinkedClass

@CheckReturnValue
 @Nonnull
public final DBClassAbstract findLinkedClass(java.lang.String... args)
                                                                  throws NotFoundException

The linked class.

--> DBClassAbstract (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

DBClassAbstract

Throws:

NotFoundException - DBClassAbstract was not found

getName

@CheckReturnValue
 @Nonnull
public java.lang.String getName(java.lang.String... args)

setName

@Nonnull
public DBReport setName(java.lang.String value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getOne

@CheckReturnValue
public int getOne(java.lang.String... args)

getRawBaseClass

@CheckReturnValue
 @Nonnull
public java.lang.String getRawBaseClass(java.lang.String... args)

setRawBaseClass

@Nonnull
public DBReport setRawBaseClass(java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getSeqNr

@CheckReturnValue
public int getSeqNr(java.lang.String... args)

setSeqNr

@Nonnull
public DBReport setSeqNr(int value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:

java.lang.Exception

getSortCriteria

@CheckReturnValue
 @Nonnull
public java.lang.String getSortCriteria(java.lang.String... args)

setSortCriteria

@Nonnull
public DBReport setSortCriteria(java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

isSortDesc

@CheckReturnValue
public boolean isSortDesc(java.lang.String... args)

setSortDesc

@Nonnull
public DBReport setSortDesc(boolean value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getSortField

@CheckReturnValue
 @Nonnull
public java.lang.String getSortField(java.lang.String... args)

setSortField

@Nonnull
public DBReport setSortField(java.lang.String value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static DBReport create(@Nonnull
                                                          MutableDataSource mds)
                                                   throws java.lang.Exception

Make a new instance of this class.

Parameters:

mds - the datasource

Returns:

the new record

Throws:

java.lang.Exception - an object of this class could not be created

makeQuery

@Nonnull
 @CheckReturnValue
public static DBQuery<DBReport> makeQuery(@Nonnull
                                                                      DataSource ds)
                                                               throws NotFoundException

Make a new QUERY for this class.

Parameters:

ds - the datasource

Returns:

the new QUERY

Throws:

NotFoundException - if class could not be found

findKey

@Nonnull
 @CheckReturnValue
public static DBReport findKey(@Nonnull
                                                           DataSource ds,
                                                           int key)
                                                    throws NotFoundException,
                                                           java.lang.Exception

Find the target for this class by the primary key

Parameters:

ds - the datasource

key - the value

Returns:

the target

Throws:

NotFoundException - if target could not be found

java.lang.Exception - a serious problem

createCriteria

public DBReportCriteria createCriteria()

Adds a new criteria to the report

Returns:

- new criteria

getBaseDBClassConcrete

@Nullable
 @CheckReturnValue
public DBClassConcrete getBaseDBClassConcrete()

Determines the class associated with this report

Returns:

- the Base DBClass object

getBaseClassGid

public GlobalKey getBaseClassGid()

Determines the GID of the base class

Returns:

- Base Class Gid

extGetDerivedGlobalKey

@CheckReturnValue
 @Nullable
protected GlobalKey extGetDerivedGlobalKey(@Nonnull
                                                                        DBField field,
                                                                        @Nullable
                                                                        FldParams params)
                                                                 throws java.lang.Exception

Description copied from class: DBObject

OVERRIDE This method to return a derived global key. This method is only checked if the field is marked as being linked.

Overrides:

extGetDerivedGlobalKey in class DBObject

Parameters:

field - The field that is being changed

params - The extra parameters

Returns:

The Global key

Throws:

java.lang.Exception - A serious problem. In general validation is done later.

extPreValidate

@OverridingMethodsMustInvokeSuper
protected void extPreValidate()
                                                         throws java.lang.Exception

Description copied from class: DBObject

OVERRIDE To add functionality to before validation is called.

THIS IS YOUR LAST CHANCE TO MAKE CHANGES BEFORE VALIDATIONS.

Overrides:

extPreValidate in class DBObject

Throws:

java.lang.Exception - a serious problem

extCheckModifyAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckModifyAccess()
                                                               throws DBAccessException

Description copied from class: DBObject

Additional access checking for write access of this object.

Overrides:

extCheckModifyAccess in class DBObject

Throws:

DBAccessException - No access to modify

extCheckDeleteAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckDeleteAccess()
                                                               throws DBAccessException

Description copied from class: DBObject

Additional access checking for delete access of this object.

Overrides:

extCheckDeleteAccess in class DBObject

Throws:

DBAccessException - No access to delete

listCriterias

public DBReportCriteria[] listCriterias()
                                 throws java.lang.Exception

Returns the list of criteria associated with this report

Returns:

- an array of DBReportCriteria object linked to this report

Throws:

java.lang.Exception - - a serious error

extValidateField

@CheckReturnValue
 @OverridingMethodsMustInvokeSuper
 @Nullable
protected ValidationError extValidateField(@Nonnull
                                                                                                           DBField field,
                                                                                                           @Nonnull
                                                                                                           ValidationList list)
                                                                                                    throws java.lang.Exception

Additional validation for a particular field.

Overrides:

extValidateField in class DBObject

Parameters:

list - The validation list

field - The field to be validated

Returns:

The validation error

Throws:

java.lang.Exception - A serious problem

doSearch

public DBResult doSearch(DataSource rds,
                         DBCriteria prefCriteria,
                         java.lang.String prefSortOrder)
                  throws java.lang.Exception

Builds a result set based on the settings/criteria on this report

Parameters:

prefCriteria - preferred criteria

prefSortOrder - preference sort order

rds - - the datasource to be used when searching

Returns:

- the results of the search

Throws:

java.lang.Exception - - a serious error

doSearch

public DBResult doSearch(DataSource rds,
                         DBCriteria prefCriteria,
                         java.lang.String prefSortOrder,
                         SDBReportLayout layout)
                  throws java.lang.Exception

Builds a result set based on the settings/criteria on this report

Parameters:

prefCriteria - preferred criteria

prefSortOrder - preference sort order

rds - - the datasource to be used when searching

layout - The SDBReportLayout

Returns:

- the results of the search

Throws:

java.lang.Exception - - a serious error

doSearch

public final DBResult doSearch(DataSource rds,
                               DBCriteria prefCriteria,
                               java.lang.String prefSortOrder,
                               SDBReportLayout layout,
                               java.lang.Object plugin)
                        throws java.lang.Exception

Builds a result set based on the settings/criteria on this report

Parameters:

prefCriteria - preferred criteria

prefSortOrder - preference sort order

rds - - the datasource to be used when searching

layout - The SDBReportLayout

plugin - SDBReportScreen plugin

Returns:

- the results of the search

Throws:

java.lang.Exception - - a serious error

getQuery

public DBQuery getQuery(DataSource rds,
                        DBCriteria prefCriteria)
                 throws java.lang.Exception

Throws:

java.lang.Exception

getColumns

public ExportFieldDef[] getColumns(DBResult result)
                            throws java.lang.Exception

Determines which columns should appear on a the report

Parameters:

result - - The result set that contains the

Returns:

the columns

Throws:

java.lang.Exception - a serious problem

findPlugin

public static java.lang.Object findPlugin(@Nullable
                                          java.lang.String className)
                                   throws java.lang.Exception

get the plugin

Parameters:

className - the class name

Returns:

the plugin

Throws:

java.lang.Exception - a serious problem