com.aspc.cms.variable.single

Class SingleValueVariable

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.cms.variable.SiteVariable

com.aspc.cms.variable.single.SingleValueVariable

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

AndVariable, JavaVariable, SiteConfigurationVariable, SqlVariable, SystemVariable, UrlVariable, XPathVariable

public abstract class SingleValueVariable
extends SiteVariable

Single Value Variable ( not JSON).

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

Since:

23 October 2014

Author:

Nigel Leck

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 Single Value Variable ( not JSON)
static java.lang.String	DBCLASS_NAME Single Value Variable ( not JSON)

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

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	calculateResult(WebClient wc, java.util.HashMap<java.lang.String,SiteVariableCalculation> variables, SiteComponent component)
java.lang.String	encodeValue(java.lang.String value)
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) OVERRIDE This method for all objects with derived fields that are NOT linked.
SiteVariableEncoding	findEncoding(java.lang.String... args) The encoding.
java.lang.String	getDefault(java.lang.String... args)
SiteVariableEncoding	getEncoding(java.lang.String... args)
SingleValueVariable	setDefault(java.lang.String value, java.lang.String... args)
SingleValueVariable	setEncoding(com.aspc.dal.cms.variable.SiteVariableEncoding value, java.lang.String... args)

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

calculateJSON, 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, extValidateField, 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

Single Value Variable ( not JSON)

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Single Value Variable ( not JSON)

Constructor Detail

SingleValueVariable

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

getDefault

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

setDefault

@Nonnull
public SingleValueVariable setDefault(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getEncoding

@CheckReturnValue
 @Nullable
public SiteVariableEncoding getEncoding(java.lang.String... args)

findEncoding

@CheckReturnValue
 @Nonnull
public final SiteVariableEncoding findEncoding(java.lang.String... args)
                                                                    throws NotFoundException

The encoding.

--> SiteVariableEncoding (String, Searchable)

Parameters:

args - the optional arguments

Returns:

SiteVariableEncoding

Throws:

NotFoundException - SiteVariableEncoding was not found

setEncoding

@Nonnull
public SingleValueVariable setEncoding(com.aspc.dal.cms.variable.SiteVariableEncoding value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

extGetDerivedValue

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

Description copied from class: DBObject

OVERRIDE This method for all objects with derived fields that are NOT linked. A linked derived field should extend the extGetDerivedGlobalKey.

Overrides:

extGetDerivedValue in class SiteVariable

Parameters:

field - The field to get

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

Returns:

The value of the field.

Throws:

java.lang.Exception - a serious problem

calculateResult

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

Throws:

java.lang.Exception

encodeValue

public java.lang.String encodeValue(java.lang.String value)