com.whitestein.lsps.orgstructure.model.resolver

Class AbstractRolesResolver

java.lang.Object

com.whitestein.lsps.orgstructure.model.resolver.AbstractRolesResolver

All Implemented Interfaces:

ParametricRolesResolver, RolesResolver

Direct Known Subclasses:

RecursiveDescentRolesResolver, StrictRolesResolver

public abstract class AbstractRolesResolver
extends Object
implements ParametricRolesResolver

Provides a template for creating own roles resolvers.

The algorithm of the resolve(RoleUnit, Collection) template method does the following steps:

1. initializes the set of resolved role names
2. calls the overridden doResolve(com.whitestein.lsps.orgstructure.model.RoleUnit, java.util.Collection<com.whitestein.lsps.os.dto.RoleUnitParameter>) method
   • ...somewhere in the body the addRole(com.whitestein.lsps.orgstructure.model.Role, java.util.Collection<com.whitestein.lsps.os.dto.RoleUnitParameter>) method can be called...
3. returns the set of resolved role names

Since:

1.1

Author:

vgr

Constructor Summary

Constructors

Constructor and Description
AbstractRolesResolver()

Method Summary

Modifier and Type	Method and Description
protected void	addRole(Role role, Collection<RoleUnitParameter> parameters) Adds given role into the set of resolved roles.
protected abstract void	doResolve(RoleUnit roleUnit, Collection<RoleUnitParameter> parameters) Runs actual roles resolving algorithm applied to given roleUnit.
Set<RoleUnitName>	resolve(RoleUnit roleUnit) Runs a resolving algorithm and returns a set of names of roles that were resolved from given roleUnit.
Set<RoleUnitName>	resolve(RoleUnit roleUnit, Collection<RoleUnitParameter> parameters) Runs a resolving algorithm and returns a set of names of roles that were resolved from given roleUnit.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRolesResolver

public AbstractRolesResolver()

Method Detail

resolve

public final Set<RoleUnitName> resolve(RoleUnit roleUnit)

Description copied from interface: RolesResolver

Runs a resolving algorithm and returns a set of names of roles that were resolved from given roleUnit.

Specified by:

resolve in interface RolesResolver

Parameters:

roleUnit - The role or the organization unit to resolve.

Returns:

A set of names of roles that were resolved from given roleUnit.

resolve

public final Set<RoleUnitName> resolve(RoleUnit roleUnit,
                                       Collection<RoleUnitParameter> parameters)

Description copied from interface: ParametricRolesResolver

Runs a resolving algorithm and returns a set of names of roles that were resolved from given roleUnit.

Specified by:

resolve in interface ParametricRolesResolver

Parameters:

roleUnit - The role or the organization unit to resolve.

parameters - The set of parameters to bind to each role or organization unit that is visited during resolution process.

Returns:

A set of names of roles that were resolved from given roleUnit.

addRole

protected final void addRole(Role role,
                             Collection<RoleUnitParameter> parameters)

Adds given role into the set of resolved roles.

It is best to call this method from within the overridden doResolve(RoleUnit, Collection) method body.

Parameters:

role - The role to add into the set.

parameters - The set of parameters to bind to each role or organization unit that is visited during resolution process.

Throws:

NullPointerException - (unchecked) If role is null.

IllegalStateException - (unchecked) If the internal set of roles is not initialized, probably because of calling this method from outside of the doResolve(RoleUnit, Collection) method.

doResolve

protected abstract void doResolve(RoleUnit roleUnit,
                                  Collection<RoleUnitParameter> parameters)

Runs actual roles resolving algorithm applied to given roleUnit.

Parameters:

roleUnit - The role or organization unit to resolve.

parameters - The set of parameters to bind to each role or organization unit that is visited during resolution process.