com.jalios.jcms.handler

Class AbstractMemberQueryHandler<E>

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<E>

Type Parameters:

E - The type of Member being manipulated by the implementation of AbstractMemberQueryHandler

All Implemented Interfaces:

JcmsConstants, JaliosConstants

Direct Known Subclasses:

AllMemberQueryHandler, DBMemberQueryHandler, MemberQueryHandler

public abstract class AbstractMemberQueryHandler<E>
extends AbstractQueryHandler<E>

Superclass of member query handlers.

Since:

JCMS-6619

Version:

$Revision: 00000 $

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.util.Set<Group>	groupOffSet
protected java.util.Set<Group>	groupSet
protected boolean	isMissingCriteria
protected boolean	pagerAll
protected int	pageSize
protected int	pageStart
protected boolean	reverse
protected java.lang.String	sort

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

REVISION

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, 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, 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, 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, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, SUCCESS_MSG, 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, 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
AbstractMemberQueryHandler()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Boolean	getEnabled() Retrieves the enabled/disabled state that members must be in order to be found.
java.lang.String	getGid() Retrieve the group id used by this Query
java.lang.String[]	getGids() Retrieve the groups id that members must belong to in order to be found.
java.lang.String[]	getGidsOff() Retrieve the groups id that members must NOT belong to in order to be found.
java.util.Set<Group>	getGroupOffSet() Retrieves the groups that members must NOT belong to in order to be found.
java.util.Set<Group>	getGroupSet() Retrieves the groups that members must belong to in order to be found.
int	getPageSize() Get the page size
Workspace	getRefinedWorkspace() Retrieves the Workspace that members must belong to in order to be found.
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
int	getUsage() Retrieve the usage that members must be in order to be found.
boolean	isMissingCriteria() Check if at least one search criteria has been specified for this handler
boolean	isPagerAll() Get the paging option of this handler
boolean	isReverse() Check the ordering of the sort criteria
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	setEnabled(java.lang.Boolean status) Sets the enabled/disabled state that members must be in order to be found.
void	setGid(java.lang.String gid) Sets the group that members must belong to in order to be found.
void	setGids(java.lang.String[] gids) Sets the group that members must belong to in order to be found.
void	setGidsOff(java.lang.String... gids) Sets the group that members must NOT belong to in order to be found.
void	setGroupOffSet(java.util.Set<Group> groupSet) Sets the group set that members must NOT belong to in order to be found.
void	setGroupSet(java.util.Set<Group> groupSet) Sets the group set that members must belong to in order to be found.
void	setPagerAll(boolean pagerAll) Set the pagerAll option of this handler
void	setPageSize(int pageSize) Set the page size
void	setReverse(boolean reverse) Set the ordering of the sort criteria
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 Member
void	setUsage(int usage) Set the usage that members must be in order to be found.
void	setWorkspace(Workspace wspc)
void	setWrkspc(java.lang.String wsId) Sets the Workspace that members must belong to in order to be found.
java.lang.String	toString()

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

getAttribute, getAttributeMap, getDataSet, getHiddenParams, getLogger, 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, getRedirect, getRedirectOnClosePopup, getWorkspace, init, isFieldEdition, isFieldMissing, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, processAction, processStatus, 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, checkAccess, checkAccess, checkCSRF, debugDisplayContext, disablePacker, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSFooterMap, getFinalCSSMap, getFinalJavaScriptSet, getFormElementCount, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, getHttpEquivHeaders, getHttpNameHeaders, getJavaScriptCodeSet, getJavaScriptSet, getJSONBridge, getPackVersion, getPageContext, getPageTitle, getPageZone, getPortal, getPortalCategory, getPortlet, getPublication, getStyleHeaders, getTemplateUsage, internalSetupEmptyHeader, isEditIcon, isEditIcon, isEditIconForPublish, isEditIconForPublish, isPrintView, registerDisplayContext, removeAjaxRequestAttribute, setAjaxRequestAttribute, setAjaxRequestId, setAllHeadersDiffMap, setDocType, setEditIcon, setFormElementCount, setPageContext, setPageTitle, setPageZone, setShowEditIcon, setTemplateUsage, showEditIcon, showEditIcon, showEditIcon, workaroundBrowserBaseHrefBug

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

addCookie, addMsg, addMsg, addMsgSession, addMsgSession, applySelector, forceWorkspaceUpdate, getBaseUrl, getBrowser, getCaddy, getContextPath, getErrorMsg, getErrorMsgList, getErrorMsgSession, getErrorMsgSessionList, getInfoMsg, getInfoMsgList, getInfoMsgSession, getInfoMsgSessionList, getLoggedMember, getMsgList, getMsgSessionList, getRequest, getResponse, getSession, getSuccessMsg, getSuccessMsgList, getSuccessMsgSession, getSuccessMsgSessionList, getUploadedFile, getUploadedFileList, getUrlWithCommonUpdatedParams, getUserCountry, getUserLang, getUserLocale, getWarningMsg, getWarningMsgList, getWarningMsgSession, getWarningMsgSessionList, glp, isAdmin, isAjaxRequest, isDBMember, isDebug, isInFrontOffice, isLogged, isWebdavAccess, removeMessage, removeMessage, retrieveUploadedFile, select, 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

groupSet

protected java.util.Set<Group> groupSet

groupOffSet

protected java.util.Set<Group> groupOffSet

sort

protected java.lang.String sort

reverse

protected boolean reverse

pageStart

protected int pageStart

pageSize

protected int pageSize

pagerAll

protected boolean pagerAll

isMissingCriteria

protected boolean isMissingCriteria

Constructor Detail

AbstractMemberQueryHandler

public AbstractMemberQueryHandler()

Method Detail

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<E>

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<E>

Parameters:

printer - a QueryHandlerPrinter to use

Returns:

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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 Member

Parameters:

text - any string to look for in Members

getGid

public java.lang.String getGid()

Retrieve the group id used by this Query

Returns:

an id of Group or null if there is no filter on Member's Group

setGid

public void setGid(java.lang.String gid)

Sets the group that members must belong to in order to be found.

Parameters:

gid - an id of Group or null to disable filter on Member's Group

getGids

public java.lang.String[] getGids()

Retrieve the groups id that members must belong to in order to be found.

Returns:

an array of id of Group or null if there is no filter on Member's Group

setGids

public void setGids(java.lang.String[] gids)

Sets the group that members must belong to in order to be found.

Member must belong to at least one of them.

Parameters:

gids - an array of id of Group or null to disable filter on Member's Group

setGroupSet

public void setGroupSet(java.util.Set<Group> groupSet)

Sets the group set that members must belong to in order to be found.

Parameters:

groupSet - the group set.

getGroupSet

public java.util.Set<Group> getGroupSet()

Retrieves the groups that members must belong to in order to be found.

Member must belong to at least one of them.

Returns:

a set of Group or null if there is no filter on Group

setUsage

public void setUsage(int usage)

Set the usage that members must be in order to be found.

Parameters:

usage - the usage to match

getUsage

public int getUsage()

Retrieve the usage that members must be in order to be found.

Returns:

a usage or -1 if none was defined

setWrkspc

public void setWrkspc(java.lang.String wsId)

Sets the Workspace that members must belong to in order to be found.

Parameters:

wsId - an id of Workspace or null to disable filter on Member's Workspace

setWorkspace

public void setWorkspace(Workspace wspc)

Overrides:

setWorkspace in class JcmsFormHandler

getRefinedWorkspace

public Workspace getRefinedWorkspace()

Retrieves the Workspace that members must belong to in order to be found.

Returns:

a Workspace or null if there is no filter on workspace

getGidsOff

public java.lang.String[] getGidsOff()

Retrieve the groups id that members must NOT belong to in order to be found.

Returns:

an array of id of Group or null if there is no filter on Member's Group

setGidsOff

public void setGidsOff(java.lang.String... gids)

Sets the group that members must NOT belong to in order to be found.

Member must belong to at least one of them.

Parameters:

gids - an array of id of Group or null to disable filter on Member's Group

setGroupOffSet

public void setGroupOffSet(java.util.Set<Group> groupSet)

Sets the group set that members must NOT belong to in order to be found.

Parameters:

groupSet - the group set.

getGroupOffSet

public java.util.Set<Group> getGroupOffSet()

Retrieves the groups that members must NOT belong to in order to be found.

Member must NOT belong to at least one of them.

Returns:

a set of Group or null if there is no filter on Group

setEnabled

public void setEnabled(java.lang.Boolean status)

Sets the enabled/disabled state that members must be in order to be found.

Default behavior is to NOT refine on the enabled/disabled state.

Parameters:

status - true to search for enabled members, false to search for disabled members

getEnabled

public java.lang.Boolean getEnabled()

Retrieves the enabled/disabled state that members must be in order to be found.

Returns:

true to search for enabled members, false to search for disabled members

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

isMissingCriteria

public boolean isMissingCriteria()

Check if at least one search criteria has been specified for this handler

Returns:

false if no criteria was specified, true if at least one criteria was specified and search can be performed