com.aspc.DBObj.Report

Class DBReportClause

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.Report.DBReportClause

All Implemented Interfaces:

SecondaryCacheGroup

public class DBReportClause
extends DBObject

This is a stored query clause which is the basis of the report generator. There maybe one or more clauses per DBCriteria. A report query is made of one or many DBCriteria

Notes

core

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

Since:

May 30, 2001, 2:26 PM

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 This is a stored query clause which is the basis of the report generator.
static java.lang.String	DBCLASS_NAME This is a stored query clause which is the basis of the report generator.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static DBReportClause	create(MutableDataSource mds) Make a new instance of this class.
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) update dependent fields.
protected GlobalKey	extGetDerivedGlobalKey(DBField field, FldParams params) OVERRIDE This method to return a derived global key.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
protected void	extPreDeleteRecord() OVERRIDE this method to add functionality to stSoftware BEFORE deleting a record from the database.
protected void	extPreSaveRecord() OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database.
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.
SeachComparisonType	findComparisonOp(java.lang.String... args) Specifies how searches should compare this value to the results.
DBReportCriteria	findCriteria(java.lang.String... args) Criteria.
DBField	findDerivedTargetField(java.lang.String... args) The target field.
DBClass	findFilterBaseClass(java.lang.String... args) Class that the field path is based on.
static DBReportClause	findKey(DataSource ds, int key) Find the target for this class by the primary key
DBField	findTargetField(java.lang.String... args) Target Field.
DBClassConcrete	getBaseDBClassConcrete() get base class
java.lang.String	getComment(java.lang.String... args)
SeachComparisonType	getComparisonOp(java.lang.String... args)
DBReportCriteria	getCriteria(java.lang.String... args)
DBField	getDerivedTargetField(java.lang.String... args)
java.lang.String	getFieldPathDesc(java.lang.String... args)
DBClass	getFilterBaseClass(java.lang.String... args)
java.lang.String	getFilterFieldParameters(java.lang.String... args)
java.lang.String	getFilterFieldPath(java.lang.String... args)
java.lang.String	getFilterSrcFieldPath(java.lang.String... args)
java.lang.String	getFilterSymbol(java.lang.String... args)
java.lang.String	getFilterValue(java.lang.String... args)
java.lang.String	getFilterValue2(java.lang.String... args)
int	getID(java.lang.String... args)
java.lang.String	getParameters(java.lang.String... args)
java.lang.String	getRawFieldKey(java.lang.String... args)
DBField	getTargetField(java.lang.String... args)
static DBQuery<DBReportClause>	makeQuery(DataSource ds) Make a new QUERY for this class.
DBReportClause	setComment(java.lang.String value, java.lang.String... args)
DBReportClause	setComparisonOp(com.aspc.dal.dbobj.misc.SearchComparisonType value, java.lang.String... args)
DBReportClause	setCriteria(com.aspc.dal.dbobj.report.DBCriteria value, java.lang.String... args)
DBReportClause	setFilterSrcFieldPath(java.lang.String value, java.lang.String... args)
DBReportClause	setFilterSymbol(java.lang.String value, java.lang.String... args)
DBReportClause	setFilterValue(java.lang.String value, java.lang.String... args)
DBReportClause	setFilterValue2(java.lang.String value, java.lang.String... args)
DBReportClause	setID(int value, java.lang.String... args)
DBReportClause	setParameters(java.lang.String value, java.lang.String... args)
DBReportClause	setRawFieldKey(java.lang.String value, java.lang.String... args)
DBReportClause	setTargetField(com.aspc.dal.dbobj.DBField 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, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, 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

This is a stored query clause which is the basis of the report generator. There maybe one or more clauses per DBCriteria. A report query is made of one or many DBCriteria

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

This is a stored query clause which is the basis of the report generator. There maybe one or more clauses per DBCriteria. A report query is made of one or many DBCriteria

Constructor Detail

DBReportClause

public DBReportClause(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 DBReportClause setID(int value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getComment

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

setComment

@Nonnull
public DBReportClause setComment(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getComparisonOp

@CheckReturnValue
 @Nullable
public SeachComparisonType getComparisonOp(java.lang.String... args)

findComparisonOp

@CheckReturnValue
 @Nonnull
public final SeachComparisonType findComparisonOp(java.lang.String... args)
                                                                       throws NotFoundException

Specifies how searches should compare this value to the results.

--> SearchComparisonType (String, Searchable)

Parameters:

args - the optional arguments

Returns:

SearchComparisonType

Throws:

NotFoundException - SearchComparisonType was not found

setComparisonOp

@Nonnull
public DBReportClause setComparisonOp(com.aspc.dal.dbobj.misc.SearchComparisonType value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getCriteria

@CheckReturnValue
 @Nullable
public DBReportCriteria getCriteria(java.lang.String... args)

findCriteria

@CheckReturnValue
 @Nonnull
public final DBReportCriteria findCriteria(java.lang.String... args)
                                                                throws NotFoundException

Criteria.

--> DBCriteria (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

DBCriteria

Throws:

NotFoundException - DBCriteria was not found

setCriteria

@Nonnull
public DBReportClause setCriteria(com.aspc.dal.dbobj.report.DBCriteria value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getDerivedTargetField

@CheckReturnValue
 @Nullable
public DBField getDerivedTargetField(java.lang.String... args)

findDerivedTargetField

@CheckReturnValue
 @Nonnull
public final DBField findDerivedTargetField(java.lang.String... args)
                                                                 throws NotFoundException

The target field.

--> DBField (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

DBField

Throws:

NotFoundException - DBField was not found

getFieldPathDesc

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

getFilterBaseClass

@CheckReturnValue
 @Nullable
public DBClass getFilterBaseClass(java.lang.String... args)

findFilterBaseClass

@CheckReturnValue
 @Nonnull
public final DBClass findFilterBaseClass(java.lang.String... args)
                                                              throws NotFoundException

Class that the field path is based on.

--> DBClass (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

DBClass

Throws:

NotFoundException - DBClass was not found

getFilterFieldParameters

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

getFilterFieldPath

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

getFilterSrcFieldPath

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

setFilterSrcFieldPath

@Nonnull
public DBReportClause setFilterSrcFieldPath(java.lang.String value,
                                                     java.lang.String... args)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

getFilterSymbol

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

setFilterSymbol

@Nonnull
public DBReportClause setFilterSymbol(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getFilterValue

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

setFilterValue

@Nonnull
public DBReportClause setFilterValue(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getFilterValue2

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

setFilterValue2

@Nonnull
public DBReportClause setFilterValue2(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getParameters

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

setParameters

@Nonnull
public DBReportClause setParameters(java.lang.String value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getRawFieldKey

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

setRawFieldKey

@Nonnull
public DBReportClause setRawFieldKey(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getTargetField

@CheckReturnValue
 @Nullable
public DBField getTargetField(java.lang.String... args)

findTargetField

@CheckReturnValue
 @Nonnull
public final DBField findTargetField(java.lang.String... args)
                                                          throws NotFoundException

Target Field.

--> DBField (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

DBField

Throws:

NotFoundException - DBField was not found

setTargetField

@Nonnull
public DBReportClause setTargetField(com.aspc.dal.dbobj.DBField value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static DBReportClause 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<DBReportClause> 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 DBReportClause 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

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

extPreSaveRecord

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

Description copied from class: DBObject

OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database. At this stage the final validation ( internally called by save) has NOT been performed. This is your chance to create other associated records etc. This method is called for all created and modified records NOT deleted. The database transaction has not been started yet. Your changes will NOT be rollback in case of failure.

Overrides:

extPreSaveRecord in class DBObject

Throws:

java.lang.Exception - A Serious problem

extPreDeleteRecord

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

Description copied from class: DBObject

OVERRIDE this method to add functionality to stSoftware BEFORE deleting a record from the database. At this stage the final validation ( internally called by save) has NOT been performed. This is your chance to create other associated records etc. This method is called for all created and modified records NOT deleted. The database transaction has not been started yet. Your changes will NOT be rollback in case of failure.

Overrides:

extPreDeleteRecord in class DBObject

Throws:

java.lang.Exception - A Serious problem

getBaseDBClassConcrete

public DBClassConcrete getBaseDBClassConcrete()

get base class

Returns:

the base class

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

extGetDerivedValue

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

Calculate the derived value for this field.

Overrides:

extGetDerivedValue in class DBObject

Parameters:

field - The field to get

params - The parameters for this field eg. language= or default=

Returns:

the value

Throws:

java.lang.Exception - A serious problem

eventFieldUpdated

@OverridingMethodsMustInvokeSuper
protected void eventFieldUpdated(@Nonnull
                                                                   DBField field,
                                                                   @Nullable
                                                                   java.lang.Object previous,
                                                                   @Nullable
                                                                   GlobalKey previousKey,
                                                                   @Nullable
                                                                   FldParams params)
                                                            throws java.lang.Exception

update dependent fields.

Overrides:

eventFieldUpdated in class DBObject

Parameters:

field - The field updated.

previous - The previous value for this field.

previousKey - The previous key

params - The parameters used

Throws:

java.lang.Exception - a serious problem