com.jalios.jcms.handler

Class AllMemberQueryHandler

java.lang.Object

com.jalios.jcms.context.JcmsContext

com.jalios.jcms.context.JcmsJspContext

com.jalios.jcms.handler.JcmsFormHandler

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

com.jalios.jcms.handler.AbstractMemberQueryHandler<DBMember>

com.jalios.jcms.handler.AllMemberQueryHandler

All Implemented Interfaces:

JcmsConstants, JaliosConstants

public class AllMemberQueryHandler
extends AbstractMemberQueryHandler<DBMember>

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

Since:

jcms-6.1

Version:

$Revision: 109137 $

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
static int	ALL_USAGE Value that can be specified to AbstractMemberQueryHandler.setUsage(int) to search for all members whatever their usage (both contact and account).
static java.lang.String	GROUP_MODE_AND
static java.lang.String	GROUP_MODE_OR
protected boolean	isGroupModeOr
protected LuceneMemberSearchEngine	mbrSearchEngine
static java.lang.String	REVISION

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

groupOffSet, groupSet, isMissingCriteria, pagerAll, pageSize, pageStart, reverse, sort

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

contextMap, editFieldSet, formStep, noRedirect, noSendRedirect, 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, 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, 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, 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
AllMemberQueryHandler() Constructs a new empty AllMemberQueryHandler with default option.
AllMemberQueryHandler(java.lang.String queryString) Constructs a new AllMemberQueryHandler by parsing the specified query string.
AllMemberQueryHandler(java.lang.String queryString, javax.servlet.http.HttpServletRequest request) Constructs a new AllMemberQueryHandler 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	getDescription() Returns a description of the query in the language defined by userLang of this handler.
java.lang.String	getEmail() Retrieves the email being search in this query
java.util.List<java.lang.String>	getIdResultList() Perform the Query and return a list of Member/DBMember id.
protected org.apache.log4j.Logger	getLogger()
PageResult<Member>	getPageResult() Returns a new PageResult of Member/DBMember for the current settings of this handler.
boolean	isGroupModeAnd()
boolean	isGroupModeOr()
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	setEmail(java.lang.String email) Set the email to search in Member
void	setGroupMode(java.lang.String groupMode) Defines if the group search is an OR-search or an AND-search.
java.lang.String	toString()

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

getEnabled, getGid, getGids, getGidsOff, getGroupOffSet, getGroupSet, getPageSize, getRefinedWorkspace, getSort, getStart, getText, getUsage, isMissingCriteria, isPagerAll, isReverse, setEnabled, setGid, setGids, setGidsOff, setGroupOffSet, setGroupSet, setPagerAll, setPageSize, setReverse, setSort, setStart, setText, setUsage, setWorkspace, setWrkspc

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, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, mapStringArrayToMapStringList, mapStringListToMapStringArray, processAction, processStatus, sanitize, sanitize, sendRedirect, sendRedirect, setEditField, setFormStep, setNoRedirect, setNoSendRedirect, setPopupEdition, setRedirect, setRedirectOnClosePopup, setWs, showCancelButton, showFinishButton, showNextButton, showPreviousButton, updateUploadedField, updateUploadedFields, validate

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

addBodyAttributes, addCSSHeader, addCSSHeader, addCSSHeader, addCSSHeader, addCustomHeader, addHttpEquivHeader, addHttpNameHeader, addJavaScript, addJavaScript, addJavaScript, addJavaScriptCode, addPrefetchHeader, addStyleHeader, addStyleHeader, addWebAssets, checkAccess, checkAccess, checkCSRF, debugDisplayContext, disablePacker, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSFooterMap, getFinalCSSMap, getFinalJavaScriptSet, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, 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, isAjaxRequest, isDBMember, isDebug, isInFrontOffice, isLogged, isWebdavAccess, 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

GROUP_MODE_OR

public static final java.lang.String GROUP_MODE_OR

See Also:

Constant Field Values

GROUP_MODE_AND

public static final java.lang.String GROUP_MODE_AND

See Also:

Constant Field Values

ALL_USAGE

public static final int ALL_USAGE

Value that can be specified to AbstractMemberQueryHandler.setUsage(int) to search for all members whatever their usage (both contact and account).

Since:

jcms-9.0.2 - JCMS-4764

See Also:

Constant Field Values

mbrSearchEngine

protected LuceneMemberSearchEngine mbrSearchEngine

isGroupModeOr

protected boolean isGroupModeOr

Constructor Detail

AllMemberQueryHandler

public AllMemberQueryHandler()

Constructs a new empty AllMemberQueryHandler with default option.

Since:

jcms-6.1

AllMemberQueryHandler

public AllMemberQueryHandler(java.lang.String queryString)

Constructs a new AllMemberQueryHandler by parsing the specified query string.

See AllMemberQueryHandler(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=john&gid=j_42"

Since:

jcms-6.1

AllMemberQueryHandler

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

Constructs a new AllMemberQueryHandler 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.

• "text" : AbstractMemberQueryHandler.setText(String)
• "gid" : AbstractMemberQueryHandler.setGid(String)
• "gids" : AbstractMemberQueryHandler.setGids(String[])
• "gidsOff" : AbstractMemberQueryHandler.setGidsOff(String[])
• "usage" : AbstractMemberQueryHandler.setUsage(int)
• "email" : setEmail(String)
• "wrkspc" : AbstractMemberQueryHandler.setWrkspc(String)
• "enabled" : AbstractMemberQueryHandler.setEnabled(Boolean)

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 : "gid=j_42"

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

Since:

jcms-6.1

Method Detail

getLogger

protected org.apache.log4j.Logger getLogger()

Specified by:

getLogger in class AbstractQueryHandler<DBMember>

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.

Overrides:

parseQueryStringParam in class AbstractMemberQueryHandler<DBMember>

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.

Overrides:

printParams in class AbstractMemberQueryHandler<DBMember>

Parameters:

printer - a QueryHandlerPrinter to use

Returns:

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

Since:

jcms-6.1

toString

public java.lang.String toString()

Overrides:

toString in class AbstractMemberQueryHandler<DBMember>

getDescription

public java.lang.String getDescription()

Returns a description of the query in the language defined by userLang of this handler.

Returns:

the string of the description

getPageResult

public PageResult<Member> getPageResult()

Returns a new PageResult of Member/DBMember for the current settings of this handler.

No more than LuceneMemberSearchEngine.getMaximumResults() Members will be returned, if this limit is reached, attribute LuceneMemberSearchEngine.MAXIMUM_RESULTS_NUMBER_REACHED is added to this AllMemberQueryHandler with the total count of Member retrieved in the value.

Returns:

a new PageResult, null may be returned in case of internal error

getIdResultList

public java.util.List<java.lang.String> getIdResultList()

Perform the Query and return a list of Member/DBMember id.

Paging parameter will not be used, however no more than LuceneMemberSearchEngine.getMaximumResults() Members will be returned, if this limit is reached, attribute LuceneMemberSearchEngine.MAXIMUM_RESULTS_NUMBER_REACHED is added to this AllMemberQueryHandler with the total count of Member retrieved in the value.

Returns:

a List of String (DBMembers' id), null may be returned in case of internal error

setGroupMode

public void setGroupMode(java.lang.String groupMode)

Defines if the group search is an OR-search or an AND-search. Default is AND-search.

Parameters:

groupMode - either GROUP_MODE_OR or GROUP_MODE_AND

Since:

jcms-7.0.0

isGroupModeAnd

public boolean isGroupModeAnd()

isGroupModeOr

public boolean isGroupModeOr()

getEmail

public java.lang.String getEmail()

Retrieves the email being search in this query

Returns:

a string or null if no email is being searched

Since:

jcms-6.1

setEmail

public void setEmail(java.lang.String email)

Set the email to search in Member

Parameters:

email - any exact email to look for in Members

Since:

jcms-6.1