com.aspc.cms.component

Class BreadCrumbComponent

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.cms.SiteComponent

com.aspc.cms.component.BreadCrumbComponent

All Implemented Interfaces:

SecondaryCacheGroup

public class BreadCrumbComponent
extends SiteComponent

Bread Crumb.

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 Bread Crumb
static java.lang.String	DBCLASS_NAME Bread Crumb

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

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 java.lang.Object	extGetDerivedValue(DBField field, FldParams params) OVERRIDE This method for all objects with derived fields that are NOT linked.
HTMLComponent	extProcess(WebClient client, Site site, HTMLPage htmlPage)
CascadingStyleSheet	findBreadcrumbStyleSheet(java.lang.String... args) The breadcrumb style sheet.
CascadingStyleSheet	getBreadcrumbStyleSheet(java.lang.String... args)
java.lang.String	getInitParameters(java.lang.String... args)
HTMLComponent	iProcess(WebClient client, Site site, HTMLPage htmlPage)
BreadCrumbComponent	setBreadcrumbStyleSheet(com.aspc.dal.style.CascadingStyleSheet value, java.lang.String... args)
BreadCrumbComponent	setInitParameters(java.lang.String value, java.lang.String... args)

Methods inherited from class com.aspc.cms.SiteComponent

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

Bread Crumb

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Bread Crumb

Constructor Detail

BreadCrumbComponent

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

getBreadcrumbStyleSheet

@CheckReturnValue
 @Nullable
public CascadingStyleSheet getBreadcrumbStyleSheet(java.lang.String... args)

findBreadcrumbStyleSheet

@CheckReturnValue
 @Nonnull
public final CascadingStyleSheet findBreadcrumbStyleSheet(java.lang.String... args)
                                                                               throws NotFoundException

The breadcrumb style sheet.

--> CascadingStyleSheet (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Cascading Style Sheet

Throws:

NotFoundException - CascadingStyleSheet was not found

setBreadcrumbStyleSheet

@Nonnull
public BreadCrumbComponent setBreadcrumbStyleSheet(com.aspc.dal.style.CascadingStyleSheet value,
                                                            java.lang.String... args)
                                                     throws java.lang.Exception

Throws:

java.lang.Exception

getInitParameters

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

setInitParameters

@Nonnull
public BreadCrumbComponent setInitParameters(java.lang.String value,
                                                      java.lang.String... args)
                                               throws java.lang.Exception

Throws:

java.lang.Exception

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

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.

extProcess

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

Specified by:

extProcess in class SiteComponent

Throws:

java.lang.Exception

iProcess

public HTMLComponent iProcess(WebClient client,
                              Site site,
                              HTMLPage htmlPage)
                       throws java.lang.Exception

Throws:

java.lang.Exception