com.jalios.jcmsplugin.explorer
Class ExplorerHandler

java.lang.Object
  com.jalios.jcms.context.JcmsContext
      com.jalios.jcms.context.JcmsJspContext
          com.jalios.jcmsplugin.explorer.ExplorerHandler

All Implemented Interfaces:

JcmsConstants, JaliosConstants

public class ExplorerHandler
extends JcmsJspContext

ExplorerHandler is a JavaBean which retrieve and update an Explorer instance. Invoke ExplorerHandler JavaBean to :

• 1. Retrieve an explorer instance
• Either by retrieving an existing Explorer from session attribute (if the request parameter "exId" has been specified)
• Or else, creates an Explorer (if it could not be found in session and if allowed by the 'create' parameter of this bean).
  If an ExplorerConfiguration has been position in request attribute it is used by the newly create Explorer, otherwise a default config is used
• 2. Read request parameters and apply them to the Explorer found in step 1

Version:

$Revision: 21399 $

Author:

Olivier Jaquemet

Field Summary

Fields inherited from class com.jalios.jcms.context.JcmsJspContext

BODY_HEADER, CSS_HEADER, cssboMap, cssfoMap, CUSTOM_HEADER, editIcon, HTTPEQUIV_HEADER, httpequivMap, HTTPNAME_HEADER, httpnameMap, initEditIcon, JAVASCRIPT_CODE_SET_ATTRIBUTE, JAVASCRIPT_SET_ATTRIBUTE, JS_HEADER, jsboMap, jsboSet, jsfoMap, jsfoSet, out, pageContext, REVISION, SHOW_EDIT_ICON, STYLE_HEADER

Fields inherited from class com.jalios.jcms.context.JcmsContext

browser, caddy, channel, inFO, initDone, initWorkspace, isAdmin, isAjaxRequest, isDebug, isLogged, loggedMember, request, response, userLang, userLocale, workspace

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, CRYPT_MD5, CRYPT_UNDEFINED, CRYPT_UNIX, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DAILY_MAIL_ALERT, 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, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, MONTHLY_MAIL_ALERT, NO_MAIL_ALERT, OP_CREATE, OP_DEEP_COPY, OP_DEEP_DELETE, OP_DELETE, OP_MERGE, OP_UPDATE, PDATE_SEARCH, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_WIDTH, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_WIDTH, PHOTO_TINY_HEIGHT, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, URL_REGEXP, WARNING_MSG, WEBAPP_PROP, WEEKLY_MAIL_ALERT, 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

ExplorerHandler()

Method Summary

Explorer	getExplorer() Retrieves the Explorer instance managed by this handler.
boolean	isAjaxRequest() Checks if the current request is an ajax request or if it is a the 'first' request used to create/init the explorer.
void	setExAjax(boolean isAjax) Defines if this request is an ajax request or not.
void	setExCatMode(String catMode) Sets the category refinement mode to use.
void	setExCids(String cids) Sets all the categories to be used for refinement
void	setExContentTypes(String[] contentTypes) Sets the content type refinement to use in the Explorer
void	setExFields(String[] fields) Sets the fields that should be displayed in explorer view.
void	setExId(String exId) Sets the Explorer id that will be manipulated by this handler.
void	setExOcids(String ocids) Sets the categories to open in the TreeCat
void	setExPreviewId(String previewId) Sets the id of the Publication to preview in the explorer
void	setExPstatus(String[] pstatus) Sets the pstatus to use for refinement in the Explorer
void	setExSearchInFiles(boolean searchInFiles) Sets whether to perform search in files or not
void	setExShowInvisiblePubs(boolean showInvisiblePubs) Sets whether to display invisible publication or not
void	setExSrc(String src) Sets the new source to be used by the Explorer
void	setExText(String text) Sets the text to search
void	setExToggleCid(String catId) Sets a category to be added/remove (toggled) from the refinement option of the Explorer
void	setExTypes(String[] types) Sets the type refinement to be use in the Explorer
void	setExViewMode(String viewMode) Sets the new view mode value to be use by the Explorer.
void	setExWrkspc(String wrkspcId) Sets the workspace to be used by explorer for refinement
boolean	validate(boolean create) Compute and update the Explorer being worked on base on request parameters set by this Handler.

Methods inherited from class com.jalios.jcms.context.JcmsJspContext

addBodyAttributes, addCSSHeader, addCSSHeader, addCSSHeader, addCSSHeader, addCustomHeader, addHttpEquivHeader, addHttpNameHeader, addJavaScript, addJavaScript, addJavaScript, addJavaScriptCode, addJSHeader, addJSHeader, addJSHeader, addJSHeader, addStyleHeader, addStyleHeader, debugDisplayContext, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBackOfficeJSHeader, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSMap, getFinalJavaScriptSet, getFormElementCount, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, getFrontOfficeJSHeader, getHttpEquivHeaders, getHttpNameHeaders, getJavaScriptCodeSet, getJavaScriptSet, getJSHeaders, getJSONBridge, getPageContext, getPageTitle, getPageZone, getPortal, getPortalCategory, getPortlet, getPublication, getStyleHeaders, getTemplateUsage, internalSetupEmptyHeader, isEditIcon, isPrintView, registerDisplayContext, setAjaxRequestAttribute, setAjaxRequestId, setAllHeadersDiffMap, setDocType, setEditIcon, setFormElementCount, setPageContext, setPageTitle, setPageZone, setShowEditIcon, setTemplateUsage, showEditIcon

Methods inherited from class com.jalios.jcms.context.JcmsContext

addCookie, forceWorkspaceUpdate, getBaseUrl, getBrowser, getCaddy, getContextPath, getErrorMsg, getInfoMsg, getLoggedMember, getRequest, getResponse, getSession, getUploadedFile, getUploadedFileList, getUrlWithCommonUpdatedParams, getUserLang, getUserLocale, getWarningMsg, getWorkspace, glp, isAdmin, isDebug, isInFrontOffice, isLogged, isWebdavAccess, retrieveUploadedFile, sendForbidden, sendForbidden, sendRedirect, sendRedirect, sendRedirect, setErrorMsg, setErrorMsg, setErrorMsgSession, setErrorMsgSession, setInfoMsg, setInfoMsg, setInfoMsgSession, setInfoMsgSession, setLoggedMember, setRequest, setResponse, setWarningMsg, setWarningMsg, setWarningMsgSession, setWarningMsgSession, validateRegexp

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExplorerHandler

public ExplorerHandler()

Method Detail

validate

public boolean validate(boolean create)

Compute and update the Explorer being worked on base on request parameters set by this Handler.

Parameters:

create - true to create a new Explorer instance if no Explorer could be found from the exId parameter, false to skip processing.

Returns:

true if the validation was successful, false otherwise (in the later case, not other operation on the handler should be performed)

getExplorer

public Explorer getExplorer()

Retrieves the Explorer instance managed by this handler.
This method MUST be called after a call to the validate method which performs the retrieval of the Explorer based on the exId request parameter (or the creation of a new Explorer if create parameter has been set to true).

Returns:

the Explorer instance or null if the explorer could not be found

isAjaxRequest

public boolean isAjaxRequest()

Checks if the current request is an ajax request or if it is a the 'first' request used to create/init the explorer. Default value is false, unless modified by setExAjax(boolean).

Overrides:

isAjaxRequest in class JcmsContext

Returns:

true if the request is ajax, false otherwise

setExAjax

public void setExAjax(boolean isAjax)

Defines if this request is an ajax request or not. Default value is false.

Parameters:

isAjax - true to inform that this request is an ajax request

setExId

public void setExId(String exId)

Sets the Explorer id that will be manipulated by this handler.
A call to this method with a valid ID is required for this handler to be useful.

Parameters:

exId - the Explorer ID

setExViewMode

public void setExViewMode(String viewMode)

Sets the new view mode value to be use by the Explorer.

Parameters:

viewMode - the new view mode value to use, from ExplorerUtils.getAvailableViewModes()

setExSrc

public void setExSrc(String src)

Sets the new source to be used by the Explorer

Parameters:

src - a source from ExplorerUtils.getAvailableSrc()

setExWrkspc

public void setExWrkspc(String wrkspcId)

Sets the workspace to be used by explorer for refinement

Parameters:

wrkspcId - a Workspace ID or anyhing else to reset workspace refinement

setExCatMode

public void setExCatMode(String catMode)

Sets the category refinement mode to use.

Parameters:

catMode - a string indicating the mode to use, choosen from "one", "and", "or".

setExCids

public void setExCids(String cids)

Sets all the categories to be used for refinement

Parameters:

cids - an string with Categories' id seperated with comma

setExOcids

public void setExOcids(String ocids)

Sets the categories to open in the TreeCat

Parameters:

ocids - an array of Categories' id

setExToggleCid

public void setExToggleCid(String catId)

Sets a category to be added/remove (toggled) from the refinement option of the Explorer

Parameters:

catId - an id of a Category

setExText

public void setExText(String text)

Sets the text to search

Parameters:

text - whatever text to search

setExTypes

public void setExTypes(String[] types)

Sets the type refinement to be use in the Explorer

Parameters:

types - an array of String, each string being a classname, eg. {"Content", "generated.Article"}

setExContentTypes

public void setExContentTypes(String[] contentTypes)

Sets the content type refinement to use in the Explorer

Parameters:

contentTypes - an array of String, each string being a content type regexp from the allowed values ExplorerUtils.getAvailableContentTypes(), eg. {"text/*", "application/msword"}

setExPstatus

public void setExPstatus(String[] pstatus)

Sets the pstatus to use for refinement in the Explorer

Parameters:

pstatus - an array of String, each string being a pstatus, eg. {"-10", "20"}

setExShowInvisiblePubs

public void setExShowInvisiblePubs(boolean showInvisiblePubs)

Sets whether to display invisible publication or not

Parameters:

showInvisiblePubs - true to display invisible publication, false otherwise

setExSearchInFiles

public void setExSearchInFiles(boolean searchInFiles)

Sets whether to perform search in files or not

Parameters:

searchInFiles - true to search in content of files, false otherwise

setExPreviewId

public void setExPreviewId(String previewId)

Sets the id of the Publication to preview in the explorer

Parameters:

previewId - a Publication id

setExFields

public void setExFields(String[] fields)

Sets the fields that should be displayed in explorer view.

Parameters:

fields - an array of field name e.g. { "id", "title", "mdate" }