Class ExplorerQueryHandler

  • All Implemented Interfaces:
    com.jalios.jcms.JcmsConstants, com.jalios.util.JaliosConstants
    Direct Known Subclasses:
    ExplorerAppHandler, ExplorerJMobileHandler

    public class ExplorerQueryHandler
    extends com.jalios.jcms.handler.JcmsUploadFormHandler
    Performs the query of the explorer
    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.lang.Boolean canUploadDocuments  
      protected java.lang.String[] documentKinds  
      protected java.util.Date endDate  
      protected com.jalios.jcms.Category explorerCurrentCategory  
      protected java.util.Set<com.jalios.jcms.Category> explorerRootCategories  
      protected java.lang.String explorerSearch  
      protected java.lang.String[] mids  
      protected int pageSize  
      protected java.util.List<com.jalios.jcms.Category> pinnedCategories  
      protected generated.PortletExplorer portletExplorer  
      protected com.jalios.jcms.handler.QueryHandler queryHandler  
      protected java.lang.Class queryHandlerTypesCommonSuperClass  
      protected ExplorerResult result  
      static java.lang.String RPF_CTXT_CATEGORIES  
      protected boolean showUncategorizedContent  
      protected java.lang.String spellSuggestion  
      protected int start  
      protected java.util.Date startDate  
      protected java.lang.String[] types  
      • Fields inherited from class com.jalios.jcms.handler.JcmsUploadFormHandler

        FAKE_ID_ADDITION
      • Fields inherited from class com.jalios.jcms.handler.JcmsFormHandler

        contextMap, csrfValidationEnabled, editFieldSet, formStep, noRedirect, noSendRedirect, op, opFinish, opNext, opPrevious, popupEdition, redirect, redirectOnClosePopup, REVISION, workspaceForced
      • Fields inherited from class com.jalios.jcms.context.JcmsJspContext

        AJAX_REQUEST_ATTRIBUTES, BODY_HEADER, CSS_FOOTER, CSS_HEADER, cssboMap, cssfoMap, CUSTOM_HEADER, editIcon, HTTPEQUIV_HEADER, httpequivMap, HTTPNAME_HEADER, httpnameMap, initEditIcon, JAVASCRIPT_CODE_SET_ATTRIBUTE, JAVASCRIPT_SET_ATTRIBUTE, jsboSet, jsfoSet, out, pageContext, SHOW_EDIT_ICON, STYLE_HEADER
      • Fields inherited from class com.jalios.jcms.context.JcmsContext

        browser, caddy, channel, inFO, initDone, initWorkspace, isAdmin, isAjaxRequest, isDBMember, isDebug, isDebugTemplatePath, isLogged, loggedMember, request, response, userCountry, userLang, userLocale, userZoneId, workspace
      • 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
      • Fields inherited from interface com.jalios.jcms.JcmsConstants

        ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, AJAX_MODE_ATTR, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, CLASS_PROPERTY, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, CS_TYPOLOGY_ROOT_CAT_VID, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DATA_DIRECTORY, DEFAULT_PHOTO_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, GLYPH_ICON_PREFIX, ICON_ARCHIVE, ICON_ICON_PREFIX, ICON_LOCK, ICON_LOCK_STRONG, ICON_PREFIX_PROP, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, IS_IN_FRONT_OFFICE, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JCMS_TOASTR_COLLECTION, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LANG_SPRITE, 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, ORGANIZATION_ROOT_GROUP_PROP, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_PROP_PREFIX, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_PROP_PREFIX, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_PROP_PREFIX, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_PROP_PREFIX, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_PROP_PREFIX, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, RAW_CONTENT_ICON_PREFIX, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SECURITY_LOG_FILE, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, SUCCESS_MSG, SVG_ICON_PREFIX, SVGINLINE_ICON_PREFIX, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TTCARD_MEDIA_HEIGHT, TTCARD_MEDIA_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, UPLOAD_PERMISSION_COUNT_PROP_PREFIX, UPLOAD_PERMISSION_SIZE_PROP_PREFIX, URL_REGEXP, VID_LOGGED_MEMBER, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean canUploadDocuments()  
      boolean canUploadDocumentsInCategory​(com.jalios.jcms.Category cat)  
      boolean canUploadDocumentsInCurrentCategory()  
      java.util.Date getAvailableEndDate()  
      com.jalios.jcms.Category getAvailableExplorerCurrentCategory()  
      java.util.Set<com.jalios.jcms.Category> getAvailableExplorerRootCategories()  
      java.util.List<com.jalios.jcms.Category> getAvailablePinnedCategories()  
      generated.PortletExplorer getAvailablePortletExplorer()  
      java.util.Date getAvailableStartDate()  
      java.util.Map<java.lang.String,​java.lang.Object> getCanPublishContextMapWithContextualCategories()  
      java.util.Set<java.lang.Class<? extends com.jalios.jcms.Publication>> getCanPublishTypeClasses()  
      java.lang.String getCurrentCategoryName()  
      java.util.List<java.lang.Class> getDocumentClasses()  
      java.lang.String[] getDocumentKinds()  
      java.lang.String getExplorerSearch()  
      java.lang.String getExplorerSort()  
      java.lang.String[] getMids()  
      int getPageSize()  
      java.util.Set<java.lang.Class<? extends com.jalios.jcms.Publication>> getPortletTypeClasses()  
      com.jalios.jcms.Category getPublicationParentFolder​(com.jalios.jcms.Publication pub)  
      com.jalios.jcms.handler.QueryHandler getQueryHandler()  
      java.lang.String getQueryHandlerQueryString()  
      ExplorerResult getResult()  
      java.lang.String getSpellSuggestion()  
      int getStart()  
      java.lang.Class<? extends com.jalios.jcms.Publication> getSuperCommonDocumentClass()  
      java.util.Set<java.lang.Class<? extends com.jalios.jcms.Publication>> getTypeClasses()  
      java.lang.String[] getTypes()  
      boolean hasDocumentType()  
      boolean hasMoreResults()  
      void initExplorerRootCategories()  
      boolean isCurrentCategoryInRoot()  
      boolean isCurrentCategoryRoot()  
      boolean isDocumentOnly()  
      boolean isExplorerSortDescending()  
      boolean isFiltered()  
      boolean isFilteredTypeDocument()  
      boolean isMultiRootExplorer()  
      boolean isPortletDocumentKindFiltered()  
      boolean isRefinedOnWorkspace()  
      protected boolean isRootCategory​(com.jalios.jcms.Category cat)  
      boolean isShowUncategorizedContent()  
      protected void performQuery()
      Perform the queries of portlet
      boolean processAction()  
      void setDocumentKinds​(java.lang.String[] v)  
      void setEndDate​(java.lang.String v)  
      void setExplorerCurrentCategory​(java.lang.String explorerCurrentCategory)  
      void setExplorerSearch​(java.lang.String explorerSearch)  
      void setExplorerSort​(java.lang.String explorerSort)  
      void setExplorerSortDescending​(boolean explorerSortDescending)  
      void setMids​(java.lang.String[] mids)  
      void setPageSize​(int pageSize)  
      void setPinnedCategoryIds​(java.lang.String[] pinnedCategoryIds)  
      void setPortletExplorer​(java.lang.String portletExplorer)  
      void setResult​(ExplorerResult result)  
      void setShowUncategorizedContent​(boolean showUncategorizedContent)  
      void setStart​(int start)  
      void setStartDate​(java.lang.String v)  
      void setTypes​(java.lang.String[] types)  
      • Methods inherited from class com.jalios.jcms.handler.JcmsUploadFormHandler

        createUploadedFileDocument, createUploadedFileDocument, createUploadedFileDocument, createUploadedFileDocument, doPrepareFileDocuments, getFakeUniqueId, getFileDocument, getFileDocumentClass, getFileDocumentClass, getFileDocuments, getFileDocuments, getFileDocumentsML, getFormHiddenFields, getFormStepHiddenFields, getFormUniqueId, getTemporaryDir, isFakeUniqueId, removeFileDocuments, setFileDocuments, setFileDocuments, setFileDocuments, setFileDocuments, setFileDocuments, setFileDocuments, setFileDocumentsML, setFileDocumentsML, setFileDocumentsML, setFormUniqueId, validateUploadedFileDocument, validateUploadedFileDocument
      • Methods inherited from class com.jalios.jcms.handler.JcmsFormHandler

        afterValidation, checkMissingField, getAvailableMainLanguage, getClosePopupUrl, getControllerContext, getEditFieldSet, getFormStep, getFormStepCount, getFormStepFinishLabel, getFormStepLabels, getFormStepPrefixProp, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenFieldML, getMainLangValue, getMainLangValueArray, getMLMap, getMLMapArray, getModalRedirect, getMonolingualValue, getMonolingualValueArray, getMultilingualMainValue, getMultilingualMainValueArray, getMultilingualMLMap, getMultilingualMLMapArray, getRedirect, getRedirectOnClosePopup, getRunningProcess, getWorkspace, init, isFieldEdition, isFieldMissing, isFormStepClickable, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, mapStringArrayToMapStringList, mapStringListToMapStringArray, mustSendForbiddenOnCSRF, performFinish, performNext, performPrevious, processStatus, sanitize, sanitize, sendRedirect, sendRedirect, setEditField, setFormStep, setNoRedirect, setNoSendRedirect, setOpFinish, setOpNext, setOpPrevious, setPopupEdition, setRedirect, setRedirectOnClosePopup, setRunningProcess, setWorkspace, setWs, showCancelButton, showFinishButton, showNextButton, showPreviousButton, updateUploadedField, updateUploadedFields, updateUploadedFields, validate, validateCSRF, validateFinish, validateNext, validatePrevious
      • Methods inherited from class com.jalios.jcms.context.JcmsJspContext

        addAvoidanceLink, addBodyAttributes, addCSSHeader, addCSSHeader, addCSSHeader, addCSSHeader, addCustomHeader, addHandlebarTemplate, addHttpEquivHeader, addHttpNameHeader, addJavaScript, addJavaScript, addJavaScript, addJavaScriptCode, addPrefetchHeader, addStyleHeader, addStyleHeader, addWebAssets, checkAccess, checkAccess, checkCSRF, debugDisplayContext, disablePacker, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getAvoidanceLinks, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSFooterMap, getFinalCSSMap, getFinalJavaScriptSet, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, getHandlebarTemplates, getHttpEquivHeaders, getHttpNameHeaders, getJavaScriptCodeSet, getJavaScriptSet, getJSONBridge, getPageContext, getPageTitle, getPageZone, getPortal, getPortalCategory, getPortlet, getPublication, getStyleHeaders, getTemplateUsage, internalSetupEmptyHeader, isEditIcon, isEditIcon, isEditIconForPublish, isEditIconForPublish, isPrintView, registerDisplayContext, removeAjaxRequestAttribute, setAjaxRequestAttribute, setAjaxRequestId, setAllHeadersDiffMap, setDocType, setEditIcon, setPageContext, setPageTitle, setPageZone, setShowEditIcon, setTemplateUsage, showEditIcon, showEditIcon, showEditIcon, workaroundBrowserBaseHrefBug
      • Methods inherited from class com.jalios.jcms.context.JcmsContext

        addCookie, addMsg, addMsg, addMsgSession, addMsgSession, addToastr, addToastr, addToastrSession, addToastrSession, applySelector, forceWorkspaceUpdate, getBaseUrl, getBrowser, getCaddy, getContextPath, getErrorMsg, getErrorMsgList, getErrorMsgSession, getErrorMsgSessionList, getInfoMsg, getInfoMsgList, getInfoMsgSession, getInfoMsgSessionList, getLoggedMember, getMsgList, getMsgSessionList, getRequest, getResponse, getSession, getSuccessMsg, getSuccessMsgList, getSuccessMsgSession, getSuccessMsgSessionList, getToastrCollection, getToastrSessionCollection, getUploadedFile, getUploadedFileList, getUploadedFiles, getUploadedFiles, getUrlWithCommonUpdatedParams, getUserCountry, getUserLang, getUserLocale, getUserZoneId, getWarningMsg, getWarningMsgList, getWarningMsgSession, getWarningMsgSessionList, glp, isAdmin, isAdminZone, isAjaxRequest, isDBMember, isDebug, isDebugTemplate, isInFrontOffice, isLogged, isWebdavAccess, isWorkZone, removeMessage, removeMessage, retrieveUploadedFile, select, sendError, sendError, sendForbidden, sendForbidden, sendRedirect, sendRedirect, sendRedirect, setErrorMsg, setErrorMsg, setErrorMsgSession, setErrorMsgSession, setInfoMsg, setInfoMsg, setInfoMsgSession, setInfoMsgSession, setLoggedMember, setRequest, setResponse, setSuccessMsg, setSuccessMsg, setSuccessMsgSession, setSuccessMsgSession, setWarningMsg, setWarningMsg, setWarningMsgSession, setWarningMsgSession, updateWorkspace, validateRegexp, validateSchedule
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • RPF_CTXT_CATEGORIES

        public static final java.lang.String RPF_CTXT_CATEGORIES
        See Also:
        Constant Field Values
      • portletExplorer

        protected generated.PortletExplorer portletExplorer
      • pageSize

        protected int pageSize
      • start

        protected int start
      • explorerSearch

        protected java.lang.String explorerSearch
      • explorerRootCategories

        protected java.util.Set<com.jalios.jcms.Category> explorerRootCategories
      • explorerCurrentCategory

        protected com.jalios.jcms.Category explorerCurrentCategory
      • mids

        protected java.lang.String[] mids
      • startDate

        protected java.util.Date startDate
      • endDate

        protected java.util.Date endDate
      • queryHandler

        protected com.jalios.jcms.handler.QueryHandler queryHandler
      • queryHandlerTypesCommonSuperClass

        protected java.lang.Class queryHandlerTypesCommonSuperClass
      • documentKinds

        protected java.lang.String[] documentKinds
      • types

        protected java.lang.String[] types
      • showUncategorizedContent

        protected boolean showUncategorizedContent
      • spellSuggestion

        protected java.lang.String spellSuggestion
      • pinnedCategories

        protected java.util.List<com.jalios.jcms.Category> pinnedCategories
      • canUploadDocuments

        public java.lang.Boolean canUploadDocuments
    • Constructor Detail

      • ExplorerQueryHandler

        public ExplorerQueryHandler()
    • Method Detail

      • processAction

        public boolean processAction()
                              throws java.io.IOException
        Overrides:
        processAction in class com.jalios.jcms.handler.JcmsFormHandler
        Throws:
        java.io.IOException
      • getQueryHandlerQueryString

        public java.lang.String getQueryHandlerQueryString()
        Returns:
        the queryString of portlet query handlers
      • getQueryHandler

        public com.jalios.jcms.handler.QueryHandler getQueryHandler()
        Returns:
        the queryHandler of portletExplorer
      • isCurrentCategoryInRoot

        public boolean isCurrentCategoryInRoot()
      • isFilteredTypeDocument

        public boolean isFilteredTypeDocument()
      • performQuery

        protected void performQuery()
        Perform the queries of portlet
      • isFiltered

        public boolean isFiltered()
        Returns:
        true if a filter has been set on current query (Search, date, author ...)
      • isDocumentOnly

        public boolean isDocumentOnly()
        Returns:
        true if current portlet handlers uses only document types
      • hasDocumentType

        public boolean hasDocumentType()
        Returns:
        true if current portlet queries any document type
      • hasMoreResults

        public boolean hasMoreResults()
        Returns:
        true if current result has more results (To display a pager)
      • getDocumentClasses

        public java.util.List<java.lang.Class> getDocumentClasses()
        Returns:
        all document classes used in portlet QueryHandlers
      • getSuperCommonDocumentClass

        public java.lang.Class<? extends com.jalios.jcms.Publication> getSuperCommonDocumentClass()
        Returns:
        the super common class for Documents
      • getPageSize

        public int getPageSize()
      • setPageSize

        public void setPageSize​(int pageSize)
      • getStart

        public int getStart()
      • setStart

        public void setStart​(int start)
      • isMultiRootExplorer

        public boolean isMultiRootExplorer()
        Returns:
        true if explorer is multi root
      • isRootCategory

        protected boolean isRootCategory​(com.jalios.jcms.Category cat)
        Parameters:
        cat - a Category
        Returns:
        true if given Category is the root category of the explorer
      • getAvailablePortletExplorer

        public generated.PortletExplorer getAvailablePortletExplorer()
      • setPortletExplorer

        public void setPortletExplorer​(java.lang.String portletExplorer)
      • initExplorerRootCategories

        public void initExplorerRootCategories()
      • getAvailableExplorerRootCategories

        public java.util.Set<com.jalios.jcms.Category> getAvailableExplorerRootCategories()
      • isCurrentCategoryRoot

        public boolean isCurrentCategoryRoot()
      • getCurrentCategoryName

        public java.lang.String getCurrentCategoryName()
      • getAvailableExplorerCurrentCategory

        public com.jalios.jcms.Category getAvailableExplorerCurrentCategory()
      • setExplorerCurrentCategory

        public void setExplorerCurrentCategory​(java.lang.String explorerCurrentCategory)
      • getExplorerSearch

        public java.lang.String getExplorerSearch()
      • setExplorerSearch

        public void setExplorerSearch​(java.lang.String explorerSearch)
      • getMids

        public java.lang.String[] getMids()
      • setMids

        public void setMids​(java.lang.String[] mids)
      • setEndDate

        public void setEndDate​(java.lang.String v)
      • getAvailableEndDate

        public java.util.Date getAvailableEndDate()
      • setStartDate

        public void setStartDate​(java.lang.String v)
      • getAvailableStartDate

        public java.util.Date getAvailableStartDate()
      • getDocumentKinds

        public java.lang.String[] getDocumentKinds()
      • setDocumentKinds

        public void setDocumentKinds​(java.lang.String[] v)
      • getTypes

        public java.lang.String[] getTypes()
      • setTypes

        public void setTypes​(java.lang.String[] types)
      • getExplorerSort

        public java.lang.String getExplorerSort()
      • setExplorerSort

        public void setExplorerSort​(java.lang.String explorerSort)
      • getTypeClasses

        public java.util.Set<java.lang.Class<? extends com.jalios.jcms.Publication>> getTypeClasses()
        Returns:
        all type Classes of current portlet explorer
      • isPortletDocumentKindFiltered

        public boolean isPortletDocumentKindFiltered()
      • getCanPublishContextMapWithContextualCategories

        public java.util.Map<java.lang.String,​java.lang.Object> getCanPublishContextMapWithContextualCategories()
      • getCanPublishTypeClasses

        public java.util.Set<java.lang.Class<? extends com.jalios.jcms.Publication>> getCanPublishTypeClasses()
        Returns:
        all classes the member can publish
      • getPortletTypeClasses

        public java.util.Set<java.lang.Class<? extends com.jalios.jcms.Publication>> getPortletTypeClasses()
      • getAvailablePinnedCategories

        public java.util.List<com.jalios.jcms.Category> getAvailablePinnedCategories()
      • setPinnedCategoryIds

        public void setPinnedCategoryIds​(java.lang.String[] pinnedCategoryIds)
      • canUploadDocuments

        public boolean canUploadDocuments()
      • canUploadDocumentsInCurrentCategory

        public boolean canUploadDocumentsInCurrentCategory()
      • canUploadDocumentsInCategory

        public boolean canUploadDocumentsInCategory​(com.jalios.jcms.Category cat)
      • isShowUncategorizedContent

        public boolean isShowUncategorizedContent()
      • setShowUncategorizedContent

        public void setShowUncategorizedContent​(boolean showUncategorizedContent)
      • isExplorerSortDescending

        public boolean isExplorerSortDescending()
      • setExplorerSortDescending

        public void setExplorerSortDescending​(boolean explorerSortDescending)
      • getSpellSuggestion

        public java.lang.String getSpellSuggestion()
      • isRefinedOnWorkspace

        public boolean isRefinedOnWorkspace()
      • getPublicationParentFolder

        public com.jalios.jcms.Category getPublicationParentFolder​(com.jalios.jcms.Publication pub)