Package mondrian.olap

Class RoleImpl.DelegatingHierarchyAccess

java.lang.Object

mondrian.olap.RoleImpl.DelegatingHierarchyAccess

All Implemented Interfaces:

Role.AllHierarchyAccess, Role.HierarchyAccess

Enclosing class:

RoleImpl

public abstract static class RoleImpl.DelegatingHierarchyAccess
extends Object
implements Role.AllHierarchyAccess

Implementation of Role.HierarchyAccess that delegates all methods to an underlying hierarchy access.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Role.HierarchyAccess	hierarchyAccess

Constructor Summary

Constructors

Constructor	Description
DelegatingHierarchyAccess(Role.HierarchyAccess hierarchyAccess)	Creates a DelegatingHierarchyAccess.

Method Summary

Modifier and Type	Method	Description
Access	getAccess()	Returns the access to whole hierarchy.
Access	getAccess(Member member)	Returns the access the current role has to a given member.
int	getBottomLevelDepth()	Returns the depth of the lowest level to which the current Role has access.
Role.RollupPolicy	getRollupPolicy()	Returns the policy by which cell values are calculated if not all of a member's children are visible.
int	getTopLevelDepth()	Returns the depth of the highest level to which the current Role has access.
boolean	hasInaccessibleDescendants(Member member)	Returns true if at least one of the descendants of the given Member is inaccessible to this Role.

Methods inherited from class java.lang.Object

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

Field Details

hierarchyAccess

protected final Role.HierarchyAccess hierarchyAccess

Constructor Details

DelegatingHierarchyAccess

public DelegatingHierarchyAccess(Role.HierarchyAccess hierarchyAccess)

Creates a DelegatingHierarchyAccess.

Parameters:

hierarchyAccess - Underlying hierarchy access

Method Details

getAccess

public Access getAccess(Member member)

Description copied from interface: Role.HierarchyAccess

Returns the access the current role has to a given member.

Visibility is:

• Access.NONE if member is not visible,
• Access.ALL if member and all children are visible,
• Access.CUSTOM if some of the children are not visible.

For these purposes, children which are below the bottom level are regarded as visible.

Specified by:

getAccess in interface Role.HierarchyAccess

Parameters:

member - Member.

Returns:

Return current role's access to member.

getTopLevelDepth

public int getTopLevelDepth()

Description copied from interface: Role.HierarchyAccess

Returns the depth of the highest level to which the current Role has access. The 'all' level, if present, has a depth of zero.

Specified by:

getTopLevelDepth in interface Role.HierarchyAccess

Returns:

Returns depth of the highest accessible level.

getBottomLevelDepth

public int getBottomLevelDepth()

Description copied from interface: Role.HierarchyAccess

Returns the depth of the lowest level to which the current Role has access. The 'all' level, if present, has a depth of zero.

Specified by:

getBottomLevelDepth in interface Role.HierarchyAccess

Returns:

Returns depth of the lowest accessible level.

getRollupPolicy

public Role.RollupPolicy getRollupPolicy()

Description copied from interface: Role.HierarchyAccess

Returns the policy by which cell values are calculated if not all of a member's children are visible.

Specified by:

getRollupPolicy in interface Role.HierarchyAccess

Returns:

Returns rollup policy.

hasInaccessibleDescendants

public boolean hasInaccessibleDescendants(Member member)

Description copied from interface: Role.HierarchyAccess

Returns true if at least one of the descendants of the given Member is inaccessible to this Role.

Descendants which are inaccessible because they are below the bottom level are ignored.

Specified by:

hasInaccessibleDescendants in interface Role.HierarchyAccess

Parameters:

member - Member

Returns:

Returns whether a descendant is inaccessible.

getAccess

public Access getAccess()

Description copied from interface: Role.AllHierarchyAccess

Returns the access to whole hierarchy.

Specified by:

getAccess in interface Role.AllHierarchyAccess

Returns:

the access to the hierarchy.