ca.sqlpower.architect.olap
Class MondrianModel.HierarchyGrant

java.lang.Object
  ca.sqlpower.architect.olap.OLAPObject
      ca.sqlpower.architect.olap.MondrianModel.Grant
          ca.sqlpower.architect.olap.MondrianModel.HierarchyGrant

Enclosing class:

MondrianModel

public static class MondrianModel.HierarchyGrant
extends MondrianModel.Grant

Grants (or denies) this role access to a hierarchy. access may be "all", "custom" or "none". If access is "custom", you may also specify the attributes topLevel, bottomLevel, and the member grants. See mondrian.olap.Role#grant(mondrian.olap.Hierarchy, int, mondrian.olap.Level).

Field Summary

Fields inherited from class ca.sqlpower.architect.olap.OLAPObject

pcs

Constructor Summary

MondrianModel.HierarchyGrant()
Creates a new HierarchyGrant with all attributes set to their defaults.

MondrianModel.HierarchyGrant(MondrianModel.HierarchyGrant original)
Creates a new HierarchyGrant with all attributes copied from the given HierarchyGrant.

Method Summary

void	addChild(int index, OLAPObject child) Adds the given child or sets the appropriate property on this OLAPObject, allowing the overall target index to be specified.
void	addChild(OLAPObject child) Adds the given child or sets the appropriate property on this OLAPObject, if this type of OLAPObject has the applicable addXXX() or setXXX() method for the given object's type.
void	addMemberGrant(int pos, MondrianModel.MemberGrant newChild) Adds the given child object at the specified position, firing an OLAPChildEvent.
void	addMemberGrant(MondrianModel.MemberGrant newChild) Adds the given child object at the end of the child list, firing an OLAPChildEvent.
boolean	allowsChildren() Returns true if this type of OLAPObject can ever return a non-empty list from OLAPObject.getChildren(), and false if getChildren() is always empty.
java.lang.String	getBottomLevel()
java.util.List<OLAPObject>	getChildren() Returns a read-only unified list of all children of this OLAPObject.
java.lang.String	getHierarchy()
java.util.List<MondrianModel.MemberGrant>	getMemberGrants()
java.lang.String	getRollupPolicy()
java.lang.String	getTopLevel()
boolean	removeChild(OLAPObject child) Removes the given child on this OLAPObject if this type of OLAPObject has the applicable removeXXX() or setXXX(null) method for the given object's type.
MondrianModel.MemberGrant	removeMemberGrant(int pos) Removes the child object at the given position, firing an OLAPChildEvent.
boolean	removeMemberGrant(MondrianModel.MemberGrant removeChild) Removes the given child object, firing an OLAPChildEvent if the child was found.
void	setBottomLevel(java.lang.String newval)
void	setHierarchy(java.lang.String newval)
void	setRollupPolicy(java.lang.String newval)
void	setTopLevel(java.lang.String newval)
java.lang.String	toString()

Methods inherited from class ca.sqlpower.architect.olap.MondrianModel.Grant

getAccess, setAccess

Methods inherited from class ca.sqlpower.architect.olap.OLAPObject

addChildListener, addCompoundEditListener, addPropertyChangeListener, endCompoundEdit, fireChildAdded, fireChildRemoved, getName, getParent, removeChildListener, removeCompoundEditListener, removePropertyChangeListener, startCompoundEdit

Methods inherited from class java.lang.Object

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

Constructor Detail

MondrianModel.HierarchyGrant

public MondrianModel.HierarchyGrant()

Creates a new HierarchyGrant with all attributes set to their defaults.

MondrianModel.HierarchyGrant

public MondrianModel.HierarchyGrant(MondrianModel.HierarchyGrant original)

Creates a new HierarchyGrant with all attributes copied from the given HierarchyGrant.

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class MondrianModel.Grant

getHierarchy

public java.lang.String getHierarchy()

setHierarchy

public void setHierarchy(java.lang.String newval)

getTopLevel

public java.lang.String getTopLevel()

setTopLevel

public void setTopLevel(java.lang.String newval)

getBottomLevel

public java.lang.String getBottomLevel()

setBottomLevel

public void setBottomLevel(java.lang.String newval)

getRollupPolicy

public java.lang.String getRollupPolicy()

setRollupPolicy

public void setRollupPolicy(java.lang.String newval)

addMemberGrant

public void addMemberGrant(int pos,
                           MondrianModel.MemberGrant newChild)

Adds the given child object at the specified position, firing an OLAPChildEvent.

addMemberGrant

public void addMemberGrant(MondrianModel.MemberGrant newChild)

Adds the given child object at the end of the child list, firing an OLAPChildEvent.

removeMemberGrant

public boolean removeMemberGrant(MondrianModel.MemberGrant removeChild)

Removes the given child object, firing an OLAPChildEvent if the child was found.

Returns:

true if the item was removed (because it was in the list); false if the item was not removed.

removeMemberGrant

public MondrianModel.MemberGrant removeMemberGrant(int pos)

Removes the child object at the given position, firing an OLAPChildEvent.

Returns:

The item that was removed.

getMemberGrants

public java.util.List<MondrianModel.MemberGrant> getMemberGrants()

getChildren

public java.util.List<OLAPObject> getChildren()

Description copied from class: OLAPObject

Returns a read-only unified list of all children of this OLAPObject. If this object doesn't have any children, returns an empty list.

Overrides:

getChildren in class MondrianModel.Grant

allowsChildren

public boolean allowsChildren()

Description copied from class: OLAPObject

Returns true if this type of OLAPObject can ever return a non-empty list from OLAPObject.getChildren(), and false if getChildren() is always empty.

Overrides:

allowsChildren in class MondrianModel.Grant

addChild

public void addChild(OLAPObject child)

Description copied from class: OLAPObject

Adds the given child or sets the appropriate property on this OLAPObject, if this type of OLAPObject has the applicable addXXX() or setXXX() method for the given object's type.

This method in the abstract base class always throws the IllegalArgumentException because no children or properties are defined at this level.

This method isn't compile-time type safe, so it is recommended not to use it on "by-hand" usage of this API. This method is used during XML parsing, which can't be made compile-time type safe anyway.

Overrides:

addChild in class MondrianModel.Grant

Parameters:

child - The child to add.

addChild

public void addChild(int index,
                     OLAPObject child)

Description copied from class: OLAPObject

Adds the given child or sets the appropriate property on this OLAPObject, allowing the overall target index to be specified.

This method in the abstract base class always throws IllegalArgumentException because no children or properties are defined at this level.

This method isn't compile-time type safe, so it is recommended not to use it on "by-hand" usage of this API. This method is used for undo and redo, which can't be compile-time type safe anyway.

Overrides:

addChild in class MondrianModel.Grant

Parameters:

index - The overall index (same index as would be in OLAPObject.getChildren()) at which to add the child.

child - The child to add.

removeChild

public boolean removeChild(OLAPObject child)

Description copied from class: OLAPObject

Removes the given child on this OLAPObject if this type of OLAPObject has the applicable removeXXX() or setXXX(null) method for the given object's type.

This method in the abstract base class always throws the IllegalArgumentException because no children or properties are defined at this level.

Overrides:

removeChild in class MondrianModel.Grant

Parameters:

child - The child to remove.