ca.sqlpower.architect.olap
Class MondrianModel.Role

java.lang.Object
  ca.sqlpower.architect.olap.OLAPObject
      ca.sqlpower.architect.olap.MondrianModel.Role

Enclosing class:

MondrianModel

public static class MondrianModel.Role
extends OLAPObject

A role defines an access-control profile. It has a series of grants (or denials) for schema elements.

Field Summary

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

pcs

Constructor Summary

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

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

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	addSchemaGrant(int pos, MondrianModel.SchemaGrant newChild) Adds the given child object at the specified position, firing an OLAPChildEvent.
void	addSchemaGrant(MondrianModel.SchemaGrant 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.util.List<OLAPObject>	getChildren() Returns a read-only unified list of all children of this OLAPObject.
java.lang.String	getName() Default implementation.
java.util.List<MondrianModel.SchemaGrant>	getSchemaGrants()
MondrianModel.Union	getUnion()
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.SchemaGrant	removeSchemaGrant(int pos) Removes the child object at the given position, firing an OLAPChildEvent.
boolean	removeSchemaGrant(MondrianModel.SchemaGrant removeChild) Removes the given child object, firing an OLAPChildEvent if the child was found.
void	setName(java.lang.String newval)
void	setUnion(MondrianModel.Union newval)
java.lang.String	toString()

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

addChildListener, addCompoundEditListener, addPropertyChangeListener, endCompoundEdit, fireChildAdded, fireChildRemoved, 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.Role

public MondrianModel.Role()

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

MondrianModel.Role

public MondrianModel.Role(MondrianModel.Role original)

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

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getName

public java.lang.String getName()

Description copied from class: OLAPObject

Default implementation. Subclasses that have actual names will override this method.

Overrides:

getName in class OLAPObject

setName

public void setName(java.lang.String newval)

addSchemaGrant

public void addSchemaGrant(int pos,
                           MondrianModel.SchemaGrant newChild)

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

addSchemaGrant

public void addSchemaGrant(MondrianModel.SchemaGrant newChild)

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

removeSchemaGrant

public boolean removeSchemaGrant(MondrianModel.SchemaGrant 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.

removeSchemaGrant

public MondrianModel.SchemaGrant removeSchemaGrant(int pos)

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

Returns:

The item that was removed.

getSchemaGrants

public java.util.List<MondrianModel.SchemaGrant> getSchemaGrants()

getUnion

public MondrianModel.Union getUnion()

setUnion

public void setUnion(MondrianModel.Union newval)

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.

Specified by:

getChildren in class OLAPObject

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.

Specified by:

allowsChildren in class OLAPObject

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 OLAPObject

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 OLAPObject

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 OLAPObject

Parameters:

child - The child to remove.