com.jalios.jcms.handler

Class CategoryQueryHandler

java.lang.Object

com.jalios.jcms.context.JcmsContext

com.jalios.jcms.context.JcmsJspContext

com.jalios.jcms.handler.JcmsFormHandler

com.jalios.jcms.handler.AbstractQueryHandler<Category>

com.jalios.jcms.handler.CategoryQueryHandler

All Implemented Interfaces:

JcmsConstants, JaliosConstants

public class CategoryQueryHandler
extends AbstractQueryHandler<Category>

Holder class and form handler of all parameters to be used for a query of categories.

Since:

jcms-10.0.5

Nested Class Summary

Nested classes/interfaces inherited from class com.jalios.jcms.handler.AbstractQueryHandler

AbstractQueryHandler.HiddenParamQhPrinter, AbstractQueryHandler.QueryHandlerPrinter, AbstractQueryHandler.QueryStringQhPrinter

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Boolean	addRoot
protected CategoryFilter	categoryFilter
protected java.lang.String	filter
protected boolean	pagerAll
protected int	pageSize
protected int	pageStart
protected java.util.Set<Category>	removeCategories
protected java.lang.String[]	removeCids
protected boolean	reverse
static java.lang.String	REVISION
protected java.util.Set<Category>	rootCategories
protected java.lang.String[]	rootCids
protected java.lang.Boolean	selectable
protected java.lang.String	sort
protected java.lang.String	text

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

contextMap, editFieldSet, formStep, noRedirect, noSendRedirect, op, opFinish, opNext, opPrevious, popupEdition, redirect, redirectOnClosePopup, 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.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, 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, 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, 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_SIZE_PROP_PREFIX, URL_REGEXP, VID_LOGGED_MEMBER, 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
CategoryQueryHandler() Constructs a new empty CategoryQueryHandler with default option.
CategoryQueryHandler(java.lang.String queryString) Constructs a new CategoryQueryHandler by parsing the specified query string.
CategoryQueryHandler(java.lang.String queryString, javax.servlet.http.HttpServletRequest request) Constructs a new CategoryQueryHandler by parsing the specified query string and using informations available from the specified request (logged member, user language, etc).

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFilter() Retrieve the current category filter being used by this CategoryQueryHandler.
protected org.apache.log4j.Logger	getLogger()
PageResult<Category>	getPageResult() Return results of a query done using this CategoryQueryHandler.
int	getPageSize() Get the page size
java.lang.String[]	getRemoveCids() Retrieves the id array of root categories, whose descendant (included this category) are removed from results
java.lang.String[]	getRootCids() Retrieves the id of root categories used in this query
java.lang.String	getSort() Retrieve current sorting criteria
int	getStart() Get the start index to use for paging
java.lang.String	getText() Retrieves the text being search in this query
boolean	isAddRoot() Retrieves the flag to indicate if root categories should be added in results or not
boolean	isPagerAll() Get the paging option of this handler
boolean	isReverse() Check the ordering of the sort criteria
boolean	isSelectable() Retrieves the selectable flag, which indicate if only selectables categories are put in the query results
protected void	parseQueryStringParam(java.lang.String key, java.lang.String[] values) Method to be implemented by subclass to decode parameter from queryString.
protected java.lang.String	printParams(AbstractQueryHandler.QueryHandlerPrinter printer) Print current QueryHandler params using specified QueryHandlerPrinter.
void	setAddRoot(boolean addRoot) Set the flag to indicate if root categories should be added in results or not.
void	setCategoryFilter(CategoryFilter categoryFilter) Define the categoryFilter to use in this CategoryQueryHandler.
void	setFilter(java.lang.String filter) Define the categoryFilter to use in this CategoryQueryHandler.
void	setPagerAll(boolean pagerAll) Set the pagerAll option of this handler
void	setPageSize(int pageSize) Set the page size
void	setRemoveCategories(java.util.Set<Category> removeCategories) Set the Set of root categories, whose descendant (included this category) are removed from results
void	setRemoveCids(java.lang.String[] removeCids) Set the id array of root categories, whose descendant (included this category) are removed from results
void	setReverse(boolean reverse) Set the ordering of the sort criteria
void	setRootCategories(java.util.Set<Category> rootCategories) Set the root categories used in this query
void	setRootCids(java.lang.String[] rootCids) Set the id of root categories used in this query
void	setSelectable(boolean selectable) Set the selectable flag (true if only selectable categories are put in results) (true by default)
void	setSort(java.lang.String sort) Set the sorting criteria
void	setStart(int start) Set the start index to use for paging
void	setText(java.lang.String text) Set the text to search in category
java.lang.String	toString()

Methods inherited from class com.jalios.jcms.handler.AbstractQueryHandler

getAttribute, getAttributeMap, getDataSet, getHiddenParams, getQueryString, init, parseQueryString, removeAttribute, setAttribute, setDataSet

Methods inherited from class com.jalios.jcms.handler.JcmsFormHandler

afterValidation, checkMissingField, getAvailableMainLanguage, getClosePopupUrl, getControllerContext, getEditFieldSet, getFormStep, getFormStepCount, getFormStepFinishLabel, getFormStepHiddenFields, 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, getWorkspace, init, isFieldEdition, isFieldMissing, isFormStepClickable, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, mapStringArrayToMapStringList, mapStringListToMapStringArray, performFinish, performNext, performPrevious, processAction, processStatus, sanitize, sanitize, sendRedirect, sendRedirect, setEditField, setFormStep, setNoRedirect, setNoSendRedirect, setOpFinish, setOpNext, setOpPrevious, setPopupEdition, setRedirect, setRedirectOnClosePopup, setWorkspace, setWs, showCancelButton, showFinishButton, showNextButton, showPreviousButton, updateUploadedField, updateUploadedFields, validate, 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, 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, validateRegexp, validateSchedule

Methods inherited from class java.lang.Object

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

Field Detail

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

filter

protected java.lang.String filter

text

protected java.lang.String text

rootCids

protected java.lang.String[] rootCids

selectable

protected java.lang.Boolean selectable

addRoot

protected java.lang.Boolean addRoot

removeCids

protected java.lang.String[] removeCids

rootCategories

protected transient java.util.Set<Category> rootCategories

removeCategories

protected transient java.util.Set<Category> removeCategories

categoryFilter

protected transient CategoryFilter categoryFilter

sort

protected java.lang.String sort

reverse

protected boolean reverse

pageStart

protected int pageStart

pageSize

protected int pageSize

pagerAll

protected boolean pagerAll

Constructor Detail

CategoryQueryHandler

public CategoryQueryHandler()

Constructs a new empty CategoryQueryHandler with default option.

Since:

jcms-10.0.5

CategoryQueryHandler

public CategoryQueryHandler(java.lang.String queryString)

Constructs a new CategoryQueryHandler by parsing the specified query string.

See CategoryQueryHandler(String, HttpServletRequest) for a list of the decoded parameters.

Parameters:

queryString - a query String consisting of parameters (key=value) to be set in this handler.

• Parameters must be separated with ampersand (&).
• Values must be encoded in UTF-8.
• Query must not starts with question mark (?) e.g : "text=welcome&rootCid=j_42"

Since:

jcms-10.0.5

CategoryQueryHandler

public CategoryQueryHandler(java.lang.String queryString,
                            javax.servlet.http.HttpServletRequest request)

Constructs a new CategoryQueryHandler by parsing the specified query string and using informations available from the specified request (logged member, user language, etc).

The following parameters (and only those listed here) will be automatically decoded from the specified query string. Other parameters should be set using apropriate setters.

• "filter" : setFilter(String)
• "text" : setText(String)
• "selectable" : setSelectable(boolean)
• "addRoot" : setAddRoot(boolean)
• "rootCids" : setRootCids(String[])
• "removeCids" : setRemoveCids(String[])

Parameters:

queryString - a query String consisting of parameters (key=value) to be set in this handler.

• Parameters must be separated with ampersand (&).
• Values must be encoded in UTF-8.
• Query must not starts with question mark (?) e.g : "text=welcome&rootCid=j_42"

request - the HttpServletRequest to use to retrieve loggedMember, userLang, userLocale that will be used by this handler, ignored if null.

Since:

jcms-10.0.5

Method Detail

getLogger

protected org.apache.log4j.Logger getLogger()

Specified by:

getLogger in class AbstractQueryHandler<Category>

parseQueryStringParam

protected void parseQueryStringParam(java.lang.String key,
                                     java.lang.String[] values)

Description copied from class: AbstractQueryHandler

Method to be implemented by subclass to decode parameter from queryString.

Specified by:

parseQueryStringParam in class AbstractQueryHandler<Category>

Parameters:

key - the parameter name, never null nor empty.

values - the parameter values, NEVER NULL NOR EMPTY. You can safely invoke paramValues[0]

printParams

protected java.lang.String printParams(AbstractQueryHandler.QueryHandlerPrinter printer)

Print current QueryHandler params using specified QueryHandlerPrinter.

Specified by:

printParams in class AbstractQueryHandler<Category>

Parameters:

printer - a QueryHandlerPrinter to use

Returns:

a string containing all parameters of this handler printed using specified QueryHandlerPrinter.

Since:

jcms-10.0.5

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getPageResult

public PageResult<Category> getPageResult()

Return results of a query done using this CategoryQueryHandler.

Warning: This method process the query each time it is invoked, therefore do not call it multiple times if you don't need it.

Returns:

a new PageResult containing all category found by this query, sorted using specified comparator if any.

setStart

public void setStart(int start)

Set the start index to use for paging

Parameters:

start - the index of the first member to be displayed in current page

getStart

public int getStart()

Get the start index to use for paging

Returns:

the index of the first member to be displayed in current page

setPageSize

public void setPageSize(int pageSize)

Set the page size

Parameters:

pageSize - the number of element to be displayed

getPageSize

public int getPageSize()

Get the page size

Returns:

the number of element to be displayed

setSort

public void setSort(java.lang.String sort)

Set the sorting criteria

Possible sorting option :

• "id" : Member id (quite useless when working with both Member and DBMember as they do not compare)
• "cdate" : Member creation date
• "login" : Member's login
• "firstname" : Member's firstname
• "name" or "lastname" : Member's lastname
• "usage" : Member's usage (account / contact)

Parameters:

sort - a field name that should be used for sorting

getSort

public java.lang.String getSort()

Retrieve current sorting criteria

Returns:

a lucene field name that should be used for sorting

setReverse

public void setReverse(boolean reverse)

Set the ordering of the sort criteria

Parameters:

reverse - true if the reverse order should be used

isReverse

public boolean isReverse()

Check the ordering of the sort criteria

Returns:

true if the reverse order should be used

setPagerAll

public void setPagerAll(boolean pagerAll)

Set the pagerAll option of this handler

Parameters:

pagerAll - true if all item should be displayed

isPagerAll

public boolean isPagerAll()

Get the paging option of this handler

Returns:

true if all item should be displayed

getFilter

public java.lang.String getFilter()

Retrieve the current category filter being used by this CategoryQueryHandler.

Returns:

a string indicating the filter being applied

Since:

jcms-10.0.5

See Also:

CategoryFilter

setFilter

public void setFilter(java.lang.String filter)

Define the categoryFilter to use in this CategoryQueryHandler.

Parameters:

filter - a string indicating the filter being applied, see constructor CategoryFilter for more information on possible values

getText

public java.lang.String getText()

Retrieves the text being search in this query

Returns:

a string or null if no text is being searched

setText

public void setText(java.lang.String text)

Set the text to search in category

Parameters:

text - any string to look for in category's name

getRootCids

public java.lang.String[] getRootCids()

Retrieves the id of root categories used in this query

Returns:

a string array or null if no root categories are used for this query

setRootCids

public void setRootCids(java.lang.String[] rootCids)

Set the id of root categories used in this query

Parameters:

rootCids - any string array with root categories ids

isSelectable

public boolean isSelectable()

Retrieves the selectable flag, which indicate if only selectables categories are put in the query results

Returns:

the value of the selectable flag

setSelectable

public void setSelectable(boolean selectable)

Set the selectable flag (true if only selectable categories are put in results) (true by default)

Parameters:

selectable - true if only selectable categories are put in results, false otherwise

isAddRoot

public boolean isAddRoot()

Retrieves the flag to indicate if root categories should be added in results or not

Returns:

true if root categories should be added in result.

setAddRoot

public void setAddRoot(boolean addRoot)

Set the flag to indicate if root categories should be added in results or not. default value is false

Parameters:

addRoot - true if root categories should be added in result, false otherwise

getRemoveCids

public java.lang.String[] getRemoveCids()

Retrieves the id array of root categories, whose descendant (included this category) are removed from results

Returns:

a string array of root categories, whose descendant (included this category) are removed from results

setRemoveCids

public void setRemoveCids(java.lang.String[] removeCids)

Set the id array of root categories, whose descendant (included this category) are removed from results

Parameters:

removeCids - a string array of root categories, whose descendant (included this category) are removed from results

setRootCategories

public void setRootCategories(java.util.Set<Category> rootCategories)

Set the root categories used in this query

Parameters:

rootCategories - Set of root categories

setRemoveCategories

public void setRemoveCategories(java.util.Set<Category> removeCategories)

Set the Set of root categories, whose descendant (included this category) are removed from results

Parameters:

removeCategories - a Set of root categories, whose descendant (included this category) are removed from results

setCategoryFilter

public void setCategoryFilter(CategoryFilter categoryFilter)

Define the categoryFilter to use in this CategoryQueryHandler.

Parameters:

categoryFilter - a string indicating the filter being applied, see constructor CategoryFilter for more information on possible values