ca.sqlpower.architect.olap
Class MondrianModel.VirtualCube

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

Enclosing class:

MondrianModel

public static class MondrianModel.VirtualCube
extends OLAPObject

A VirtualCube is a set of dimensions and measures gleaned from other cubes.

Field Summary

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

pcs

Constructor Summary

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

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

Method Summary

void	addCalculatedMember(int pos, MondrianModel.CalculatedMember newChild) Adds the given child object at the specified position, firing an OLAPChildEvent.
void	addCalculatedMember(MondrianModel.CalculatedMember newChild) Adds the given child object at the end of the child list, firing an OLAPChildEvent.
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	addDimension(int pos, MondrianModel.VirtualCubeDimension newChild) Adds the given child object at the specified position, firing an OLAPChildEvent.
void	addDimension(MondrianModel.VirtualCubeDimension newChild) Adds the given child object at the end of the child list, firing an OLAPChildEvent.
void	addMeasure(int pos, MondrianModel.VirtualCubeMeasure newChild) Adds the given child object at the specified position, firing an OLAPChildEvent.
void	addMeasure(MondrianModel.VirtualCubeMeasure newChild) Adds the given child object at the end of the child list, firing an OLAPChildEvent.
void	addNamedSet(int pos, MondrianModel.NamedSet newChild) Adds the given child object at the specified position, firing an OLAPChildEvent.
void	addNamedSet(MondrianModel.NamedSet 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<MondrianModel.CalculatedMember>	getCalculatedMembers()
java.lang.String	getCaption()
java.util.List<OLAPObject>	getChildren() Returns a read-only unified list of all children of this OLAPObject.
MondrianModel.CubeUsages	getCubeUsage()
java.lang.String	getDefaultMeasure()
java.util.List<MondrianModel.VirtualCubeDimension>	getDimensions()
java.lang.Boolean	getEnabled()
java.util.List<MondrianModel.VirtualCubeMeasure>	getMeasures()
java.lang.String	getName() Default implementation.
java.util.List<MondrianModel.NamedSet>	getNamedSets()
MondrianModel.CalculatedMember	removeCalculatedMember(int pos) Removes the child object at the given position, firing an OLAPChildEvent.
boolean	removeCalculatedMember(MondrianModel.CalculatedMember removeChild) Removes the given child object, firing an OLAPChildEvent if the child was found.
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.VirtualCubeDimension	removeDimension(int pos) Removes the child object at the given position, firing an OLAPChildEvent.
boolean	removeDimension(MondrianModel.VirtualCubeDimension removeChild) Removes the given child object, firing an OLAPChildEvent if the child was found.
MondrianModel.VirtualCubeMeasure	removeMeasure(int pos) Removes the child object at the given position, firing an OLAPChildEvent.
boolean	removeMeasure(MondrianModel.VirtualCubeMeasure removeChild) Removes the given child object, firing an OLAPChildEvent if the child was found.
MondrianModel.NamedSet	removeNamedSet(int pos) Removes the child object at the given position, firing an OLAPChildEvent.
boolean	removeNamedSet(MondrianModel.NamedSet removeChild) Removes the given child object, firing an OLAPChildEvent if the child was found.
void	setCaption(java.lang.String newval)
void	setCubeUsage(MondrianModel.CubeUsages newval)
void	setDefaultMeasure(java.lang.String newval)
void	setEnabled(java.lang.Boolean newval)
void	setName(java.lang.String 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.VirtualCube

public MondrianModel.VirtualCube()

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

MondrianModel.VirtualCube

public MondrianModel.VirtualCube(MondrianModel.VirtualCube original)

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

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getEnabled

public java.lang.Boolean getEnabled()

setEnabled

public void setEnabled(java.lang.Boolean newval)

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)

getDefaultMeasure

public java.lang.String getDefaultMeasure()

setDefaultMeasure

public void setDefaultMeasure(java.lang.String newval)

getCaption

public java.lang.String getCaption()

setCaption

public void setCaption(java.lang.String newval)

getCubeUsage

public MondrianModel.CubeUsages getCubeUsage()

setCubeUsage

public void setCubeUsage(MondrianModel.CubeUsages newval)

addDimension

public void addDimension(int pos,
                         MondrianModel.VirtualCubeDimension newChild)

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

addDimension

public void addDimension(MondrianModel.VirtualCubeDimension newChild)

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

removeDimension

public boolean removeDimension(MondrianModel.VirtualCubeDimension 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.

removeDimension

public MondrianModel.VirtualCubeDimension removeDimension(int pos)

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

Returns:

The item that was removed.

getDimensions

public java.util.List<MondrianModel.VirtualCubeDimension> getDimensions()

addMeasure

public void addMeasure(int pos,
                       MondrianModel.VirtualCubeMeasure newChild)

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

addMeasure

public void addMeasure(MondrianModel.VirtualCubeMeasure newChild)

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

removeMeasure

public boolean removeMeasure(MondrianModel.VirtualCubeMeasure 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.

removeMeasure

public MondrianModel.VirtualCubeMeasure removeMeasure(int pos)

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

Returns:

The item that was removed.

getMeasures

public java.util.List<MondrianModel.VirtualCubeMeasure> getMeasures()

addCalculatedMember

public void addCalculatedMember(int pos,
                                MondrianModel.CalculatedMember newChild)

Adds the given child object at the specified position, firing an OLAPChildEvent. Calculated members that belong to this virtual cube. (Calculated members inherited from other cubes should not be in this list.)

addCalculatedMember

public void addCalculatedMember(MondrianModel.CalculatedMember newChild)

Adds the given child object at the end of the child list, firing an OLAPChildEvent. Calculated members that belong to this virtual cube. (Calculated members inherited from other cubes should not be in this list.)

removeCalculatedMember

public boolean removeCalculatedMember(MondrianModel.CalculatedMember 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.

removeCalculatedMember

public MondrianModel.CalculatedMember removeCalculatedMember(int pos)

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

Returns:

The item that was removed.

getCalculatedMembers

public java.util.List<MondrianModel.CalculatedMember> getCalculatedMembers()

addNamedSet

public void addNamedSet(int pos,
                        MondrianModel.NamedSet newChild)

Adds the given child object at the specified position, firing an OLAPChildEvent. Named sets in this cube.

addNamedSet

public void addNamedSet(MondrianModel.NamedSet newChild)

Adds the given child object at the end of the child list, firing an OLAPChildEvent. Named sets in this cube.

removeNamedSet

public boolean removeNamedSet(MondrianModel.NamedSet 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.

removeNamedSet

public MondrianModel.NamedSet removeNamedSet(int pos)

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

Returns:

The item that was removed.

getNamedSets

public java.util.List<MondrianModel.NamedSet> getNamedSets()

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.