mondrian.olap
Interface Role.HierarchyAccess

All Known Implementing Classes:

DelegatingRole.DelegatingHierarchyAccess

Enclosing interface:

Role

public static interface Role.HierarchyAccess

Represents the access that a role has to a particular hierarchy.

Method Summary

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.

Method Detail

getAccess

Access getAccess(Member member)

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.

Parameters:

member - Member

Returns:

current role's access to member

getTopLevelDepth

int getTopLevelDepth()

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

Returns:

depth of the highest accessible level

getBottomLevelDepth

int getBottomLevelDepth()

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

Returns:

depth of the lowest accessible level

getRollupPolicy

Role.RollupPolicy getRollupPolicy()

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

Returns:

rollup policy

hasInaccessibleDescendants

boolean hasInaccessibleDescendants(Member member)

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.

Parameters:

member - Member

Returns:

whether a descendant is inaccessible