ca.sqlpower.architect.olap
Class MondrianModel.CalculatedMember

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

Enclosing class:

MondrianModel

public static class MondrianModel.CalculatedMember
extends OLAPObject

Field Summary

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

pcs

Constructor Summary

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

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

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	addMemberPropertie(int pos, MondrianModel.CalculatedMemberProperty newChild) Adds the given child object at the specified position, firing an OLAPChildEvent.
void	addMemberPropertie(MondrianModel.CalculatedMemberProperty 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	getCaption()
java.util.List<OLAPObject>	getChildren() Returns a read-only unified list of all children of this OLAPObject.
java.lang.String	getDimension()
java.lang.String	getFormatString()
java.lang.String	getFormula()
MondrianModel.Formula	getFormulaElement()
java.util.List<MondrianModel.CalculatedMemberProperty>	getMemberProperties()
java.lang.String	getName() Default implementation.
java.lang.Boolean	getVisible()
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.CalculatedMemberProperty	removeMemberPropertie(int pos) Removes the child object at the given position, firing an OLAPChildEvent.
boolean	removeMemberPropertie(MondrianModel.CalculatedMemberProperty removeChild) Removes the given child object, firing an OLAPChildEvent if the child was found.
void	setCaption(java.lang.String newval)
void	setDimension(java.lang.String newval)
void	setFormatString(java.lang.String newval)
void	setFormula(java.lang.String newval)
void	setFormulaElement(MondrianModel.Formula newval)
void	setName(java.lang.String newval)
void	setVisible(java.lang.Boolean 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.CalculatedMember

public MondrianModel.CalculatedMember()

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

MondrianModel.CalculatedMember

public MondrianModel.CalculatedMember(MondrianModel.CalculatedMember original)

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

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)

getFormatString

public java.lang.String getFormatString()

setFormatString

public void setFormatString(java.lang.String newval)

getCaption

public java.lang.String getCaption()

setCaption

public void setCaption(java.lang.String newval)

getFormula

public java.lang.String getFormula()

setFormula

public void setFormula(java.lang.String newval)

getDimension

public java.lang.String getDimension()

setDimension

public void setDimension(java.lang.String newval)

getVisible

public java.lang.Boolean getVisible()

setVisible

public void setVisible(java.lang.Boolean newval)

getFormulaElement

public MondrianModel.Formula getFormulaElement()

setFormulaElement

public void setFormulaElement(MondrianModel.Formula newval)

addMemberPropertie

public void addMemberPropertie(int pos,
                               MondrianModel.CalculatedMemberProperty newChild)

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

addMemberPropertie

public void addMemberPropertie(MondrianModel.CalculatedMemberProperty newChild)

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

removeMemberPropertie

public boolean removeMemberPropertie(MondrianModel.CalculatedMemberProperty 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.

removeMemberPropertie

public MondrianModel.CalculatedMemberProperty removeMemberPropertie(int pos)

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

Returns:

The item that was removed.

getMemberProperties

public java.util.List<MondrianModel.CalculatedMemberProperty> getMemberProperties()

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.