ca.sqlpower.architect.olap
Class OLAPRootObject

java.lang.Object
  ca.sqlpower.architect.olap.OLAPObject
      ca.sqlpower.architect.olap.OLAPRootObject

public class OLAPRootObject
extends OLAPObject

The top of the OLAP business model. This root object contains OLAPSessions, each of which contains exactly one Schema object.

Field Summary

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

pcs

Constructor Summary

OLAPRootObject(ArchitectSession session)

Method Summary

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.
ArchitectSession	getArchitectSession() Returns the ArchtectSession this OLAP Root Object belongs to.
java.util.List<OLAPSession>	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.
OLAPSession	removeOLAPSession(int pos) Removes the child object at the given position, firing an OLAPChildEvent.
boolean	removeOLAPSession(OLAPSession removeChild) Removes the given child object, firing an OLAPChildEvent if the child was found.

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

addChild, 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, toString, wait, wait, wait

Constructor Detail

OLAPRootObject

public OLAPRootObject(ArchitectSession session)

Method Detail

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.

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.

removeOLAPSession

public boolean removeOLAPSession(OLAPSession 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.

removeOLAPSession

public OLAPSession removeOLAPSession(int pos)

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

Returns:

The item that was removed.

getArchitectSession

public ArchitectSession getArchitectSession()

Returns the ArchtectSession this OLAP Root Object belongs to.

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

getChildren

public java.util.List<OLAPSession> 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