org.apereo.services.persondir.support.merger

Class BaseAdditiveAttributeMerger

java.lang.Object

org.apereo.services.persondir.support.merger.BaseAdditiveAttributeMerger

All Implemented Interfaces:

IAttributeMerger

Direct Known Subclasses:

MultivaluedAttributeMerger, NoncollidingAttributeAdder, ReplacingAttributeAdder

public abstract class BaseAdditiveAttributeMerger
extends java.lang.Object
implements IAttributeMerger

Merges the Sets of IPersons additively calling the abstract mergePersonAttributes(Map, Map) method on the attributes of IPersons that exist in both sets. The mergeAvailableQueryAttributes(Set, Set) and mergePossibleUserAttributeNames(Set, Set) methods do a simple addative merge of the sets. These can be overriden by subclasses.

Author:

Eric Dalquist

Constructor Summary

Constructors

Constructor and Description
BaseAdditiveAttributeMerger()

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.util.List<java.lang.Object>>	buildMutableAttributeMap(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> attributes) Do a deep clone of an attribute Map to ensure it is completley mutable.
protected java.util.Map<java.lang.String,java.util.List<java.lang.Object>>	createMutableAttributeMap(int size) Create the Map used when merging attributes
java.util.Map<java.lang.String,java.util.List<java.lang.Object>>	mergeAttributes(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> toModify, java.util.Map<java.lang.String,java.util.List<java.lang.Object>> toConsider) Modify the "toModify" argument in consideration of the "toConsider" argument.
java.util.Set<java.lang.String>	mergeAvailableQueryAttributes(java.util.Set<java.lang.String> toModify, java.util.Set<java.lang.String> toConsider) Modify the "toModify" argument in consideration of the "toConsider" argument.
protected abstract java.util.Map<java.lang.String,java.util.List<java.lang.Object>>	mergePersonAttributes(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> toModify, java.util.Map<java.lang.String,java.util.List<java.lang.Object>> toConsider) Modify the "toModify" argument in consideration of the "toConsider" argument.
java.util.Set<java.lang.String>	mergePossibleUserAttributeNames(java.util.Set<java.lang.String> toModify, java.util.Set<java.lang.String> toConsider) Modify the "toModify" argument in consideration of the "toConsider" argument.
java.util.Set<IPersonAttributes>	mergeResults(java.util.Set<IPersonAttributes> toModify, java.util.Set<IPersonAttributes> toConsider) Merge the results of a Set of IPersonAttributes and a compiled results map.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseAdditiveAttributeMerger

public BaseAdditiveAttributeMerger()

Method Detail

mergeAvailableQueryAttributes

public java.util.Set<java.lang.String> mergeAvailableQueryAttributes(java.util.Set<java.lang.String> toModify,
                                                                     java.util.Set<java.lang.String> toConsider)

Description copied from interface: IAttributeMerger

Modify the "toModify" argument in consideration of the "toConsider" argument. Return the resulting Set which may or may not be the same reference as the "toModify" argument. The modification performed is implementation-specific -- implementations of this interface exist to perform some particular transformation on the toModify argument given the toConsider argument.

Specified by:

mergeAvailableQueryAttributes in interface IAttributeMerger

Parameters:

toModify - Modify this set

toConsider - In consideration of this set

Returns:

The modified set

mergePossibleUserAttributeNames

public java.util.Set<java.lang.String> mergePossibleUserAttributeNames(java.util.Set<java.lang.String> toModify,
                                                                       java.util.Set<java.lang.String> toConsider)

Description copied from interface: IAttributeMerger

Modify the "toModify" argument in consideration of the "toConsider" argument. Return the resulting Set which may or may not be the same reference as the "toModify" argument. The modification performed is implementation-specific -- implementations of this interface exist to perform some particular transformation on the toModify argument given the toConsider argument.

Specified by:

mergePossibleUserAttributeNames in interface IAttributeMerger

Parameters:

toModify - Modify this set

toConsider - In consideration of this set

Returns:

The modified set

mergeResults

public final java.util.Set<IPersonAttributes> mergeResults(java.util.Set<IPersonAttributes> toModify,
                                                           java.util.Set<IPersonAttributes> toConsider)

Description copied from interface: IAttributeMerger

Merge the results of a Set of IPersonAttributes and a compiled results map.

Specified by:

mergeResults in interface IAttributeMerger

Parameters:

toModify - The compiled results map, this will be modified based on the values in toConsider.

toConsider - The query results map, this will not be modified.

Returns:

Merged set of IPersonAttributes

buildMutableAttributeMap

protected java.util.Map<java.lang.String,java.util.List<java.lang.Object>> buildMutableAttributeMap(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> attributes)

Do a deep clone of an attribute Map to ensure it is completley mutable.

Parameters:

attributes - Attribute map

Returns:

Mutable attribute map

createMutableAttributeMap

protected java.util.Map<java.lang.String,java.util.List<java.lang.Object>> createMutableAttributeMap(int size)

Create the Map used when merging attributes

Parameters:

size - Size of the map to create

Returns:

Mutable map

mergePersonAttributes

protected abstract java.util.Map<java.lang.String,java.util.List<java.lang.Object>> mergePersonAttributes(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> toModify,
                                                                                                          java.util.Map<java.lang.String,java.util.List<java.lang.Object>> toConsider)

Modify the "toModify" argument in consideration of the "toConsider" argument. Return the resulting Map, which may or may not be the same reference as the "toModify" argument. The modification performed is implementation-specific -- implementations of this interface exist to perform some particular transformation on the toModify argument given the toConsider argument.

Parameters:

toModify - - modify this map

toConsider - - in consideration of this map

Returns:

the modified Map

Throws:

java.lang.IllegalArgumentException - if either toModify or toConsider is null

mergeAttributes

public java.util.Map<java.lang.String,java.util.List<java.lang.Object>> mergeAttributes(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> toModify,
                                                                                        java.util.Map<java.lang.String,java.util.List<java.lang.Object>> toConsider)

Description copied from interface: IAttributeMerger

Modify the "toModify" argument in consideration of the "toConsider" argument. Return the resulting Map, which may or may not be the same reference as the "toModify" argument. The modification performed is implementation-specific -- implementations of this interface exist to perform some particular transformation on the toModify argument given the toConsider argument.

Specified by:

mergeAttributes in interface IAttributeMerger

Parameters:

toModify - - modify this map

toConsider - - in consideration of this map

Returns:

the modified Map