com.jalios.jcms.handler
Class DBMemberQueryHandler

java.lang.Object
  extended by com.jalios.jcms.context.JcmsContext
      extended by com.jalios.jcms.context.JcmsJspContext
          extended by com.jalios.jcms.handler.JcmsFormHandler
              extended by com.jalios.jcms.handler.AbstractQueryHandler<DBMember>
                  extended by com.jalios.jcms.handler.DBMemberQueryHandler
All Implemented Interfaces:
JcmsConstants, JaliosConstants

public class DBMemberQueryHandler
extends AbstractQueryHandler<DBMember>

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

Since:
jcms-6.1
Version:
$Revision: 66896 $
Author:
Olivier Jaquemet

Nested Class Summary
 
Nested classes/interfaces inherited from class com.jalios.jcms.handler.AbstractQueryHandler
AbstractQueryHandler.HiddenParamQhPrinter, AbstractQueryHandler.QueryHandlerPrinter, AbstractQueryHandler.QueryStringQhPrinter
 
Field Summary
protected  boolean pagerAll
           
protected  int pageSize
           
protected  int pageStart
           
protected  boolean reverse
           
static String REVISION
           
protected  String sort
           
 
Fields inherited from class com.jalios.jcms.handler.JcmsFormHandler
contextMap, editFieldSet, noRedirect, noSendRedirect, popupEdition, redirect, redirectOnClosePopup, workspaceForced
 
Fields inherited from class com.jalios.jcms.context.JcmsJspContext
AJAX_REQUEST_ATTRIBUTES, BODY_HEADER, 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, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, 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, ICON_ARCHIVE, ICON_LOCK, ICON_LOCK_STRONG, 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, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_DEEP_COPY, OP_DEEP_DELETE, OP_DELETE, OP_MERGE, OP_UPDATE, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, 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, 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
DBMemberQueryHandler()
          Constructs a new empty MemberQueryHandler with default option.
DBMemberQueryHandler(String queryString)
          Constructs a new MemberQueryHandler by parsing the specified query string.
DBMemberQueryHandler(String queryString, javax.servlet.http.HttpServletRequest request)
          Constructs a new MemberQueryHandler by parsing the specified query string and using informations available from the specified request (logged member, user language, etc).
 
Method Summary
 String getGid()
          Retrieve the group id used by this Query
 String[] getGids()
          Retrieve the groups id used by this Query
 Set<Group> getGroupSet()
          Retrieves the groups that members must belong to in order to be found.
 List<String> getIdResultList()
          Perform the Query and return a list of DBMember id.
protected  org.apache.log4j.Logger getLogger()
           
 PageResult<DBMember> getPageResult()
          Returns a new PageResult of DBMember for the current settings of this handler.
 Workspace getRefinedWorkspace()
          Retrieves the Workspace that members must belong to in order to be found.
 String getText()
          Retrieves the text being search in this query
 int getUsage()
          Retrieves the usage that members must be in order to be found.
 boolean isPagerAll()
          Get the paging option of this handler
protected  void parseQueryStringParam(String key, String[] values)
          Method to be implemented by subclass to decode parameter from queryString.
protected  String printParams(AbstractQueryHandler.QueryHandlerPrinter printer)
          Print current QueryHandler params using specified QueryHandlerPrinter.
 void setGid(String gid)
          Sets the group that members must belong to in order to be found.
 void setGids(String[] gids)
          Sets the group 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)
           
 void setReverse(boolean reverse)
           
 void setSort(String sort)
          Set the sort order to apply to the DBMember.
 void setStart(int start)
           
 void setText(String text)
          Set the text to search in Member
 void setUsage(int usage)
          Sets the usage that members must be to order to be found.
 void setWrkspc(String wsId)
          Sets the Workspace that members must belong to in order to be found.
 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, getControllerContext, getEditFieldSet, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenFieldML, getMainLangValue, getMainLangValueArray, getMLMap, getMLMapArray, getRedirect, getRedirectOnClosePopup, getWorkspace, init, isFieldEdition, isFieldMissing, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, processAction, processStatus, sendRedirect, sendRedirect, setEditField, setNoRedirect, setNoSendRedirect, setPopupEdition, setRedirect, setRedirectOnClosePopup, setWorkspace, setWs, updateUploadedField, updateUploadedFields, validate
 
Methods inherited from class com.jalios.jcms.context.JcmsJspContext
addBodyAttributes, addCSSHeader, addCSSHeader, addCSSHeader, addCSSHeader, addCustomHeader, addHttpEquivHeader, addHttpNameHeader, addJavaScript, addJavaScript, addJavaScript, addJavaScriptCode, addStyleHeader, addStyleHeader, checkAccess, checkAccess, checkCSRF, debugDisplayContext, disablePacker, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSMap, getFinalJavaScriptSet, getFormElementCount, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, getHttpEquivHeaders, getHttpNameHeaders, getJavaScriptCodeSet, getJavaScriptSet, getJSONBridge, getPackVersion, getPageContext, getPageTitle, getPageZone, getPortal, getPortalCategory, getPortlet, getPublication, getStyleHeaders, getTemplateUsage, internalSetupEmptyHeader, isEditIcon, isEditIcon, isPrintView, registerDisplayContext, removeAjaxRequestAttribute, setAjaxRequestAttribute, setAjaxRequestId, setAllHeadersDiffMap, setDocType, setEditIcon, setFormElementCount, setPageContext, setPageTitle, setPageZone, setShowEditIcon, setTemplateUsage, 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, 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, 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 String REVISION
See Also:
Constant Field Values

sort

protected String sort

reverse

protected boolean reverse

pageStart

protected int pageStart

pageSize

protected int pageSize

pagerAll

protected boolean pagerAll
Constructor Detail

DBMemberQueryHandler

public DBMemberQueryHandler()
Constructs a new empty MemberQueryHandler with default option.

Since:
jcms-6.1

DBMemberQueryHandler

public DBMemberQueryHandler(String queryString)
Constructs a new MemberQueryHandler by parsing the specified query string.

See DBMemberQueryHandler(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

DBMemberQueryHandler

public DBMemberQueryHandler(String queryString,
                            javax.servlet.http.HttpServletRequest request)
Constructs a new MemberQueryHandler 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.

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(String key,
                                     String[] values)
Description copied from class: AbstractQueryHandler
Method to be implemented by subclass to decode parameter from queryString.

Specified by:
parseQueryStringParam in class AbstractQueryHandler<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 String printParams(AbstractQueryHandler.QueryHandlerPrinter printer)
Print current QueryHandler params using specified QueryHandlerPrinter.

Specified by:
printParams in class AbstractQueryHandler<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 String toString()
Overrides:
toString in class Object

getPageResult

public PageResult<DBMember> getPageResult()
Returns a new PageResult of DBMember for the current settings of this handler.

Returns:
a new PageResult

getIdResultList

public List<String> getIdResultList()
Perform the Query and return a list of DBMember id. Paging parameter will not be used.

Returns:
a List of String (DBMembers' id)

getText

public String getText()
Retrieves the text being search in this query

Returns:
a string or null if no text is being searched
Since:
jcms-6.1

setText

public void setText(String text)
Set the text to search in Member

Parameters:
text - any string to look for in Members
Since:
jcms-6.1

getGid

public 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
Since:
jcms-6.1

setGid

public void setGid(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
Since:
jcms-6.1

getGids

public String[] getGids()
Retrieve the groups id used by this Query

Returns:
an array of id of Group or null if there is no filter on Member's Group
Since:
jcms-6.1

setGids

public void setGids(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
Since:
jcms-6.1

getGroupSet

public 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
Since:
jcms-6.1

setWrkspc

public void setWrkspc(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
Since:
jcms-5.7.5

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
Since:
jcms-5.7.5

setUsage

public void setUsage(int usage)
Sets the usage that members must be to order to be found.

Parameters:
usage - a valid usage value, or a -1 to disable filter on Member's usage
Since:
jcms-7.1.2

getUsage

public int getUsage()
Retrieves the usage that members must be in order to be found.

Returns:
a usage or a -1 if there is no filter on usage
Since:
jcms-7.1.2

setSort

public void setSort(String sort)
Set the sort order to apply to the DBMember. Sort field authorized :

Parameters:
sort - a sort string

setReverse

public void setReverse(boolean reverse)

setStart

public void setStart(int start)

setPageSize

public void setPageSize(int pageSize)

setPagerAll

public void setPagerAll(boolean pagerAll)
Set the pagerAll option of this handler

Parameters:
pagerAll - true if all item should be displayed
Since:
jcms-7.1

isPagerAll

public boolean isPagerAll()
Get the paging option of this handler

Returns:
true if all item should be displayed
Since:
jcms-7.1


Copyright © 2001-2010 Jalios SA. All Rights Reserved.