com.aspc.cms.variable

Class JavaVariable

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.cms.variable.SiteVariable

com.aspc.cms.variable.single.SingleValueVariable

com.aspc.cms.variable.JavaVariable

All Implemented Interfaces:

SecondaryCacheGroup

public class JavaVariable
extends SingleValueVariable

Java Variable.

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

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

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
JavaVariable(DBClass def, DataSource dataSource) Std.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	calculateJSON(WebClient wc, java.util.HashMap variables, SiteComponent component)
java.lang.String	calculateResult(WebClient wc, java.util.HashMap<java.lang.String,SiteVariableCalculation> variables, SiteComponent component)
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for a particular field.
java.lang.String	getJavaClassName(java.lang.String... args)
java.lang.String	getResultJSON(java.lang.String... args)
JavaVariable	setJavaClassName(java.lang.String value, java.lang.String... args)

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

encodeValue, extGetDerivedValue, findEncoding, getDefault, getEncoding, setDefault, setEncoding

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

extGetDerivedGlobalKey, extPreValidate, 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, eventFieldUpdated, 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

Java Variable

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Java Variable

Constructor Detail

JavaVariable

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

getJavaClassName

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

setJavaClassName

@Nonnull
public JavaVariable setJavaClassName(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getResultJSON

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

calculateResult

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

Specified by:

calculateResult in class SingleValueVariable

Throws:

java.lang.Exception

calculateJSON

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

Overrides:

calculateJSON in class SiteVariable

Parameters:

wc - the web client

component -

variables - the variables.

Returns:

the object

Throws:

java.lang.Exception - a serious problem

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