Package edu.internet2.middleware.grouper.filter

Class BaseQueryFilter<ValueType>

java.lang.Object

edu.internet2.middleware.grouper.filter.BaseQueryFilter<ValueType>

Type Parameters:

ValueType - Group, Membership, Stem

All Implemented Interfaces:

QueryFilter<ValueType>

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<ValueType>
extends Object
implements QueryFilter<ValueType>

Base QueryFilter that all other query filters should extend.

Version:

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

Constructor Summary

Constructors

Constructor	Description
BaseQueryFilter()

Method Summary

Modifier and Type	Method	Description
Set	filterByScope(Stem ns, Set candidates)	Filter candidates by scope.
Set	getResults(GrouperSession s)	Get filter results.
protected String	getStringForScope(Stem ns)	Get the scope as a string.
protected Set<Stem>	removeRootStem(Set<Stem> candidates)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BaseQueryFilter

public BaseQueryFilter()

Method Details

filterByScope

public Set filterByScope(Stem ns,
 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 Set getResults(GrouperSession s)
               throws QueryException

Get filter results.

Specified by:

getResults in interface QueryFilter<ValueType>

Parameters:

s - Get groups within this session context.

Returns:

Objects that match filter constraints.

Throws:

QueryException

getStringForScope

protected String getStringForScope(Stem ns)

Get the scope as a string.

Parameters:

ns -

Returns:

the scope

removeRootStem

protected Set<Stem> removeRootStem(Set<Stem> candidates)