|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jalios.jcms.context.JcmsContext
com.jalios.jcms.context.JcmsJspContext
com.jalios.jcms.handler.JcmsFormHandler
com.jalios.jcms.handler.AbstractQueryHandler<DBMember>
com.jalios.jcms.handler.DBMemberQueryHandler
public class DBMemberQueryHandler
Holder class and form handler of all parameters to be used for a query of DBMembers.
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.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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String REVISION
protected String sort
protected boolean reverse
protected int pageStart
protected int pageSize
protected boolean pagerAll
Constructor Detail |
---|
public DBMemberQueryHandler()
MemberQueryHandler
with default option.
public DBMemberQueryHandler(String queryString)
MemberQueryHandler
by parsing the specified query string.
See DBMemberQueryHandler(String, HttpServletRequest)
for a list of the
decoded parameters.
queryString
- a query String consisting of parameters (key=value) to be set in this handler.
"text=john&gid=j_42"
public DBMemberQueryHandler(String queryString, javax.servlet.http.HttpServletRequest request)
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.
"text"
: setText(String)
"gid"
: setGid(String)
"gids"
: setGids(String[])
"usage"
: setUsage(int)
queryString
- a query String consisting of parameters (key=value) to be set in this handler.
"gid=j_42"
request
- the HttpServletRequest
to use to
retrieve loggedMember
, userLang
,
userLocale
that will be used by this handler,
ignored if null.Method Detail |
---|
protected org.apache.log4j.Logger getLogger()
getLogger
in class AbstractQueryHandler<DBMember>
protected void parseQueryStringParam(String key, String[] values)
AbstractQueryHandler
parseQueryStringParam
in class AbstractQueryHandler<DBMember>
key
- the parameter name, never null nor empty.values
- the parameter values, NEVER NULL NOR EMPTY.
You can safely invoke paramValues[0]
protected String printParams(AbstractQueryHandler.QueryHandlerPrinter printer)
printParams
in class AbstractQueryHandler<DBMember>
printer
- a QueryHandlerPrinter to use
public String toString()
toString
in class Object
public PageResult<DBMember> getPageResult()
public List<String> getIdResultList()
public String getText()
public void setText(String text)
text
- any string to look for in Memberspublic String getGid()
public void setGid(String gid)
gid
- an id of Group or null to disable filter on Member's Grouppublic String[] getGids()
public void setGids(String[] gids)
Member must belong to at least one of them.
gids
- an array of id of Group or null to disable filter on Member's Grouppublic Set<Group> getGroupSet()
Member must belong to at least one of them.
public void setWrkspc(String wsId)
wsId
- an id of Workspace or null to disable filter on Member's Workspacepublic Workspace getRefinedWorkspace()
public void setUsage(int usage)
usage
- a valid usage value, or a -1 to disable filter on Member's usagepublic int getUsage()
public void setSort(String sort)
id
or rowId
author
or authorId
login
name
or lastName
firstName
date
or cdate
mdate
lang
, country
or locale
lastLoginDate
or lastLoginTimes
sort
- a sort stringpublic void setReverse(boolean reverse)
public void setStart(int start)
public void setPageSize(int pageSize)
public void setPagerAll(boolean pagerAll)
pagerAll
- true if all item should be displayedpublic boolean isPagerAll()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |