org.apereo.services.persondir.support.rule

Class StringFormatAttributeRule

java.lang.Object

org.apereo.services.persondir.support.rule.StringFormatAttributeRule

All Implemented Interfaces:

AttributeRule

public final class StringFormatAttributeRule
extends java.lang.Object
implements AttributeRule

Creates a new user attribute by passing a formatString and the values of existing attributes to String.format()

Author:

awills

Constructor Summary

Constructors

Constructor and Description
StringFormatAttributeRule()

Method Summary

Modifier and Type	Method and Description
boolean	appliesTo(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> userInfo) Indicates whether the rule applies to the user described by the specified information.
java.util.Set<IPersonAttributes>	evaluate(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> userInfo) Applies the embodied rule to the user described by the specified information and returns the result.
java.util.Set<java.lang.String>	getAvailableQueryAttributes()
java.util.Set<java.lang.String>	getPossibleUserAttributeNames() Indicates the complete set of user attribute names that may be returned by a call to evaluate.
void	setFormatArguments(java.util.List<java.lang.String> formatArguments)
void	setFormatString(java.lang.String formatString)
void	setOutputAttribute(java.lang.String outputAttribute)
void	setUsernameAttributeProvider(IUsernameAttributeProvider usernameAttributeProvider)

Methods inherited from class java.lang.Object

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

Constructor Detail

StringFormatAttributeRule

public StringFormatAttributeRule()

Method Detail

setFormatString

public void setFormatString(java.lang.String formatString)

setFormatArguments

public void setFormatArguments(java.util.List<java.lang.String> formatArguments)

setOutputAttribute

public void setOutputAttribute(java.lang.String outputAttribute)

setUsernameAttributeProvider

public void setUsernameAttributeProvider(IUsernameAttributeProvider usernameAttributeProvider)

appliesTo

public boolean appliesTo(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> userInfo)

Description copied from interface: AttributeRule

Indicates whether the rule applies to the user described by the specified information. Implementations of AttributeRule must not change the input Map. Implementations dictate the expected types for the Keys and Values of the Map.

Specified by:

appliesTo in interface AttributeRule

Parameters:

userInfo - immutable Map of attributes to values for the implementation to determine if this rule applies, must not be null.

Returns:

TRUE if this rule applies to the Map data, FALSE if not.

evaluate

public java.util.Set<IPersonAttributes> evaluate(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> userInfo)

Description copied from interface: AttributeRule

Applies the embodied rule to the user described by the specified information and returns the result. This method follows the same contract as IPersonAttributeDao.getPeopleWithMultivaluedAttributes(Map)

Specified by:

evaluate in interface AttributeRule

Parameters:

userInfo - User info

Returns:

Set of IPersonAttributes

getAvailableQueryAttributes

public java.util.Set<java.lang.String> getAvailableQueryAttributes()

Specified by:

getAvailableQueryAttributes in interface AttributeRule

Returns:

Complete set of actual user attribute names that may be returned by a call to evaluate.

See Also:

IPersonAttributeDao.getAvailableQueryAttributes()

getPossibleUserAttributeNames

public java.util.Set<java.lang.String> getPossibleUserAttributeNames()

Description copied from interface: AttributeRule

Indicates the complete set of user attribute names that may be returned by a call to evaluate. This method follows the same contract as IPersonAttributeDao.getPossibleUserAttributeNames()

Specified by:

getPossibleUserAttributeNames in interface AttributeRule

Returns:

Complete set of possible user attribute names that may be returned by a call to evaluate.