com.aspc.cms.variable

Class SiteVariable

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.cms.variable.SiteVariable

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

JSONResultVariable, SingleValueVariable

public abstract class SiteVariable
extends DBObject

Site Component 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 Site Component Variable
static java.lang.String	DBCLASS_NAME Site Component Variable
static java.lang.ThreadLocal<java.lang.String>	DEFAULT_VARIABLE_ENCODE
static java.lang.ThreadLocal<WebClient>	WEB_CLIENT

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
SiteVariable(DBClass def, DataSource dataSource) 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)
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) OVERRIDE This method for all objects with derived fields that are NOT linked.
protected void	extPreValidate() OVERRIDE To add functionality to before validation is called.
protected void	extValidateRecord(ValidationList list) Performs additional validations on this record.
SiteComponent	findComponent(java.lang.String... args) The site component.
SiteComponent	findInheritedByComponent(java.lang.String... args) This variable is inherited by this component.
static SiteVariable	findKey(DataSource ds, int key) Find the target for this class by the primary key
Site	findOwnedBySite(java.lang.String... args) Owned By Site.
Site	findSite(java.lang.String... args) The site for this variable.
SiteComponent	getComponent(java.lang.String... args)
int	getID(java.lang.String... args)
SiteComponent	getInheritedByComponent(java.lang.String... args)
java.lang.String	getLabel(java.lang.String... args)
java.lang.String	getName(java.lang.String... args)
Site	getOwnedBySite(java.lang.String... args)
java.lang.String	getPath(java.lang.String... args)
java.lang.String	getResult(java.lang.String... args)
int	getSequence(java.lang.String... args)
Site	getSite(java.lang.String... args)
boolean	isVisibleToThisComponent(java.lang.String... args)
static DBQuery<SiteVariable>	makeQuery(DataSource ds) Make a new QUERY for this class.
SiteVariable	setComponent(com.aspc.dal.cms.SiteComponent value, java.lang.String... args)
SiteVariable	setID(int value, java.lang.String... args)
SiteVariable	setLabel(java.lang.String value, java.lang.String... args)
SiteVariable	setName(java.lang.String value, java.lang.String... args)
SiteVariable	setSequence(int value, java.lang.String... args)
SiteVariable	setSite(com.aspc.dal.cms.Site 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, 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

Site Component Variable

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Site Component Variable

DEFAULT_VARIABLE_ENCODE

public static final java.lang.ThreadLocal<java.lang.String> DEFAULT_VARIABLE_ENCODE

WEB_CLIENT

public static final java.lang.ThreadLocal<WebClient> WEB_CLIENT

Constructor Detail

SiteVariable

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

Throws:

java.lang.Exception

getLabel

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

setLabel

@Nonnull
public SiteVariable setLabel(java.lang.String value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getComponent

@CheckReturnValue
 @Nullable
public SiteComponent getComponent(java.lang.String... args)

findComponent

@CheckReturnValue
 @Nonnull
public final SiteComponent findComponent(java.lang.String... args)
                                                              throws NotFoundException

The site component.

--> SiteComponent (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

SiteComponent

Throws:

NotFoundException - SiteComponent was not found

setComponent

@Nonnull
public SiteVariable setComponent(com.aspc.dal.cms.SiteComponent value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getInheritedByComponent

@CheckReturnValue
 @Nullable
public SiteComponent getInheritedByComponent(java.lang.String... args)

findInheritedByComponent

@CheckReturnValue
 @Nonnull
public final SiteComponent findInheritedByComponent(java.lang.String... args)
                                                                         throws NotFoundException

This variable is inherited by this component.

--> SiteComponent (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

SiteComponent

Throws:

NotFoundException - SiteComponent was not found

getName

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

setName

@Nonnull
public SiteVariable setName(java.lang.String value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getOwnedBySite

@CheckReturnValue
 @Nullable
public Site getOwnedBySite(java.lang.String... args)

findOwnedBySite

@CheckReturnValue
 @Nonnull
public final Site findOwnedBySite(java.lang.String... args)
                                                       throws NotFoundException

Owned By Site.

--> Site (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

Site

Throws:

NotFoundException - Site was not found

getPath

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

getResult

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

getSequence

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

setSequence

@Nonnull
public SiteVariable setSequence(int value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getSite

@CheckReturnValue
 @Nullable
public Site getSite(java.lang.String... args)

findSite

@CheckReturnValue
 @Nonnull
public final Site findSite(java.lang.String... args)
                                                throws NotFoundException

The site for this variable.

--> Site (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Site

Throws:

NotFoundException - Site was not found

setSite

@Nonnull
public SiteVariable setSite(com.aspc.dal.cms.Site value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

isVisibleToThisComponent

@CheckReturnValue
public boolean isVisibleToThisComponent(java.lang.String... args)

makeQuery

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

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 DBObject

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

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.

extValidateRecord

@OverridingMethodsMustInvokeSuper
protected void extValidateRecord(@Nonnull
                                                                   ValidationList list)
                                                            throws java.lang.Exception

Performs additional validations on this record. Only ever called from MutableDataSource.

Overrides:

extValidateRecord in class DBObject

Parameters:

list - The validation list.

Throws:

java.lang.Exception - A serious problem

calculateJSON

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

Parameters:

wc - the web client

variables - the variables.

component -

Returns:

the object

Throws:

java.lang.Exception - a serious problem

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