com.aspc.DBObj.section

Class DBSectionVariable

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.section.DBSectionVariable

All Implemented Interfaces:

Variable, SecondaryCacheGroup

Direct Known Subclasses:

DBSectionSqlVariable

public abstract class DBSectionVariable
extends DBObject
implements Variable

DBSectionVariable Token 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 Token Variable
static java.lang.String	DBCLASS_NAME Token Variable
static java.lang.ThreadLocal<java.lang.String>	DEFAULT_VARIABLE_ENCODE

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.Object	calculateJSON(java.util.List<Variable> variables)
abstract java.lang.String	calculateResult(java.util.List<Variable> variables)
java.lang.String	encodeValue(java.lang.String value)
SiteVariableEncoding	findEncoding(java.lang.String... args) The encoding.
static DBSectionVariable	findKey(DataSource ds, int key) Find the target for this class by the primary key
DBSection	findSection(java.lang.String... args) Token variable.
java.lang.String	getDefault(java.lang.String... args)
SiteVariableEncoding	getEncoding(java.lang.String... args)
int	getID(java.lang.String... args)
java.lang.String	getName(java.lang.String... args)
java.lang.String	getResult(java.lang.String... args)
DBSection	getSection(java.lang.String... args)
int	getSequence(java.lang.String... args)
static DBQuery<DBSectionVariable>	makeQuery(DataSource ds) Make a new QUERY for this class.
DBSectionVariable	setDefault(java.lang.String value, java.lang.String... args)
DBSectionVariable	setEncoding(com.aspc.dal.cms.variable.SiteVariableEncoding value, java.lang.String... args)
DBSectionVariable	setID(int value, java.lang.String... args)
DBSectionVariable	setName(java.lang.String value, java.lang.String... args)
DBSectionVariable	setSection(com.aspc.dal.dbobj.section.DBSection value, java.lang.String... args)
DBSectionVariable	setSequence(int 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, extGetDerivedGlobalKey, extGetDerivedValue, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidate, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, extValidateField, 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

Methods inherited from interface com.aspc.DBObj.section.variable.Variable

getValue

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

Token Variable

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Token Variable

DEFAULT_VARIABLE_ENCODE

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

Constructor Detail

DBSectionVariable

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

Throws:

java.lang.Exception

getDefault

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

setDefault

@Nonnull
public DBSectionVariable 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 DBSectionVariable setEncoding(com.aspc.dal.cms.variable.SiteVariableEncoding value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getName

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

Specified by:

getName in interface Variable

setName

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

Throws:

java.lang.Exception

getResult

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

getSection

@CheckReturnValue
 @Nullable
public DBSection getSection(java.lang.String... args)

findSection

@CheckReturnValue
 @Nonnull
public final DBSection findSection(java.lang.String... args)
                                                        throws NotFoundException

Token variable.

--> DBSection (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

DBSection

Throws:

NotFoundException - DBSection was not found

setSection

@Nonnull
public DBSectionVariable setSection(com.aspc.dal.dbobj.section.DBSection value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getSequence

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

Specified by:

getSequence in interface Variable

setSequence

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

Throws:

java.lang.Exception

makeQuery

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

calculateJSON

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

Specified by:

calculateJSON in interface Variable

Throws:

java.lang.Exception

calculateResult

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

Specified by:

calculateResult in interface Variable

Throws:

java.lang.Exception

encodeValue

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

Specified by:

encodeValue in interface Variable