com.aspc.cms.component

Class MenuComponent

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.cms.SiteComponent

com.aspc.cms.component.MenuComponent

All Implemented Interfaces:

SecondaryCacheGroup

public class MenuComponent
extends SiteComponent

Menu of pages.

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

Since:

4 December 2003

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 Menu of pages
static java.lang.String	DBCLASS_NAME Menu of pages

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

Method Summary

Modifier and Type	Method and Description
protected void	extAutoEnterCreate() Extend this method to add functionality when a new DBObject is created. You may need to create a FldParams, and setIsAutoEntered(true) so that system does not misunderstand that this object is changed by user.
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.
HTMLComponent	extProcess(WebClient client, Site site, HTMLPage page)
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.
MenuComponent	findExtendMenu(java.lang.String... args) Extend the menu.
SiteActiveHTMLParser	findParser(java.lang.String... args) The parser to use.
Site	findSite(java.lang.String... args) owned by site.
SiteContainerType	findType(java.lang.String... args) The container type.
java.lang.String	getAppendArticleClause(java.lang.String... args)
int	getAppendArticleLimit(java.lang.String... args)
java.lang.String	getAppendArticleOrderBy(java.lang.String... args)
java.lang.String	getAppendArticlePageUri(java.lang.String... args)
java.lang.String	getAppendMissingPages(java.lang.String... args)
MenuComponent	getExtendMenu(java.lang.String... args)
java.lang.String	getLabel(java.lang.String... args)
int	getLastMenuSequence(java.lang.String... args)
SiteActiveHTMLParser	getParser(java.lang.String... args)
java.lang.String	getRawHTML(java.lang.String... args)
java.lang.String	getResultJSON(java.lang.String... args)
Site	getSite(java.lang.String... args)
SiteContainerType	getType(java.lang.String... args)
MenuComponent	setAppendArticleClause(java.lang.String value, java.lang.String... args)
MenuComponent	setAppendArticleLimit(int value, java.lang.String... args)
MenuComponent	setAppendArticleOrderBy(java.lang.String value, java.lang.String... args)
MenuComponent	setAppendArticlePageUri(java.lang.String value, java.lang.String... args)
MenuComponent	setAppendMissingPages(java.lang.String value, java.lang.String... args)
MenuComponent	setExtendMenu(com.aspc.dal.cms.component.MenuComponent value, java.lang.String... args)
MenuComponent	setLabel(java.lang.String value, java.lang.String... args)
MenuComponent	setLastMenuSequence(int value, java.lang.String... args)
MenuComponent	setParser(com.aspc.dal.cms.variable.SiteActiveHTMLParser value, java.lang.String... args)
MenuComponent	setRawHTML(java.lang.String value, java.lang.String... args)
MenuComponent	setSite(com.aspc.dal.cms.Site value, java.lang.String... args)
MenuComponent	setType(com.aspc.dal.cms.component.SiteContainerType value, java.lang.String... args)
java.lang.String	toString() The description.

Methods inherited from class com.aspc.cms.SiteComponent

addEdit, addEdit, canHandleNoneType, changeLinks, editHTML, extCopy, extPreDeleteRecord, extPreSaveRecord, extPreValidateDelete, extValidateDelete, 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, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extDelete, extDeleteRecord, extFixUp, extGetValue, extIsMandatory, 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, 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

Menu of pages

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Menu of pages

Constructor Detail

MenuComponent

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

getAppendArticleClause

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

setAppendArticleClause

@Nonnull
public MenuComponent setAppendArticleClause(java.lang.String value,
                                                     java.lang.String... args)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

getAppendArticleLimit

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

setAppendArticleLimit

@Nonnull
public MenuComponent setAppendArticleLimit(int value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getAppendArticleOrderBy

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

setAppendArticleOrderBy

@Nonnull
public MenuComponent setAppendArticleOrderBy(java.lang.String value,
                                                      java.lang.String... args)
                                               throws java.lang.Exception

Throws:

java.lang.Exception

getAppendArticlePageUri

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

setAppendArticlePageUri

@Nonnull
public MenuComponent setAppendArticlePageUri(java.lang.String value,
                                                      java.lang.String... args)
                                               throws java.lang.Exception

Throws:

java.lang.Exception

getAppendMissingPages

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

setAppendMissingPages

@Nonnull
public MenuComponent setAppendMissingPages(java.lang.String value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getExtendMenu

@CheckReturnValue
 @Nullable
public MenuComponent getExtendMenu(java.lang.String... args)

findExtendMenu

@CheckReturnValue
 @Nonnull
public final MenuComponent findExtendMenu(java.lang.String... args)
                                                               throws NotFoundException

Extend the menu.

--> MenuComponent (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Menu

Throws:

NotFoundException - MenuComponent was not found

setExtendMenu

@Nonnull
public MenuComponent setExtendMenu(com.aspc.dal.cms.component.MenuComponent 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 MenuComponent setLabel(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getLastMenuSequence

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

setLastMenuSequence

@Nonnull
public MenuComponent setLastMenuSequence(int value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getParser

@CheckReturnValue
 @Nullable
public SiteActiveHTMLParser getParser(java.lang.String... args)

findParser

@CheckReturnValue
 @Nonnull
public final SiteActiveHTMLParser findParser(java.lang.String... args)
                                                                  throws NotFoundException

The parser to use.

--> SiteActiveHTMLParser (String, Searchable)

Parameters:

args - the optional arguments

Returns:

SiteActiveHTMLParser

Throws:

NotFoundException - SiteActiveHTMLParser was not found

setParser

@Nonnull
public MenuComponent setParser(com.aspc.dal.cms.variable.SiteActiveHTMLParser value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getRawHTML

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

setRawHTML

@Nonnull
public MenuComponent setRawHTML(java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getResultJSON

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

getSite

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

findSite

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

owned by site.

--> Site (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Site

Throws:

NotFoundException - Site was not found

setSite

@Nonnull
public MenuComponent setSite(com.aspc.dal.cms.Site 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 MenuComponent setType(com.aspc.dal.cms.component.SiteContainerType value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

extAutoEnterCreate

@OverridingMethodsMustInvokeSuper
protected void extAutoEnterCreate()
                                                             throws java.lang.Exception

Description copied from class: DBObject

Extend this method to add functionality when a new DBObject is created.
You may need to create a FldParams, and setIsAutoEntered(true) so that system does not misunderstand that this object is changed by user.

Overrides:

extAutoEnterCreate in class DBObject

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

extValidateField

@CheckReturnValue
protected ValidationError extValidateField(@Nonnull
                                                             DBField field,
                                                             @Nonnull
                                                             ValidationList list)
                                                      throws java.lang.Exception

Description copied from class: DBObject

Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.

OVERRIDE this method to add validation to a field but call iValidateField to perform the full validation for a field.

This method should be READ ONLY. Don't create DBObjects here.
When overriding this method the following code stub should be used.
ValidationError ve;
ve = super.extValidateField( field, list);
if( ve != null) return ve;
if( field.getName().equalsIgnoreCase( DBFIELD_FIELD1))
{
return list.createError( DBMessage.LIST_DB_MY_ERROR, this, field);
}
else if( field.getName().equalsIgnoreCase( DBFIELD_FIELD2))
{
....
}

Overrides:

extValidateField in class SiteComponent

Parameters:

field - The field to be validated

list - The validation list

Returns:

the error or warning.

Throws:

java.lang.Exception - a serious error

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.

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 SiteComponent

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

toString

@CheckReturnValue
 @Nonnull
public java.lang.String toString()

Description copied from class: DBObject

The description.

Overrides:

toString in class DBObject

Returns:

The description

extProcess

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

Specified by:

extProcess in class SiteComponent

Throws:

java.lang.Exception