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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ClearExclusionsAction, ClearSortFromAxisAction, MemberAction, RemoveHierarchyAction

public abstract class OlapQueryAction
extends javax.swing.AbstractAction

An abstract base action meant to be extended by actions that modify the query.

There's a specialized subclass, MemberAction, for actions that work with a specific member of a query.

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, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

protected

OlapQueryAction(WabitSwingSession session, OlapQuery query, java.lang.String name)

Method Summary

void	actionPerformed(java.awt.event.ActionEvent e)
OlapQuery	getQuery() Returns the OlapQuery object that this action modifies.
protected abstract void	performOlapQueryAction(OlapQuery query) Manipulates the query but does not execute it.

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

OlapQueryAction

protected OlapQueryAction(WabitSwingSession session,
                          OlapQuery query,
                          java.lang.String name)

Method Detail

getQuery

public OlapQuery getQuery()

Returns the OlapQuery object that this action modifies.

actionPerformed

public final void actionPerformed(java.awt.event.ActionEvent e)

performOlapQueryAction

protected abstract void performOlapQueryAction(OlapQuery query)
                                        throws QueryInitializationException

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

Parameters:

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

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

Throws:

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