com.jalios.jcms.portlet

Class PortalElement

java.lang.Object

com.jalios.jstore.BasicStorable

com.jalios.jcms.Data

com.jalios.jcms.Publication

com.jalios.jcms.portlet.PortalElement

All Implemented Interfaces:

EditableData, JcmsConstants, ImportConstants, MashupConstants, Searchable, Storable, JaliosConstants, LangPropertyArgument, TreeNode, java.lang.Cloneable, java.lang.Comparable<BasicStorable>

Direct Known Subclasses:

Portal, PortalRedirect, Portlet

public abstract class PortalElement
extends Publication
implements TreeNode

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PortalElement.AbilitySelector AbilitySelector selects all the publications with the given ability

Nested classes/interfaces inherited from class com.jalios.jcms.Publication

Publication.AdateComparator<T extends Publication>, Publication.AdateSelector, Publication.AudienceRightComparator<T extends Publication>, Publication.AudienceRightSelector, Publication.AuthorComparator<T extends Publication>, Publication.AuthorizedSelector, Publication.CanWorkOnSelector, Publication.DdateComparator<T extends Publication>, Publication.EdateComparator<T extends Publication>, Publication.EdateSelector, Publication.PdateComparator<T extends Publication>, Publication.PdateSelector, Publication.PopularityComparator<T extends Publication>, Publication.PstatusComparator<T extends Publication>, Publication.PstatusSelector, Publication.ReaderComparator<T extends Publication>, Publication.ReadRightSelector, Publication.RightComparator<T extends Publication>, Publication.SdateComparator<T extends Publication>, Publication.SdateSelector, Publication.TitleComparator<T extends Publication>, Publication.TrackedSelector, Publication.TypeComparator<T extends Publication>, Publication.UdateComparator<T extends Publication>, Publication.UdateSelector, Publication.UserContentSelector, Publication.VisibleStateSelector, Publication.VoteScoreComparator<T extends Publication>, Publication.WorkspaceAuthorSelector, Publication.WorkspaceComparator<T extends Publication>, Publication.WorkspaceSelector

Nested classes/interfaces inherited from class com.jalios.jcms.Data

Data.AuthorSelector, Data.CdateSelector, Data.DataNameComparator<T extends Data>, Data.DeletableSelector, Data.ImportSelector, Data.MdateSelector, Data.OpAuthorComparator<T extends Data>, Data.RowIdComparator<T extends Data>, Data.StrongLockSelector

Nested classes/interfaces inherited from class com.jalios.jstore.BasicStorable

BasicStorable.CdateComparator<T extends Storable>, BasicStorable.IdComparator<T extends Storable>, BasicStorable.MdateComparator<T extends Storable>

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String[]	abilities
protected static java.lang.String[]	allAbilities
protected static java.util.Map	allAbilityMap
protected static java.util.Map<java.lang.String,java.util.List<java.lang.String>>	allAbilityMapUI
protected java.util.List	cachedAbilities
static java.lang.String	ICON_PORTLET
static java.lang.String	ICON_STATS
static java.lang.String	REVISION
protected static TypeTemplateEntry	tteDefault

Fields inherited from class com.jalios.jcms.Publication

adate, allCatIdSet, authGrpIdSet, authGrpIdSetDirty, authGrpIdSetInit, authMbrIdSet, authMbrIdSetDirty, authMbrIdSetInit, authorizedGroupSet, authorizedMemberSet, categories, categorySet, catIdSet, catIdSetDirty, catIdSetInit, CTRL_TOPIC_ADVANCED, CTRL_TOPIC_CATEGORIES, CTRL_TOPIC_WORKFLOW, edate, friendlyURLSet, hasNoReadRightsDBData, indexMgr, isTracked, mainInstance, mainLanguage, majorVersion, mergeDate, mergeId, minorVersion, pdate, pstatus, PUBLICATION_WFNOTE, readerCount, roleMap, sdate, templates, title, titleML, udate, updateGroupSet, updateMemberSet, voteCount, voteScore, wfExpressAlarmEntry, wfReminderAlarmEntry, workflowId, workspace

Fields inherited from class com.jalios.jcms.Data

author, authorDBID, channel, DISPLAY_URL_EXTRA_INFO, extension, extraDataMap, extraDBDataMapToSaveOnOp, importMap, opAuthor, opDelegate

Fields inherited from class com.jalios.jstore.BasicStorable

cdate, ddate, id, mdate, store

Fields inherited from interface com.jalios.jcms.mashup.ImportConstants

IMPORT_ALARM_MGR, IMPORT_AUTHOR_PROP, IMPORT_CATEGORY_DEFAULT, IMPORT_DC_ATTR, IMPORT_DC_STEP, IMPORT_DIR, IMPORT_ENABLED, IMPORT_JDOM_ELEMENT, IMPORT_LOG_FILE, IMPORT_LOG_MAX, IMPORT_OPTIONS, IMPORT_OPTIONS_DC_CONTEXT, IMPORT_ROOT_PROP, IMPORT_SOURCE_FILE, IMPORT_SOURCE_PREFIX_PROP, IMPORT_SOURCES_DIR, IMPORT_STEP_CLEAN, IMPORT_STEP_IMPORT, IMPORT_STEP_UPDATE_REF, IMPORT_WS_PROP

Fields inherited from interface com.jalios.jcms.mashup.MashupConstants

DATA_TAG, DATASET_TAG, FIELD_CLASS, FIELD_ENTRY, FIELD_ITEM, FIELD_KEY, FIELD_NAME, FIELD_TAG, FIELD_VALUE, FILE_FIELD, FILE_ID, FILE_MTIME, FILE_SIZE, FILE_TAG, FILE_TICKET, FILESET_TAG, RELATED_TAG

Fields inherited from interface com.jalios.jcms.JcmsConstants

ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, ICON_ARCHIVE, ICON_LOCK, ICON_LOCK_STRONG, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_CREATE_STR, OP_DEEP_COPY, OP_DEEP_COPY_STR, OP_DEEP_DELETE, OP_DEEP_DELETE_STR, OP_DELETE, OP_DELETE_STR, OP_MERGE, OP_MERGE_STR, OP_UPDATE, OP_UPDATE_STR, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TYPES_ICON_ALT_PROP, TYPES_ICON_SUFFIX_PROP, TYPES_ICON_TITLE_PROP, TYPES_PREFIX_PROP, TYPES_THUMB_SUFFIX_PROP, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, URL_REGEXP, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML

Fields inherited from interface com.jalios.util.JaliosConstants

CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR

Constructor Summary

Constructors

Constructor and Description
PortalElement()
PortalElement(PortalElement other)

Method Summary

Methods

Modifier and Type	Method and Description
void	addAbility(java.lang.String ability) Add the given ability to this portal abilities
boolean	containsTreeDescendant(TreeNode tn) Same as getAllTreeChildren() but stop when there is a match.
PortalElement	duplicate(Member author) Duplicate a PortalElement using one of its default constructor, and create it in the store.
PortalElement	duplicate(java.lang.String prefix, Member author) Duplicates a PortalElement and add a Prefix to the title.
PortalElement	duplicate(java.lang.String prefix, Member author, boolean deep) Performs a deep duplicate.
PortalElement	duplicate(java.lang.String prefix, Member author, boolean deep, Workspace wkspc, java.util.Map catMap, java.util.Map groupMap) Deprecated. Used instead duplicate(WizardContext, boolean)
PortalElement	duplicate(WizardContext context, boolean deep) Performs a deep duplicate.
protected void	duplicateDeep(PortalElement parent, java.lang.String prefix, Member author, Workspace wkspc, java.util.Map catMap, java.util.Map groupMap) Deprecated. Used instead duplicateDeep(WizardContext, PortalElement)
protected void	duplicateDeep(WizardContext context, PortalElement parent) Performs a deep duplicate of the PortalElement in a WizardContext.
java.lang.String[]	getAbilities()
java.lang.String[]	getAbilities(java.lang.String lang)
java.lang.String[]	getAbilities(java.lang.String lang, boolean useDefault)
java.lang.String	getAbilityLabel(java.lang.String userLang, java.lang.String ability) Returns the label of a given ability
static PortalElement.AbilitySelector	getAbilitySelector(java.lang.String ability) Retrieves a new instance of PortalElement.AbilitySelector using the specified ability String.
java.lang.String	getAbstract() Returns the abstract of this publication in the channel's main language.
java.lang.String	getAbstract(java.lang.String lang, boolean useDefault) Returns the abstract of this publication.
static java.lang.String[]	getAllAbilities() Returns an Array of all available abilities declared for the given class.
static java.lang.String[]	getAllAbilities(java.lang.Class clazz) Returns an Array of all available abilities declared for the given class
static java.util.Map	getAllAbilityMap() Returns a Map (key1/key2) of all available abilities declared.
static java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getAllAbilityMapUI() Retrieve all abilities in map easy to use for User Interface listing of abilities.
java.util.Collection<PortalElement>	getAllTreeChildren() Retrieve a new collection containing all PortalElement children of this PortalElement
abstract java.lang.String	getBehaviorCopy()
abstract java.lang.String	getCacheSensibility()
abstract java.lang.String	getCacheType()
int	getCacheTypeInt()
java.lang.String	getContentTitle(java.lang.String lang)
abstract java.lang.String	getCssClasses()
abstract java.lang.String	getCssId()
java.lang.String	getDataIcon() Returns source information for the icon associated to this Data, either a relative path or sprite classes name.
java.lang.String	getDefaultTemplateUsage() Returns the default template usage used to display the publication.
abstract java.lang.String	getDescription(java.lang.String lang)
abstract java.lang.String	getDescription(java.lang.String lang, boolean b)
abstract java.util.HashMap<java.lang.String,java.lang.String>	getDescriptionML()
java.lang.String	getIcon()
abstract java.lang.String[]	getInvalidClass()
abstract long	getInvalidTime()
abstract java.lang.String	getPortletImage(java.lang.String lang)
abstract java.lang.String	getPortletImage(java.lang.String lang, boolean b)
abstract java.util.HashMap<java.lang.String,java.lang.String>	getPortletImageML()
java.lang.String	getPreview(JcmsJspContext ctxt, int width, int height, java.lang.String defaultImagePath) Retrieve the preview image of this Portlet in the specified context and dimensions.
java.lang.Class[]	getResolvedInvalidClass()
java.lang.String	getSkinPath(JcmsJspContext ctxt) Returns the template skin path for the given usage
java.lang.String	getSkinPath(java.lang.String usage, boolean devModeChecks) Returns the template skin path for the given usage
TypeTemplateEntry	getSkinTemplateEntry(java.lang.String usage, boolean devModeChecks) Returns the TypeTemplateEntry Skin matching the given parameters.
java.util.Collection<? extends TreeNode>	getTreeChildren() Returns a Collection of TreeNode children of the current node
TreeNode	getTreeParent() Returns parent of the current node
TreeNode	getTreeParent(TreeNode node)
boolean	hasAbility() Returns true if the portlet has an ability
boolean	hasAbility(java.lang.String ability) Returns true if the portlet have the given ability Or if the ability is empty and the portlet have no ability
boolean	hasCacheGroups()
boolean	hasCacheMembers()
boolean	hasCacheServer()
boolean	hasCacheSession()
boolean	hasCacheSessionAndVisitors()
boolean	hasCacheVisitorsOnly()
boolean	hasCurrentCategoryCacheSensibility()
boolean	hasNoCache()
boolean	hasNoCacheSensibility()
boolean	hasPortalCategoryCacheSensibility()
boolean	isChildTreeNode(TreeNode child)
boolean	isCopy()
boolean	isReference()
boolean	isTreeLeaf() Returns boolean true if the TreeNode is a leaf
boolean	isTreeNode() Returns boolean true if the TreeNode is a node
boolean	isWorkspaceReference()
void	performUpdate(Member mbr, java.util.Map context) Performs data update
void	setAbilities(java.lang.String[] v)
abstract void	setBehaviorCopy(java.lang.String b)
abstract void	setCacheSensibility(java.lang.String v)
abstract void	setCacheType(java.lang.String v)
abstract void	setCssClasses(java.lang.String v)
abstract void	setCssId(java.lang.String v)
abstract void	setDescription(java.lang.String s)
abstract void	setDescriptionML(java.util.HashMap<java.lang.String,java.lang.String> s)
abstract void	setInvalidClass(java.lang.String[] v)
abstract void	setInvalidTime(long v)
abstract void	setPortletImage(java.lang.String s)
abstract void	setPortletImageML(java.util.HashMap<java.lang.String,java.lang.String> s)

Methods inherited from class com.jalios.jcms.Publication

addAuthorizedGroup, addAuthorizedMember, addCategory, addFollower, addWeakReferrer, addWFExpressAlarm, addWFReminderAlarm, assignCommonPublicationFields, assignRole, assignRole, canBeArchived, canBeArchived, canBeEditedFieldByField, canBeFollowedBy, canBeReadBy, canBeReadBy, canBeReadBy, canBeReadBy, canBeReadBy, canBeVotedBy, canCreateCopy, canCreateCopy, canCreateWorkCopy, canMergeWorkCopy, canRequestUnlock, checkCreate, checkDelete, checkIntegrity, checkLang, checkMember, checkMerge, checkStateChange, checkStateChange, checkTemplateEntry, checkUpdate, checkWrite, clearTransientIndex, cloneDBDataCollections, computeSignature, computeSignature, containsCategory, createCopy, createWFNote, createWFNote, createWorkCopy, discardCopy, exportXmlField, getAbstract, getAbstractML, getAccessCount, getAdate, getAdateComparator, getAdateSelector, getAllCatIdSet, getAllFilePath, getAllWikiText, getAllWysiwygText, getAudiencedRightsString, getAudienceRightComparator, getAudienceRightSelector, getAuthGrpIdSet, getAuthMbrIdSet, getAuthorizedGroupSet, getAuthorizedMemberSet, getAuthorizedSelector, getCanWorkOnSelector, getCategories, getCategories, getCategorySet, getCatIdSet, getComparator, getComparator, getComparator, getCSVHeader, getDataIconTitle, getDataName, getDate, getDate, getDateSelector, getDBDataRevision, getDdateComparator, getDescendantCategorySet, getDescendantCategorySet, getDescendantCategorySet, getDisplayTemplateFile, getDocumentLinkSet, getEdate, getEdateComparator, getEdateSelector, getEstimatedReminderCount, getExternalLinkSet, getFieldInMainLanguage, getFieldValue, getFirstDescendantCategory, getFirstDescendantCategory, getFirstDescendantCategory, getFollowerList, getFriendlyURLSet, getHasNoReadRights, getImportConflictCopy, getImportVersion, getIndexingDate, getInternalWorkflow, getLinkDataSet, getMainInstance, getMainLanguage, getMajorVersion, getMemberSetAssignedToRole, getMergeDate, getMergeId, getMinorVersion, getNextWFStateSet, getPdate, getPdateComparator, getPdateSelector, getPopularity, getPopularityComparator, getPstatus, getPstatusAlarmEntry, getPstatusComparator, getPstatusSelector, getPstatusSelector, getQueryTemplateFile, getReaderComparator, getReaderCount, getReaderTrackerList, getReadRightSelector, getReadRightsString, getRightComparator, getRoleMap, getRoleMapStr, getSdate, getSdateComparator, getSdateSelector, getSearchStrings, getTemplate, getTemplateEntry, getTemplateEntry, getTemplateEntrySet, getTemplatePath, getTemplatePath, getTemplates, getTitle, getTitle, getTitle, getTitleComparator, getTitleComparator, getTitleML, getTrackedSelector, getTreeRoot, getTypeComparator, getTypeLabel, getUdate, getUdateComparator, getUdateSelector, getUpdateGroupSet, getUpdateMemberSet, getVersionString, getVisibleStateSelector, getVoteCount, getVoteScore, getVoteScoreComparator, getVoteValue, getWeakReferrerSet, getWFNoteList, getWFState, getWFStateLabel, getWFStateLabelHtml, getWorkCopySet, getWorkflow, getWorkflowId, getWorkspace, getWorkspaceAuthorSelector, getWorkspaceComparator, getWorkspaceId, getWorkspaceSelector, getWSTypeEntry, getWSTypeEntry, hasAlreadyVoted, hasAnyReadRights, hasBeenReadBy, hasCategory, hasImportConflict, hasNoReadRights, hasWeakReferrers, importConvertToLocal, importMarkAsMerged, importOverrideAndUpdate, importXml, init, initCopy, initializeDBDataCollections, internalCanBeReadBy, isAudienced, isDefaultTemplate, isFollowedBy, isImportConflictCopy, isInRole, isInVisibleState, isPublic, isRoleAssigned, isTracked, isUserContent, isUserContentType, isVersioned, isVotable, isWorkCopy, majorUpdate, notifyFollowers, performAfterWrite, performBeforeWrite, performCreate, performDelete, performMerge, performMerge, prepareMergeCopy, putPstatusAlarmEntry, recomputeScore, removeAllDescendants, removeAllFollowers, removeAllReaderTracker, removeAuthorizedGroup, removeAuthorizedMember, removeCategory, removeDataSet, removeFollower, removeImportMetadata, removePstatusAlarmEntry, removeWeakReferrer, removeWFExpressAlarm, removeWFReminderAlarm, resolveTypeTemplateEntry, setAbstract, setAbstract, setAdate, setAllCatIdSet, setAuthGrpIdSet, setAuthMbrIdSet, setAuthorizedGroupSet, setAuthorizedMemberSet, setCategories, setCategorySet, setCatIdSet, setCdate, setEdate, setFieldValue, setFriendlyURLSet, setHasNoReadRights, setImportConflictCopy, setImportVersion, setMainInstance, setMainLanguage, setMajorVersion, setMergeDate, setMergeId, setMinorVersion, setPdate, setPstatus, setReaderCount, setRoleMap, setRoleMapStr, setRoleMemberSetMap, setSdate, setTemplate, setTemplates, setTitle, setTitle, setTitleML, setTracked, setUdate, setUpdateGroupSet, setUpdateMemberSet, setVoteCount, setVoteScore, setWorkflow, setWorkflowId, setWorkspace, setWorkspaceId, toCSV, toFullString, toString, trackReader, trackReader, unassignMember, unassignRole, updatePstatus, updateTemplate

Methods inherited from class com.jalios.jcms.Data

checkCreate, checkDelete, checkIntegrity, checkLockMember, checkStrongLockMember, checkUpdate, clone, computeDBIDArray, exportXml, exportXml, exportXml, exportXml, exportXmlRelated, exportXmlRelated, fillExportXmlFieldAttributes, getAllReferrerSet, getAllReferrerSet, getAllTypeFieldEntry, getAuthor, getAuthor, getAuthorComparator, getAuthorDBID, getAuthorId, getAuthorSelector, getBooleanFieldValue, getBooleanFieldValue, getCaddyComparator, getCategoryFieldValue, getCategoryFieldValue, getCdateSelector, getDataIconAlt, getDataIconHtml, getDataIconHtml, getDataImage, getDataImage, getDataImage, getDataNameComparator, getDeletableSelector, getDisplayLink, getDisplayLink, getDisplayLink, getDisplayUrl, getDoubleFieldValue, getDoubleFieldValue, getExportXmlDataValue, getExtension, getExtraData, getExtraDataMap, getExtraDBData, getExtraDBDataMap, getExtraInfo, getExtraInfoMap, getFieldStatusMap, getFieldValue, getFieldValue, getFieldValue, getGenericThumbnail, getImportAuthor, getImportBatch, getImportDate, getImportDisplayUrl, getImportId, getImportMap, getImportMdate, getImportSelector, getImportSignature, getImportSource, getImportSourceUrl, getImportUrl, getIntFieldValue, getIntFieldValue, getLangPropertyValue, getLinkCount, getLinkIndexedDataSet, getLinkIndexedDataSet, getLockDate, getLockInfo, getLockMember, getLongFieldValue, getLongFieldValue, getMdateSelector, getNewDefaultExtraDataMap, getNewDefaultExtraDataMap, getNewDefaultExtraDataMap, getNewDefaultExtraDataMap, getNewDefaultExtraDBDataMap, getNewDefaultExtraDBDataMap, getNewDefaultExtraDBDataMap, getNewDefaultExtraDBDataMap, getOpAuthor, getOpAuthorComparator, getOpDelegate, getRowId, getRowIdComparator, getStrongLock, getStrongLockDate, getStrongLockInfo, getStrongLockMember, getStrongLockSelector, getTypeEntry, getTypeFieldsEntries, getUpdateInstance, getVirtualIDSet, hashCode, importXmlFieldsWithReferences, importXmlFiles, importXmlReferences, isDBData, isImported, isImportUpdated, isInDatabase, isLocked, isPersisted, isStrongLocked, lock, markNewImport, mergeHybridLink, performCreate, performDelete, performUpdate, prepareUpdateContext, printDataName, printDisplayLinkEnd, printDisplayLinkStart, printDisplayUrl, printDisplayUrl, putStrongLock, releaseStrongLock, releaseStrongLock, removeExtraData, removeExtraDBData, removeExtraInfo, setAuthor, setAuthorDBID, setAuthorId, setBooleanFieldValue, setCategoryFieldValue, setDoubleFieldValue, setExtension, setExtraData, setExtraDataMap, setExtraDBData, setExtraDBDataMap, setExtraDBDataMap, setExtraInfo, setFieldValue, setImportAuthor, setImportBatch, setImportDate, setImportDisplayUrl, setImportId, setImportMap, setImportMdate, setImportSignature, setImportSource, setImportSourceUrl, setImportUpdated, setIntFieldValue, setLongFieldValue, setMdate, setOpAuthor, setOpDelegate, setRowId, unlock, unlock, unmarkNewImport, updateExtraDataMap, updateExtraDBDataMap, updateIndexTreeSet

Methods inherited from class com.jalios.jstore.BasicStorable

clearId, compareTo, equals, getAttribute, getAttributes, getCdate, getCdateComparator, getDdate, getId, getIdComparator, getMdate, getMdateComparator, getStore, getUrid, hasBeenUpdated, isStored, resolveAtt, resolveVal, setAttributes, setAttributes, setDdate, setId, setStore, toXml

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.jalios.util.TreeNode

getTreeRoot

Field Detail

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

tteDefault

protected static TypeTemplateEntry tteDefault

abilities

protected java.lang.String[] abilities

allAbilities

protected static transient java.lang.String[] allAbilities

allAbilityMap

protected static transient java.util.Map allAbilityMap

allAbilityMapUI

protected static transient java.util.Map<java.lang.String,java.util.List<java.lang.String>> allAbilityMapUI

cachedAbilities

protected transient java.util.List cachedAbilities

ICON_PORTLET

public static final java.lang.String ICON_PORTLET

See Also:

Constant Field Values

ICON_STATS

public static final java.lang.String ICON_STATS

See Also:

Constant Field Values

Constructor Detail

PortalElement

public PortalElement()

PortalElement

public PortalElement(PortalElement other)

Method Detail

getContentTitle

public java.lang.String getContentTitle(java.lang.String lang)

getAbstract

public java.lang.String getAbstract()

Description copied from class: Publication

Returns the abstract of this publication in the channel's main language.

Overrides:

getAbstract in class Publication

Returns:

the abstract of this publication in the channel's main language.

getAbstract

public java.lang.String getAbstract(java.lang.String lang,
                           boolean useDefault)

Description copied from class: Publication

Returns the abstract of this publication.

Overrides:

getAbstract in class Publication

Parameters:

lang - the user language (ISO-639 language code)

useDefault - should the default language be used

Returns:

the abstract of this publication.

getDescriptionML

public abstract java.util.HashMap<java.lang.String,java.lang.String> getDescriptionML()

getDescription

public abstract java.lang.String getDescription(java.lang.String lang)

getDescription

public abstract java.lang.String getDescription(java.lang.String lang,
                              boolean b)

setDescription

public abstract void setDescription(java.lang.String s)

setDescriptionML

public abstract void setDescriptionML(java.util.HashMap<java.lang.String,java.lang.String> s)

getPortletImageML

public abstract java.util.HashMap<java.lang.String,java.lang.String> getPortletImageML()

getPortletImage

public abstract java.lang.String getPortletImage(java.lang.String lang)

getPortletImage

public abstract java.lang.String getPortletImage(java.lang.String lang,
                               boolean b)

setPortletImage

public abstract void setPortletImage(java.lang.String s)

setPortletImageML

public abstract void setPortletImageML(java.util.HashMap<java.lang.String,java.lang.String> s)

getPreview

public java.lang.String getPreview(JcmsJspContext ctxt,
                          int width,
                          int height,
                          java.lang.String defaultImagePath)

Retrieve the preview image of this Portlet in the specified context and dimensions.

Current implementation is as follow :
If the portlet image of this portlet has been defined, it is used as the source image for the preview. Otherwise the preview of the template being use for the specified context is used.

Then, the thumbnail tag is used to create the image in the appropriate dimension, from this source, if the source image file could no be found, the default image specified in parameters is used.

Warning : This method create a thumbnail when it does not exists, this process can be a little time consumming, make sure you do not need immediate response time when using it, as it might slow down your jsp access time (on first call only).

Parameters:

ctxt - the current JcmsJspContext

width - target max width (if a value of 0 or less is specified, 200 will be used)

height - target max height (if a value of 0 or less is specified, 150 will be used)

defaultImagePath - the default image to use if thumbnail do not exists

Returns:

a path relative to the webapp root (e.g. "types/PortletRSS/th-60x45-doPortletRSSFullDisplay.jpg.jpg").

getCssId

public abstract java.lang.String getCssId()

setCssId

public abstract void setCssId(java.lang.String v)

getCssClasses

public abstract java.lang.String getCssClasses()

setCssClasses

public abstract void setCssClasses(java.lang.String v)

getDefaultTemplateUsage

public java.lang.String getDefaultTemplateUsage()

Returns the default template usage used to display the publication. This default tempalte may change between Content and Portlets

Overrides:

getDefaultTemplateUsage in class Publication

Returns:

String the default usage

See Also:

Publication.getDefaultTemplateUsage()

getSkinPath

public java.lang.String getSkinPath(java.lang.String usage,
                           boolean devModeChecks)

Returns the template skin path for the given usage

Parameters:

usage - the template usage

devModeChecks - perform developement checks on template

Returns:

String the path of the template used

getSkinPath

public java.lang.String getSkinPath(JcmsJspContext ctxt)

Returns the template skin path for the given usage

Parameters:

ctxt - the JcmsJspContext

Returns:

String the path of the template used

getSkinTemplateEntry

public TypeTemplateEntry getSkinTemplateEntry(java.lang.String usage,
                                     boolean devModeChecks)

Returns the TypeTemplateEntry Skin matching the given parameters. It returns a default template if the given one does work.

Parameters:

usage - the template usage

devModeChecks - perform developement checks on template

Returns:

TypeTemplateEntry the matching templates

getCacheType

public abstract java.lang.String getCacheType()

setCacheType

public abstract void setCacheType(java.lang.String v)

getCacheSensibility

public abstract java.lang.String getCacheSensibility()

setCacheSensibility

public abstract void setCacheSensibility(java.lang.String v)

getInvalidClass

public abstract java.lang.String[] getInvalidClass()

setInvalidClass

public abstract void setInvalidClass(java.lang.String[] v)

getInvalidTime

public abstract long getInvalidTime()

setInvalidTime

public abstract void setInvalidTime(long v)

getResolvedInvalidClass

public java.lang.Class[] getResolvedInvalidClass()

hasNoCacheSensibility

public boolean hasNoCacheSensibility()

hasPortalCategoryCacheSensibility

public boolean hasPortalCategoryCacheSensibility()

hasCurrentCategoryCacheSensibility

public boolean hasCurrentCategoryCacheSensibility()

getCacheTypeInt

public int getCacheTypeInt()

hasNoCache

public boolean hasNoCache()

hasCacheSession

public boolean hasCacheSession()

hasCacheServer

public boolean hasCacheServer()

hasCacheGroups

public boolean hasCacheGroups()

hasCacheMembers

public boolean hasCacheMembers()

hasCacheSessionAndVisitors

public boolean hasCacheSessionAndVisitors()

hasCacheVisitorsOnly

public boolean hasCacheVisitorsOnly()

getBehaviorCopy

public abstract java.lang.String getBehaviorCopy()

setBehaviorCopy

public abstract void setBehaviorCopy(java.lang.String b)

isCopy

public boolean isCopy()

isReference

public boolean isReference()

isWorkspaceReference

public boolean isWorkspaceReference()

duplicate

public PortalElement duplicate(Member author)

Duplicate a PortalElement using one of its default constructor, and create it in the store. If an exception append then return null.

Parameters:

author - the Member to be used for store operation (create).

Returns:

a newly created PortalElement instance, duplicate of this

Since:

jcms-4.0

duplicate

public PortalElement duplicate(java.lang.String prefix,
                      Member author)

Duplicates a PortalElement and add a Prefix to the title.

Parameters:

prefix - the title prefix

author - the Member to be used for store operation (create).

Returns:

a newly created PortalElement instance, duplicate of this

Since:

jcms-4.0

duplicate

public PortalElement duplicate(java.lang.String prefix,
                      Member author,
                      boolean deep)

Performs a deep duplicate.

Parameters:

prefix - the title prefix

author - the Member to be used for store operation (create).

deep - boolean indicating if it is a deep copy

Returns:

a newly created PortalElement instance, duplicate of this

Since:

jcms-4.0

duplicate

@Deprecated
public PortalElement duplicate(java.lang.String prefix,
                                 Member author,
                                 boolean deep,
                                 Workspace wkspc,
                                 java.util.Map catMap,
                                 java.util.Map groupMap)

Deprecated. Used instead duplicate(WizardContext, boolean)

Performs a deep duplicate.

Parameters:

prefix - the title prefix

author - the author who perform the action

deep - boolean indicate if it is a deep copy

wkspc - the workspace to set

catMap - the binding map of old/new categories

groupMap - the binding map of old/new groups

Returns:

a newly created PortalElement instance, duplicate of this

Since:

jcms-4.1

duplicate

public PortalElement duplicate(WizardContext context,
                      boolean deep)

Performs a deep duplicate.

Parameters:

context - WizardContext describe the dupliate context

deep - boolean indicating if it is a deep copy

Returns:

a newly created PortalElement instance, duplicate of this

Since:

jcms-5.7.3

duplicateDeep

@Deprecated
protected void duplicateDeep(PortalElement parent,
                            java.lang.String prefix,
                            Member author,
                            Workspace wkspc,
                            java.util.Map catMap,
                            java.util.Map groupMap)

Deprecated. Used instead duplicateDeep(WizardContext, PortalElement)

Performs a deep duplicate of the PortalElement in a WizardContext. Update prefix, workspace, category, groups, ...

Parameters:

parent - the duplicated parent (Not already created in JCMS)

prefix - the title prefix

author - the author who perform the action

wkspc - the workspace to set

catMap - the binding map of old/new categories

groupMap - the binding map of old/new groups

Since:

jcms-4.1

duplicateDeep

protected void duplicateDeep(WizardContext context,
                 PortalElement parent)

Performs a deep duplicate of the PortalElement in a WizardContext. Update prefix, workspace, category, groups, ...

Parameters:

context - WizardContext describe the dupliate context

parent - PortalElement parent of portlets to deeply duplicate

Since:

jcms-5.7.3

getAbilities

public java.lang.String[] getAbilities()

getAbilities

public java.lang.String[] getAbilities(java.lang.String lang)

getAbilities

public java.lang.String[] getAbilities(java.lang.String lang,
                              boolean useDefault)

setAbilities

public void setAbilities(java.lang.String[] v)

hasAbility

public boolean hasAbility(java.lang.String ability)

Returns true if the portlet have the given ability Or if the ability is empty and the portlet have no ability

Parameters:

ability - Strign representing the ability

Returns:

boolean true if the portlet has the ability

addAbility

public void addAbility(java.lang.String ability)

Add the given ability to this portal abilities

Parameters:

ability - the ability to be added.

Since:

jcms-7.0

hasAbility

public boolean hasAbility()

Returns true if the portlet has an ability

Returns:

boolean true if the portlet has an ability

getAllAbilityMap

public static java.util.Map getAllAbilityMap()

Returns a Map (key1/key2) of all available abilities declared.

This method uses a cached Map of abilities.

Return a map like this one :

  {
    "portlet.ability.virtualdesktop" : { 
      "service" : "PortletSkinable"
    },
    "portlet.ability.internal" : {
      "stat" : "AbstractPortletStat AbstractPortletStatReport"
    },
    "portlet.ability.jcmsplugin" : {
       "foobar" : "Portlet"
       "collaborativespace.application" : "Portlet"
       "collaborativespace.dashboard" : "Portlet"
    } 
  }
  

Returns:

Map of abilities

getAllAbilityMapUI

public static java.util.Map<java.lang.String,java.util.List<java.lang.String>> getAllAbilityMapUI()

Retrieve all abilities in map easy to use for User Interface listing of abilities.

Help fix bug JCMS-2653 - Bad optgroup label in ability list.

The map computed by getAllAbilityMap() matches a complex structure not suitable for presentation purpose.

In order to properly and easily list abilities without losing backward compatibility, this method converts the map returned by getAllAbilityMap() into a simpler representation like this one :

 
  {
    "portlet.ability.virtualdesktop" : [ "service" ],
    "portlet.ability.internal" : [ "stat" ],
    "portlet.ability.jcmsplugin" : [ "foobar" ],
    "portlet.ability.jcmsplugin.collaborativespace" : [ "application", "dashboard" ]
  }
  

The key match a "parent ability" suitable for use in a optgroup label.
The values match the suffix to add to the key in order to get a full and valid ability.

Returns:

a Map

Since:

jcms-7.0.3 jcms-7.1

getAllAbilities

public static java.lang.String[] getAllAbilities()

Returns an Array of all available abilities declared for the given class. This methode use cached abilities.

Returns:

String[] an array of abilities

getAllAbilities

public static java.lang.String[] getAllAbilities(java.lang.Class clazz)

Returns an Array of all available abilities declared for the given class

Parameters:

clazz - the class used to filter abilities

Returns:

String[] an array of abilities

getAbilityLabel

public java.lang.String getAbilityLabel(java.lang.String userLang,
                               java.lang.String ability)

Returns the label of a given ability

Parameters:

userLang - the user language

ability - the ability

Returns:

String the I18N ability

getDataIcon

public java.lang.String getDataIcon()

Description copied from class: Data

Returns source information for the icon associated to this Data, either a relative path or sprite classes name.

If this method behavior has not been overriden by subclass, the default icon can be declared using property types.{Type}.icon, where {Type} is the short class name of the type concerned.

• Either by specifying a relative image path :
  

  types.Article.icon: images/jalios/icon/abstract.gif 

• or else by using a sprite icon :
  

  types.Article.icon: ss_sprite ss_date

Overrides:

getDataIcon in class Publication

Returns:

a relative path (eg images/jalios/icon/abstract.gif) or sprite classes name (eg ss_sprite ss_date).

See Also:

Data.getDataIconHtml(String)

getIcon

public java.lang.String getIcon()

getTreeChildren

public java.util.Collection<? extends TreeNode> getTreeChildren()

Description copied from interface: TreeNode

Returns a Collection of TreeNode children of the current node

Specified by:

getTreeChildren in interface TreeNode

Overrides:

getTreeChildren in class Publication

Returns:

Collection of TreeNode

See Also:

TreeNode.getTreeChildren()

isTreeLeaf

public boolean isTreeLeaf()

Description copied from interface: TreeNode

Returns boolean true if the TreeNode is a leaf

Specified by:

isTreeLeaf in interface TreeNode

Overrides:

isTreeLeaf in class Publication

Returns:

boolean indicating if node is leaf or node

See Also:

TreeNode.isTreeLeaf()

isTreeNode

public boolean isTreeNode()

Description copied from interface: TreeNode

Returns boolean true if the TreeNode is a node

Specified by:

isTreeNode in interface TreeNode

Overrides:

isTreeNode in class Publication

Returns:

boolean indicating if node is leaf or node

See Also:

TreeNode.isTreeNode()

getTreeParent

public TreeNode getTreeParent()

Description copied from interface: TreeNode

Returns parent of the current node

Specified by:

getTreeParent in interface TreeNode

Overrides:

getTreeParent in class Publication

Returns:

TreeNode parent Node

See Also:

TreeNode.getTreeParent()

getTreeParent

public TreeNode getTreeParent(TreeNode node)

isChildTreeNode

public boolean isChildTreeNode(TreeNode child)

getAllTreeChildren

public java.util.Collection<PortalElement> getAllTreeChildren()

Retrieve a new collection containing all PortalElement children of this PortalElement

Returns:

a new Collection of PortalElement.

containsTreeDescendant

public boolean containsTreeDescendant(TreeNode tn)

Same as getAllTreeChildren() but stop when there is a match. This method can be use to detect cycles

Parameters:

tn - the treenode

Returns:

true if there is a match

performUpdate

public void performUpdate(Member mbr,
                 java.util.Map context)

Description copied from class: Publication

Performs data update

Overrides:

performUpdate in class Publication

Parameters:

mbr - the member which requests the write operation

context - a map which contains context parameters (may be null)

getAbilitySelector

public static PortalElement.AbilitySelector getAbilitySelector(java.lang.String ability)

Retrieves a new instance of PortalElement.AbilitySelector using the specified ability String.

Parameters:

ability - an ability choosen from values returned by getAllAbilities(), or "noabilities" for portlet without any ability, or "hasabilities" for portlet with any ability.

Returns:

a new instance of PortalElement.AbilitySelector using the given ability String.

Since:

jcms-5.7.1