ca.sqlpower.architect.olap
Class MondrianModel.Dimension

java.lang.Object
  ca.sqlpower.architect.olap.OLAPObject
      ca.sqlpower.architect.olap.MondrianModel.CubeDimension
          ca.sqlpower.architect.olap.MondrianModel.Dimension

Enclosing class:

MondrianModel

public static class MondrianModel.Dimension
extends MondrianModel.CubeDimension

A Dimension is a collection of hierarchies. There are two kinds: a public dimension belongs to a Schema, and be used by several cubes; a private dimension belongs to a Cube. The foreignKey field is only applicable to private dimensions.

Field Summary

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

pcs

Constructor Summary

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

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

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	addHierarchy(int pos, MondrianModel.Hierarchy newChild) Adds the given child object at the specified position, firing an OLAPChildEvent.
void	addHierarchy(MondrianModel.Hierarchy 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.util.List<MondrianModel.Hierarchy>	getHierarchies()
java.lang.String	getName() Default implementation.
java.lang.String	getType()
java.lang.String	getUsagePrefix()
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.Hierarchy	removeHierarchy(int pos) Removes the child object at the given position, firing an OLAPChildEvent.
boolean	removeHierarchy(MondrianModel.Hierarchy removeChild) Removes the given child object, firing an OLAPChildEvent if the child was found.
void	setCaption(java.lang.String newval)
void	setName(java.lang.String newval)
void	setType(java.lang.String newval)
void	setUsagePrefix(java.lang.String newval)
java.lang.String	toString()

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

getForeignKey, setForeignKey

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.Dimension

public MondrianModel.Dimension()

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

MondrianModel.Dimension

public MondrianModel.Dimension(MondrianModel.Dimension original)

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

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class MondrianModel.CubeDimension

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 MondrianModel.CubeDimension

setName

public void setName(java.lang.String newval)

Overrides:

setName in class MondrianModel.CubeDimension

getType

public java.lang.String getType()

setType

public void setType(java.lang.String newval)

getCaption

public java.lang.String getCaption()

Overrides:

getCaption in class MondrianModel.CubeDimension

setCaption

public void setCaption(java.lang.String newval)

Overrides:

setCaption in class MondrianModel.CubeDimension

getUsagePrefix

public java.lang.String getUsagePrefix()

setUsagePrefix

public void setUsagePrefix(java.lang.String newval)

addHierarchy

public void addHierarchy(int pos,
                         MondrianModel.Hierarchy newChild)

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

addHierarchy

public void addHierarchy(MondrianModel.Hierarchy newChild)

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

removeHierarchy

public boolean removeHierarchy(MondrianModel.Hierarchy 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.

removeHierarchy

public MondrianModel.Hierarchy removeHierarchy(int pos)

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

Returns:

The item that was removed.

getHierarchies

public java.util.List<MondrianModel.Hierarchy> getHierarchies()

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.CubeDimension

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.CubeDimension

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.CubeDimension

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.CubeDimension

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.CubeDimension

Parameters:

child - The child to remove.