com.aspc.DBObj.section

Class DBSectionSqlVariable

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.section.DBSectionVariable

com.aspc.DBObj.section.DBSectionSqlVariable

All Implemented Interfaces:

Variable, SecondaryCacheGroup

public class DBSectionSqlVariable
extends DBSectionVariable

DBSectionSqlVariable Sql Variable.

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

Since:

26 August 2014

Author:

Liam Itzhaki

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 Sql Variable
static java.lang.String	DBCLASS_NAME Sql Variable

Fields inherited from class com.aspc.DBObj.section.DBSectionVariable

DEFAULT_VARIABLE_ENCODE

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.Object	calculateJSON(java.util.List<Variable> variables) calculate JSON
java.lang.String	calculateResult(java.util.List<Variable> vars)
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.
SqlVariableRunAs	findRunAs(java.lang.String... args) Run as access level/current user.
java.lang.String	getQuery(java.lang.String... args)
SqlVariableRunAs	getRunAs(java.lang.String... args)
java.lang.String	getValue(java.util.List<Variable> variables)
int	getVariableColumn(java.lang.String... args)
DBSectionSqlVariable	setQuery(java.lang.String value, java.lang.String... args)
DBSectionSqlVariable	setRunAs(com.aspc.dal.cms.variable.SQLVariableRunAs value, java.lang.String... args)
DBSectionSqlVariable	setVariableColumn(int value, java.lang.String... args)

Methods inherited from class com.aspc.DBObj.section.DBSectionVariable

encodeValue, findEncoding, findKey, findSection, getDefault, getEncoding, getID, getName, getResult, getSection, getSequence, makeQuery, setDefault, setEncoding, setID, setName, setSection, setSequence

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, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, extGetDerivedValue, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidate, 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

Sql Variable

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Sql Variable

Constructor Detail

DBSectionSqlVariable

public DBSectionSqlVariable(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

getQuery

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

setQuery

@Nonnull
public DBSectionSqlVariable setQuery(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getRunAs

@CheckReturnValue
 @Nullable
public SqlVariableRunAs getRunAs(java.lang.String... args)

findRunAs

@CheckReturnValue
 @Nonnull
public final SqlVariableRunAs findRunAs(java.lang.String... args)
                                                             throws NotFoundException

Run as access level/current user.

--> SQLVariableRunAs (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

SQLVariableRunAs

Throws:

NotFoundException - SQLVariableRunAs was not found

setRunAs

@Nonnull
public DBSectionSqlVariable setRunAs(com.aspc.dal.cms.variable.SQLVariableRunAs value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getVariableColumn

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

setVariableColumn

@Nonnull
public DBSectionSqlVariable setVariableColumn(int value,
                                                       java.lang.String... args)
                                                throws java.lang.Exception

Throws:

java.lang.Exception

extValidateField

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

Description copied from class: DBObject

Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.

OVERRIDE this method to add validation to a field but call iValidateField to perform the full validation for a field.

This method should be READ ONLY. Don't create DBObjects here.
When overriding this method the following code stub should be used.
ValidationError ve;
ve = super.extValidateField( field, list);
if( ve != null) return ve;
if( field.getName().equalsIgnoreCase( DBFIELD_FIELD1))
{
return list.createError( DBMessage.LIST_DB_MY_ERROR, this, field);
}
else if( field.getName().equalsIgnoreCase( DBFIELD_FIELD2))
{
....
}

Overrides:

extValidateField in class DBObject

Parameters:

field - The field to be validated

list - The validation list

Returns:

the error or warning.

Throws:

java.lang.Exception - a serious error

calculateJSON

@CheckReturnValue
 @Nonnull
public java.lang.Object calculateJSON(java.util.List<Variable> variables)
                                                           throws java.lang.Exception

calculate JSON

Specified by:

calculateJSON in interface Variable

Overrides:

calculateJSON in class DBSectionVariable

Parameters:

variables -

Returns:

the value

Throws:

java.lang.Exception - a serious problem.

calculateResult

public java.lang.String calculateResult(java.util.List<Variable> vars)
                                 throws java.lang.Exception

Specified by:

calculateResult in interface Variable

Specified by:

calculateResult in class DBSectionVariable

Throws:

java.lang.Exception

getValue

public java.lang.String getValue(java.util.List<Variable> variables)
                          throws java.lang.Exception

Throws:

java.lang.Exception