com.jalios.jcms
Class BasicMemberQueryFilter

java.lang.Object
  extended by com.jalios.jcms.policy.AbstractPolicyFilter
      extended by com.jalios.jcms.BasicMemberQueryFilter
All Implemented Interfaces:
MemberQueryFilter, PluginComponent, PolicyFilter, Comparable

public abstract class BasicMemberQueryFilter
extends AbstractPolicyFilter
implements MemberQueryFilter, PluginComponent, Comparable

A QueryFilter is notified for each member query.

Since:
jcms-6.1.0
Version:
$Revision: 20161 $
Author:
Olivier Dedieu

Field Summary
protected  int order
           
static String REVISION
           
 
Constructor Summary
BasicMemberQueryFilter()
          Constructs a QueryFilter with order = 0
BasicMemberQueryFilter(int order)
          Constructs a QueryFilter with the given order
 
Method Summary
 void filterMemberQueryHandler(AllMemberQueryHandler amqh, Map<String,Object> context)
          This method should be overriden to filter the value of the AllMemberQueryHandler
 void filterMemberQueryHandler(DBMemberQueryHandler dbmqh, Map<String,Object> context)
          This method should be overriden to filter the value of the DBMemberQueryHandler
 void filterMemberQueryHandler(MemberQueryHandler mqh, Map<String,Object> context)
          This method should be overriden to filter the value of the MemberQueryHandler
 PageResult<Member> filterPageResult(AllMemberQueryHandler amqh, PageResult<Member> pr, Map<String,Object> context)
          This method should be overriden to filter the page result of a AllMemberQueryHandler..
 PageResult<DBMember> filterPageResult(DBMemberQueryHandler dbmqh, PageResult<DBMember> pr, Map<String,Object> context)
          This method should be overriden to filter the page result of a DBMemberQueryHandler..
 List<String> filterResultList(AllMemberQueryHandler amqh, List<String> list, Map<String,Object> context)
          This method should be overriden to filter the result list of a AllMemberQueryHandler.
 List<String> filterResultList(DBMemberQueryHandler dbmqh, List<String> list, Map<String,Object> context)
          This method should be overriden to filter the result list of a DBMemberQueryHandler.
 Set<Member> filterResultSet(MemberQueryHandler mqh, Set<Member> set, Map<String,Object> context)
          This method should be overriden to filter the result set
 boolean init(Plugin plugin)
          Initialize the component with the given plugin configuration
 
Methods inherited from class com.jalios.jcms.policy.AbstractPolicyFilter
compareTo, equals, getOrder, setOrder
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Field Detail

REVISION

public static final String REVISION
See Also:
Constant Field Values

order

protected int order
Constructor Detail

BasicMemberQueryFilter

public BasicMemberQueryFilter()
Constructs a QueryFilter with order = 0

Since:
jcms-6.1.0

BasicMemberQueryFilter

public BasicMemberQueryFilter(int order)
Constructs a QueryFilter with the given order

Parameters:
order - the order
Since:
jcms-6.1.0
Method Detail

init

public boolean init(Plugin plugin)
Description copied from interface: PluginComponent
Initialize the component with the given plugin configuration

Specified by:
init in interface PluginComponent
Parameters:
plugin - the calling plugin
Returns:
true if the component has been correctly initialized.
Since:
jcms-5.7.2
See Also:
PluginComponent.init(Plugin)

filterMemberQueryHandler

public void filterMemberQueryHandler(MemberQueryHandler mqh,
                                     Map<String,Object> context)
This method should be overriden to filter the value of the MemberQueryHandler

Specified by:
filterMemberQueryHandler in interface MemberQueryFilter
Parameters:
mqh - the MemberQueryHandler
context - the context. Can be used to exchange data between custom MemberQueryFilters.
Since:
jcms-6.1.0

filterResultSet

public Set<Member> filterResultSet(MemberQueryHandler mqh,
                                   Set<Member> set,
                                   Map<String,Object> context)
This method should be overriden to filter the result set

Specified by:
filterResultSet in interface MemberQueryFilter
Parameters:
mqh - the MemberQueryHandler
set - the result set
context - the context. Can be used to exchange data between custom MemberQueryFilters.
Returns:
the (filtered) result set
Since:
jcms-6.1.0

filterMemberQueryHandler

public void filterMemberQueryHandler(DBMemberQueryHandler dbmqh,
                                     Map<String,Object> context)
This method should be overriden to filter the value of the DBMemberQueryHandler

Specified by:
filterMemberQueryHandler in interface MemberQueryFilter
Parameters:
dbmqh - the DBMemberQueryHandler
context - the context. Can be used to exchange data between custom MemberQueryFilters.
Since:
jcms-6.1.0

filterPageResult

public PageResult<DBMember> filterPageResult(DBMemberQueryHandler dbmqh,
                                             PageResult<DBMember> pr,
                                             Map<String,Object> context)
This method should be overriden to filter the page result of a DBMemberQueryHandler..

Specified by:
filterPageResult in interface MemberQueryFilter
Parameters:
dbmqh - the DBMemberQueryHandler
pr - the page result
context - the context. Can be used to exchange data between custom MemberQueryFilters.
Returns:
the (filtered) page result
Since:
jcms-6.1.0

filterResultList

public List<String> filterResultList(DBMemberQueryHandler dbmqh,
                                     List<String> list,
                                     Map<String,Object> context)
This method should be overriden to filter the result list of a DBMemberQueryHandler.

Specified by:
filterResultList in interface MemberQueryFilter
Parameters:
dbmqh - the DBMemberQueryHandler
list - the list of member id to filter
context - the context. Can be used to exchange data between custom MemberQueryFilters.
Returns:
the (filtered) list
Since:
jcms-6.1.0

filterMemberQueryHandler

public void filterMemberQueryHandler(AllMemberQueryHandler amqh,
                                     Map<String,Object> context)
This method should be overriden to filter the value of the AllMemberQueryHandler

Specified by:
filterMemberQueryHandler in interface MemberQueryFilter
Parameters:
amqh - the AllMemberQueryHandler
context - the context. Can be used to exchange data between custom MemberQueryFilters.
Since:
jcms-6.1.0

filterPageResult

public PageResult<Member> filterPageResult(AllMemberQueryHandler amqh,
                                           PageResult<Member> pr,
                                           Map<String,Object> context)
This method should be overriden to filter the page result of a AllMemberQueryHandler..

Specified by:
filterPageResult in interface MemberQueryFilter
Parameters:
amqh - the AllMemberQueryHandler
pr - the page result
context - the context. Can be used to exchange data between custom MemberQueryFilters.
Returns:
the (filtered) page result
Since:
jcms-6.1.0

filterResultList

public List<String> filterResultList(AllMemberQueryHandler amqh,
                                     List<String> list,
                                     Map<String,Object> context)
This method should be overriden to filter the result list of a AllMemberQueryHandler.

Specified by:
filterResultList in interface MemberQueryFilter
Parameters:
amqh - the AllMemberQueryHandler
list - the list of member id to filter
context - the context. Can be used to exchange data between custom MemberQueryFilters.
Returns:
the (filtered) list
Since:
jcms-6.1.0


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