com.aspc.cms.component

Class FrameComponent

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.cms.SiteComponent

com.aspc.cms.component.FrameComponent

All Implemented Interfaces:

SecondaryCacheGroup

public class FrameComponent
extends SiteComponent

Frame Component.

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

Since:

04 June 2014

Author:

Lei Gao

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 Frame Component
static java.lang.String	DBCLASS_NAME Frame 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
FrameComponent(DBClass def, DataSource dataSource)

Method Summary

Modifier and Type	Method and Description
protected GlobalKey	extGetDerivedGlobalKey(DBField field, FldParams params) OVERRIDE This method to return a derived global key.
protected boolean	extIsMandatory(DBField field) OVERRIDE This method to specify fields should be mandatory under certain conditions.
HTMLComponent	extProcess(WebClient client, Site site, HTMLPage page)
protected void	extValidateRecord(ValidationList list) Performs additional validations on this record.
Site	findSrcSite(java.lang.String... args) Frame Srouce Site.
java.lang.String	getPagePattern(java.lang.String... args)
Site	getSrcSite(java.lang.String... args)
boolean	isExcludingCSS(java.lang.String... args)
FrameComponent	setExcludingCSS(boolean value, java.lang.String... args)
FrameComponent	setPagePattern(java.lang.String value, java.lang.String... args)
FrameComponent	setSrcSite(com.aspc.dal.cms.Site value, java.lang.String... args)

Methods inherited from class com.aspc.cms.SiteComponent

addEdit, addEdit, canHandleNoneType, changeLinks, editHTML, extCopy, extGetDerivedValue, extPreDeleteRecord, extPreSaveRecord, extPreValidate, extPreValidateDelete, extValidateDelete, extValidateField, 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

Frame Component

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Frame Component

Constructor Detail

FrameComponent

public FrameComponent(DBClass def,
                      DataSource dataSource)
               throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

isExcludingCSS

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

setExcludingCSS

@Nonnull
public FrameComponent setExcludingCSS(boolean value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getPagePattern

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

setPagePattern

@Nonnull
public FrameComponent setPagePattern(@MatchesPattern(value="^([a-zA-Z0-9]|(\\$\\{.+\\}))+([a-zA-Z0-9-_/]|(\\$\\{.+\\}))*$")
                                              java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getSrcSite

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

findSrcSite

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

Frame Srouce Site.

--> Site (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Site

Throws:

NotFoundException - Site was not found

setSrcSite

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

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.

extValidateRecord

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

Description copied from class: DBObject

Performs additional validations on this record. OVERRIDE this method to add additional validations to a record.
The MutableDataSource is in READONLY mode at this stage.

Overrides:

extValidateRecord in class SiteComponent

Parameters:

list - The validation list.

Throws:

java.lang.Exception - A serious problem

extProcess

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

Specified by:

extProcess in class SiteComponent

Throws:

java.lang.Exception