com.aspc.cms.variable

Class SqlVariable

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.cms.variable.SiteVariable

com.aspc.cms.variable.single.SingleValueVariable

com.aspc.cms.variable.SqlVariable

All Implemented Interfaces:

SecondaryCacheGroup

Deprecated.

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

public class SqlVariable
extends SingleValueVariable

SQL variable
Deprecated, use RestVariable instead.

Since:

02 May 2013

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 Deprecated. SQL variable Deprecated, use RestVariable instead
static java.lang.String	DBCLASS_NAME Deprecated. SQL variable Deprecated, use RestVariable instead

Fields inherited from class com.aspc.cms.variable.SiteVariable

DEFAULT_VARIABLE_ENCODE, WEB_CLIENT

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.Object	calculateJSON(WebClient wc, java.util.HashMap<java.lang.String,SiteVariableCalculation> variables, SiteComponent component) Deprecated.
java.lang.String	calculateResult(WebClient wc, java.util.HashMap<java.lang.String,SiteVariableCalculation> vars, SiteComponent component) Deprecated.
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) Deprecated. update dependent fields.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Deprecated. Calculate the derived value for this field.
protected void	extPreValidate() Deprecated. Update the in-memory universe BEFORE validating
protected ValidationError	extValidateField(DBField field, ValidationList list) Deprecated. Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.
SqlVariableRunAs	findRunAs(java.lang.String... args) Deprecated. Run as access level/current user.
Login	findRunAsLogin(java.lang.String... args) Deprecated.
java.lang.String	getPage(java.lang.String... args) Deprecated.
java.lang.String	getPageSize(java.lang.String... args) Deprecated.
java.lang.String	getQuery(java.lang.String... args) Deprecated.
java.lang.String	getResultJSON(java.lang.String... args) Deprecated.
SqlVariableRunAs	getRunAs(java.lang.String... args) Deprecated.
Login	getRunAsLogin(java.lang.String... args) Deprecated.
int	getVariableColumn(java.lang.String... args) Deprecated.
SqlVariable	setPage(java.lang.String value, java.lang.String... args) Deprecated.
SqlVariable	setPageSize(java.lang.String value, java.lang.String... args) Deprecated.
SqlVariable	setQuery(java.lang.String value, java.lang.String... args) Deprecated.
SqlVariable	setRunAs(com.aspc.dal.cms.variable.SQLVariableRunAs value, java.lang.String... args) Deprecated.
SqlVariable	setRunAsLogin(com.aspc.dal.dbobj.contact.Login value, java.lang.String... args) Deprecated.
SqlVariable	setVariableColumn(int value, java.lang.String... args) Deprecated.

Methods inherited from class com.aspc.cms.variable.single.SingleValueVariable

encodeValue, findEncoding, getDefault, getEncoding, setDefault, setEncoding

Methods inherited from class com.aspc.cms.variable.SiteVariable

extGetDerivedGlobalKey, extValidateRecord, findComponent, findInheritedByComponent, findKey, findOwnedBySite, findSite, getComponent, getID, getInheritedByComponent, getLabel, getName, getOwnedBySite, getPath, getResult, getSequence, getSite, isVisibleToThisComponent, makeQuery, setComponent, setID, setLabel, setName, setSequence, setSite

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, extPreDeleteRecord, extPreSaveRecord, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, 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

Deprecated.

SQL variable
Deprecated, use RestVariable instead

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Deprecated.

SQL variable
Deprecated, use RestVariable instead

Constructor Detail

SqlVariable

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

Deprecated.

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

getPage

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

Deprecated.

setPage

@Nonnull
public SqlVariable setPage(java.lang.String value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

getPageSize

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

Deprecated.

setPageSize

@Nonnull
public SqlVariable setPageSize(java.lang.String value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

getQuery

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

Deprecated.

setQuery

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

Deprecated.

Throws:

java.lang.Exception

getResultJSON

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

Deprecated.

getRunAs

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

Deprecated.

findRunAs

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

Deprecated.

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 SqlVariable setRunAs(com.aspc.dal.cms.variable.SQLVariableRunAs value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

getRunAsLogin

@Deprecated
 @CheckReturnValue
 @Nullable
public Login getRunAsLogin(java.lang.String... args)

Deprecated.

findRunAsLogin

@CheckReturnValue
 @Deprecated
 @Nonnull
public final Login findRunAsLogin(java.lang.String... args)
                                                                    throws NotFoundException

Deprecated.

Run as login.

--> Login (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Login

Throws:

NotFoundException - Login was not found

setRunAsLogin

@Deprecated
 @Nonnull
public SqlVariable setRunAsLogin(com.aspc.dal.dbobj.contact.Login value,
                                                       java.lang.String... args)
                                                throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

getVariableColumn

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

Deprecated.

setVariableColumn

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

Deprecated.

Throws:

java.lang.Exception

extGetDerivedValue

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

Deprecated.

Calculate the derived value for this field.

Overrides:

extGetDerivedValue in class SingleValueVariable

Parameters:

field - The field to get

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

Returns:

The calculated value

Throws:

java.lang.Exception - A serious problem

calculateResult

public java.lang.String calculateResult(WebClient wc,
                                        java.util.HashMap<java.lang.String,SiteVariableCalculation> vars,
                                        SiteComponent component)
                                 throws java.lang.Exception

Deprecated.

Specified by:

calculateResult in class SingleValueVariable

Throws:

java.lang.Exception

extValidateField

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

Deprecated.

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

public java.lang.Object calculateJSON(WebClient wc,
                                      java.util.HashMap<java.lang.String,SiteVariableCalculation> variables,
                                      SiteComponent component)
                               throws java.lang.Exception

Deprecated.

Overrides:

calculateJSON in class SiteVariable

Parameters:

wc - the web client

variables -

component -

Returns:

the object

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

Deprecated.

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

extPreValidate

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

Deprecated.

Update the in-memory universe BEFORE validating

Overrides:

extPreValidate in class SiteVariable

Throws:

java.lang.Exception - A serious problem