ca.sqlpower.wabit.swingui.olap.action
Class MemberAction

java.lang.Object
  javax.swing.AbstractAction
      ca.sqlpower.wabit.swingui.olap.action.OlapQueryAction
          ca.sqlpower.wabit.swingui.olap.action.MemberAction

All Implemented Interfaces:

java.awt.event.ActionListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, javax.swing.Action

Direct Known Subclasses:

DrillReplaceAction, DrillUpAction, ExcludeMemberAction, SortByMeasureAction

public abstract class MemberAction
extends OlapQueryAction

Abstract base action for all of the actions that make modifications to an OlapQuery based on a provided Member

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

protected

MemberAction(WabitSwingSession session, java.lang.String name, OlapQuery query, org.olap4j.metadata.Member member)

Method Summary

org.olap4j.metadata.Member	getMember()
protected abstract void	performMemberAction(org.olap4j.metadata.Member member, OlapQuery query) Subclass hook.
protected void	performOlapQueryAction(OlapQuery query) Manipulates the query but does not execute it.

Methods inherited from class ca.sqlpower.wabit.swingui.olap.action.OlapQueryAction

actionPerformed, getQuery

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MemberAction

protected MemberAction(WabitSwingSession session,
                       java.lang.String name,
                       OlapQuery query,
                       org.olap4j.metadata.Member member)

Method Detail

performOlapQueryAction

protected final void performOlapQueryAction(OlapQuery query)
                                     throws QueryInitializationException

Description copied from class: OlapQueryAction

Manipulates the query but does not execute it. The OlapQueryAction.actionPerformed(ActionEvent) method will begin background execution of the query after calling this method.

Specified by:

performOlapQueryAction in class OlapQueryAction

Parameters:

query - The query to manipulate. Don't execute it!

This is the same query as returned by OlapQueryAction.getQuery(); it's provided for your convenience.

Throws:

QueryInitializationException - If the query failed to initialize itself as a side effect of manipulating it.

performMemberAction

protected abstract void performMemberAction(org.olap4j.metadata.Member member,
                                            OlapQuery query)
                                     throws QueryInitializationException

Subclass hook. When implementing this method, manipulate the given member in the given query in whatever way makes sense for your specific action. Do not execute the query; this will be done after you return.

Parameters:

member - The member that was selected as the subject of this action.

This is the same member as returned by getMember(); it's provided for your convenience.

query - The query to manipulate. Don't execute it!

This is the same query as returned by OlapQueryAction.getQuery(); it's provided for your convenience.

Throws:

QueryInitializationException - If the query failed to initialize itself as a side effect of manipulating it.

getMember

public org.olap4j.metadata.Member getMember()