org.jasig.portal.layout.dlm.providers
Class GroupMembershipEvaluatorFactory

java.lang.Object
  extended by org.jasig.portal.layout.dlm.providers.PersonEvaluatorFactory
      extended by org.jasig.portal.layout.dlm.providers.GroupMembershipEvaluatorFactory
All Implemented Interfaces:
EvaluatorFactory

public class GroupMembershipEvaluatorFactory
extends PersonEvaluatorFactory

Creates a group membership evaluator. This class inherits from IPersonEvaluatorFactory. Subclassing IPersonEvaluatorFactory gives us all benefits of its configuration language structure. The side affect of course is then that our group evaluator must be configured with that language structure. The definitions of the specific, non-element-containing evaluators must conform to the following element structure:

 
   < attribute mode="required" 
     name="required" 
     value="optional"/ >
  
 
Therefore, the form selected for our group membership evaluator configurations is:
 
   < attribute mode="memberOf" name="Students"/ > 
  
 
Case is important for both mode and name. The value attribute is not used in configuration of these group membership evaluators.

Since:
uPortal 2.5
Version:
$Revision: 1.6 $ $Date: 2005/05/03 05:55:35 $
Author:
mboyd@sungardsct.com
See Also:
PersonEvaluatorFactory.getAttributeEvaluator(java.lang.String, java.lang.String, java.lang.String)

Field Summary
 
Fields inherited from class org.jasig.portal.layout.dlm.providers.PersonEvaluatorFactory
RCS_ID
 
Constructor Summary
GroupMembershipEvaluatorFactory()
           
 
Method Summary
 Evaluator getAttributeEvaluator(java.lang.String name, java.lang.String mode, java.lang.String value)
          Returns an instance of an evaluator specific to this factory and the passed in values.
 
Methods inherited from class org.jasig.portal.layout.dlm.providers.PersonEvaluatorFactory
getEvaluator
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GroupMembershipEvaluatorFactory

public GroupMembershipEvaluatorFactory()
Method Detail

getAttributeEvaluator

public Evaluator getAttributeEvaluator(java.lang.String name,
                                       java.lang.String mode,
                                       java.lang.String value)
Returns an instance of an evaluator specific to this factory and the passed in values. Name should be a well known group name. Case is important. The mode should be "memberOf" for now. Other modes may be added in the future like, "deepMemberOf".

Overrides:
getAttributeEvaluator in class PersonEvaluatorFactory
Parameters:
name - the attribute's name.
mode - the attribute's mode. (i.e. 'equals')
value - the attribute's value.
Returns:
an Evaluator for evaluating attributes