ca.sqlpower.architect.olap
Class MondrianModel.Relation

java.lang.Object
  ca.sqlpower.architect.olap.OLAPObject
      ca.sqlpower.architect.olap.MondrianModel.RelationOrJoin
          ca.sqlpower.architect.olap.MondrianModel.Relation

Direct Known Subclasses:

MondrianModel.InlineTable, MondrianModel.Table, MondrianModel.View

Enclosing class:

MondrianModel

public abstract static class MondrianModel.Relation
extends MondrianModel.RelationOrJoin

A table, inline table or view

Field Summary

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

pcs

Constructor Summary

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

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

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.
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.
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.
java.lang.String	toString()

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

public MondrianModel.Relation()

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

MondrianModel.Relation

public MondrianModel.Relation(MondrianModel.Relation original)

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

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class MondrianModel.RelationOrJoin

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

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

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

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

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

Parameters:

child - The child to remove.