com.aspc.cms.component

Class SiteDivisionComponent

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.cms.SiteComponent

com.aspc.cms.SiteContainer

com.aspc.cms.component.SiteDivisionComponent

All Implemented Interfaces:

SecondaryCacheGroup

public class SiteDivisionComponent
extends SiteContainer

Division Component.

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

Since:

15 Mar 2013

Author:

Liam

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 Division Component
static java.lang.String	DBCLASS_NAME Division Component

Fields inherited from class com.aspc.cms.SiteComponent

SNAP2MAP

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	extCopy(DBObject target) Additional functionality when an object is copied.
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 boolean	extIsMandatory(DBField field) OVERRIDE This method to specify fields should be mandatory under certain conditions.
protected void	extPreValidate() OVERRIDE To add functionality to before validation is called.
HTMLComponent	extProcess(WebClient client, Site site, HTMLPage page)
SiteContainerType	findType(java.lang.String... args) The container type.
java.lang.String	getStyle(java.lang.String... args)
SiteContainerType	getType(java.lang.String... args)
boolean	isMagnet(java.lang.String... args)
SiteDivisionComponent	setMagnet(boolean value, java.lang.String... args)
SiteDivisionComponent	setStyle(java.lang.String value, java.lang.String... args)
SiteDivisionComponent	setType(com.aspc.dal.cms.component.SiteContainerType value, java.lang.String... args)

Methods inherited from class com.aspc.cms.SiteContainer

addContainerToDic, getLastComponentSequence, setLastComponentSequence

Methods inherited from class com.aspc.cms.SiteComponent

addEdit, addEdit, canHandleNoneType, changeLinks, editHTML, extPreDeleteRecord, extPreSaveRecord, extPreValidateDelete, extValidateDelete, extValidateField, extValidateRecord, findContainer, findIcon, findKey, findOwnedBySite, findVisibilityDesktop, findVisibilityMobile, findVisibilityTablet, getAccessibilityWarningCount, getAccessibilityWarningResult, getComponentPath, getContainer, getCreatedTS, getDefaultEncoding, getDerivedStyleClass, getDescendant, getDisplayPath, getDisplayTitle, getDisplayType, getDisplayXPath, getHandlebarsData, getHandlebarsHelpers, getIcon, getIconPath, getKey, getName, getOwnedBySite, getPage, getResult, getSequence, getSnap2Id, getStyleClass, getStyleClassVariable, getTargetWindow, getVisibilityDesktop, getVisibilityMobile, getVisibilityTablet, hasAttributes, isFinalFg, isLocked, isRelevantComponent, makeClone, makeDIV, makeQuery, makeSane, parseText, process, setAccessibilityWarningCount, setAccessibilityWarningResult, setContainer, setCreatedTS, setFinalFg, setHasAttributes, setId, setKey, setName, setSequence, setSnap2Id, setStyleClass, setStyleClassVariable, setVisibilityDesktop, setVisibilityMobile, setVisibilityTablet, shouldShow

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, extDelete, extDeleteRecord, extFixUp, extGetValue, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, 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

Division Component

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Division Component

Constructor Detail

SiteDivisionComponent

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

isMagnet

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

setMagnet

@Nonnull
public SiteDivisionComponent setMagnet(boolean value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getStyle

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

setStyle

@Nonnull
public SiteDivisionComponent setStyle(@MatchesPattern(value="(((-?[_a-zA-Z]+[_a-zA-Z0-9\\-]* *:)[a-zA-Z_\\-0-9\\(\\)\':@!~`#$%^&\\*\\+=\\{\\[\\}\\]\\|\\\\\\?/\\.,<> ]+;| ))*")
                                               java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getType

@CheckReturnValue
 @Nullable
public SiteContainerType getType(java.lang.String... args)

findType

@CheckReturnValue
 @Nonnull
public final SiteContainerType findType(java.lang.String... args)
                                                             throws NotFoundException

The container type.

--> SiteContainerType (String, Searchable)

Parameters:

args - the optional arguments

Returns:

SiteContainerType

Throws:

NotFoundException - SiteContainerType was not found

setType

@Nonnull
public SiteDivisionComponent setType(com.aspc.dal.cms.component.SiteContainerType value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

extProcess

public HTMLComponent extProcess(WebClient client,
                                Site site,
                                HTMLPage page)
                         throws java.lang.Exception

Overrides:

extProcess in class SiteContainer

Throws:

java.lang.Exception

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 SiteComponent

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.

extIsMandatory

@CheckReturnValue
protected boolean extIsMandatory(@Nonnull
                                                   DBField field)

Description copied from class: DBObject

OVERRIDE This method to specify fields should be mandatory under certain conditions.

Overrides:

extIsMandatory in class DBObject

Parameters:

field - The field to check

Returns:

true if the field should be treated as mandatory.

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 SiteContainer

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

extCopy

@OverridingMethodsMustInvokeSuper
protected void extCopy(@Nonnull
                                                         DBObject target)
                                                  throws java.lang.Exception

Description copied from class: DBObject

Additional functionality when an object is copied.

Overrides:

extCopy in class SiteComponent

Parameters:

target - the target 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 SiteComponent

Throws:

java.lang.Exception - a serious problem