edu.internet2.middleware.grouper.filter
Class BaseQueryFilter

java.lang.Object
  extended by edu.internet2.middleware.grouper.filter.BaseQueryFilter
All Implemented Interfaces:
QueryFilter
Direct Known Subclasses:
ChildGroupFilter, ChildStemFilter, ComplementFilter, GroupAlternateNameExactFilter, GroupAlternateNameFilter, GroupAnyAttributeFilter, GroupAttributeExactFilter, GroupAttributeFilter, GroupCreatedAfterFilter, GroupCreatedBeforeFilter, GroupCurrentNameExactFilter, GroupCurrentNameFilter, GroupMemberFilter, GroupMembershipModifiedAfterFilter, GroupMembershipModifiedBeforeFilter, GroupModifiedAfterFilter, GroupModifiedBeforeFilter, GroupNameExactFilter, GroupNameFilter, GroupsInStemFilter, GroupTypeFilter, GroupUuidFilter, IntersectionFilter, MembershipCreatedAfterFilter, MembershipCreatedBeforeFilter, NullFilter, StemAnyAttributeFilter, StemAttributeFilter, StemCreatedAfterFilter, StemCreatedBeforeFilter, StemDisplayExtensionFilter, StemDisplayNameFilter, StemExtensionFilter, StemNameAnyFilter, StemNameExactFilter, StemNameFilter, StemsInStemFilter, StemUuidFilter, UnionFilter

public class BaseQueryFilter
extends java.lang.Object
implements QueryFilter

Base QueryFilter that all other query filters should extend.

Version:
$Id: BaseQueryFilter.java,v 1.4 2008-11-05 16:18:46 shilen Exp $
Author:
blair christensen.

Constructor Summary
BaseQueryFilter()
           
 
Method Summary
 java.util.Set filterByScope(Stem ns, java.util.Set candidates)
          Filter candidates by scope.
 java.util.Set getResults(GrouperSession s)
          Get filter results.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BaseQueryFilter

public BaseQueryFilter()
Method Detail

filterByScope

public java.util.Set filterByScope(Stem ns,
                                   java.util.Set candidates)
Filter candidates by scope.

Parameters:
ns - Restrict results to this scope.
candidates - A Set of candidate objects
Returns:
A set of filtered objects

getResults

public java.util.Set getResults(GrouperSession s)
                         throws QueryException
Get filter results.

Specified by:
getResults in interface QueryFilter
Parameters:
s - Get groups within this session context.
Returns:
Objects that match filter constraints.
Throws:
QueryException