|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.jalios.jcms.context.JcmsContext com.jalios.jcms.context.JcmsJspContext com.jalios.jcms.handler.JcmsFormHandler com.jalios.jcms.handler.AbstractQueryHandler<DBMember> com.jalios.jcms.handler.AllMemberQueryHandler
public class AllMemberQueryHandler
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 | |
---|---|
static String |
GROUP_MODE_AND
|
static String |
GROUP_MODE_OR
|
protected boolean |
isGroupModeOr
|
protected boolean |
isMissingCriteria
|
protected LuceneMemberSearchEngine |
mbrSearchEngine
|
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 | |
---|---|
AllMemberQueryHandler()
Constructs a new empty AllMemberQueryHandler with default option. |
|
AllMemberQueryHandler(String queryString)
Constructs a new AllMemberQueryHandler by parsing the specified query string. |
|
AllMemberQueryHandler(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 | |
---|---|
String |
getDescription()
Returns a description of the query in the language defined by userLang of this handler. |
String |
getEmail()
Retrieves the email being search in this query |
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 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. |
int |
getPageSize()
Get the page size |
String |
getSort()
Retrieve current sorting criteria |
int |
getStart()
Get the start index to use for paging |
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 |
isGroupModeAnd()
|
boolean |
isGroupModeOr()
|
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(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 |
setEmail(String email)
Set the email to search in Member |
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 |
setGroupMode(String groupMode)
Defines if the group search is an OR-search or an AND-search. |
void |
setGroupSet(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(String sort)
Set the sorting criteria |
void |
setStart(int start)
Set the start index to use for paging |
void |
setText(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. |
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
public static final String GROUP_MODE_OR
public static final String GROUP_MODE_AND
protected LuceneMemberSearchEngine mbrSearchEngine
protected String sort
protected boolean reverse
protected int pageStart
protected int pageSize
protected boolean pagerAll
protected boolean isMissingCriteria
protected boolean isGroupModeOr
Constructor Detail |
---|
public AllMemberQueryHandler()
AllMemberQueryHandler
with default option.
public AllMemberQueryHandler(String queryString)
AllMemberQueryHandler
by parsing the specified query string.
See AllMemberQueryHandler(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 AllMemberQueryHandler(String queryString, javax.servlet.http.HttpServletRequest request)
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"
: setText(String)
"gid"
: setGid(String)
"gids"
: setGids(String[])
"usage"
: setUsage(int)
"email"
: setEmail(String)
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 String getDescription()
public PageResult<Member> 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 void setGroupSet(Set<Group> groupSet)
groupSet
- the group set.public Set<Group> getGroupSet()
Member must belong to at least one of them.
public void setGroupMode(String groupMode)
groupMode
- either GROUP_MODE_OR
or GROUP_MODE_AND
public boolean isGroupModeAnd()
public boolean isGroupModeOr()
public void setUsage(int usage)
usage
- the usage to matchpublic int getUsage()
public String getEmail()
public void setEmail(String email)
email
- any exact email to look for in Memberspublic void setStart(int start)
start
- the index of the first member to be displayed in current pagepublic int getStart()
public void setPageSize(int pageSize)
pageSize
- the number of element to be displayedpublic int getPageSize()
public void setSort(String sort)
Possible sorting option :
sort
- a field name that should be used for sortingpublic String getSort()
public void setReverse(boolean reverse)
reverse
- true if the reverse order should be usedpublic boolean isReverse()
public boolean isMissingCriteria()
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 |