Class 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
  • Field Details

  • Constructor Details

  • Method Details

    • 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.
      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 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 String toString()
      Overrides:
      toString in class AbstractMemberQueryHandler<DBMember>
    • getDescription

      public 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 List<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(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 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(String email)
      Set the email to search in Member
      Parameters:
      email - any exact email to look for in Members
      Since:
      jcms-6.1
    • getType

      public String getType()
      Retrieve the type of Member to look for.
      Returns:
      null to search all members, "Member" to search for JStore Member only, "DBMember" to search for jcmsdb members only.
      Since:
      10.0.8 / JCMS-10387
    • setType

      public void setType(String type)
      Set the type of Member to look for.
      Parameters:
      type - null to search all members, "Member" to search for JStore Member only, "DBMember" to search for jcmsdb members only.
      Since:
      10.0.8 / JCMS-10387
    • setAdmin

      public void setAdmin(boolean admin)
      Set the administrator filter option.

      Automatically invoke setAdminFilterEnabled(boolean)) to enable filter.

      Parameters:
      admin - true to retrieve only administrators, false to retrieve all but administrators
      Since:
      jcms-10.0.8 / JCMS-10986
    • getAdmin

      public boolean getAdmin()
      Retrieve the value of the administrator filter.

      Important : this value is used only if isAdminFilterEnabled is true !

      Returns:
      true to retrieve only administrators, false to retrieve all but administrators
      Since:
      jcms-10.0.8 / JCMS-10986
    • setAdminFilterEnabled

      public void setAdminFilterEnabled(boolean enabled)
      Set whether the admin filter is used or not for this query
      Parameters:
      enabled - true if the value of getAdmin() is used for this query, false otherwise.
      Since:
      jcms-10.0.8 / JCMS-10986
    • isAdminFilterEnabled

      public boolean isAdminFilterEnabled()
      Retrieve whether the admin filter is used or not for this query
      Returns:
      true if the value of getAdmin() is used for this query, false otherwise.
      Since:
      jcms-10.0.8 / JCMS-10986
    • getSearchedFields

      public String[] getSearchedFields()
      Retrieves the lucene fields in which the text search is being performed for members.
      Returns:
      an array of lucene field name in which to do the text search. (if null or empty default behavior is used)
      Since:
      11.0.0 / JCMS-11874
    • setSearchedFields

      public void setSearchedFields(String... searchedFields)
      Defines the (lucene) members fields in which to perform the text search.
      Parameters:
      searchedFields - an array of lucene field name in which to do the text search. if null or empty will use default behavior.
      Since:
      11.0.0 / JCMS-11874
    • setSort

      public void setSort(String sort)
      Description copied from class: AbstractMemberQueryHandler
      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)
      Overrides:
      setSort in class AbstractMemberQueryHandler<DBMember>
      Parameters:
      sort - a field name that should be used for sorting
    • getSort

      public String getSort()
      Description copied from class: AbstractMemberQueryHandler
      Retrieve current sorting criteria
      Overrides:
      getSort in class AbstractMemberQueryHandler<DBMember>
      Returns:
      a lucene field name that should be used for sorting