oracle.dss.queryBuilder
Class QueryBuilder

java.lang.Object
  |
  +--oracle.dss.datautil.gui.DefaultGuiContext
        |
        +--oracle.dss.datautil.gui.DefaultComponentContext
              |
              +--oracle.dss.datautil.gui.DefaultBuilderContext
                    |
                    +--oracle.dss.queryBuilder.QueryBuilder

All Implemented Interfaces:

BuilderContext, ComponentContext, ErrorHandlerCallback, GuiContext, java.io.Serializable

public class QueryBuilder

extends DefaultBuilderContext

implements java.io.Serializable

This class is the main class of the QueryBuilder bean. The QueryBuilder bean is a customizer of the QueryManager bean that lets users query data against a multidimensional model and have access to the advanced analytical query capabilities of Oracle OLAP.

See Also:

Serialized Form

Field Summary

static int	ADD The add action, which adds new members.
static int	CONDITIONS The Conditions panel.
static int	DEFAULT The default label type.
static int	DEFAULT_CONDITIONS Indicates that the Conditions panel is visible by default.
static int	DEFAULT_FAVORITES Indicates that the Favorites panel is visible by default.
static int	DEFAULT_MEMBERS Indicates that the Members panel is visible by default.
static int	DEFAULT_PREVIEW Indicates that the Preview panel is visible by default.
static int	DEFAULT_STEPS Indicates that the Steps panel is visible by default.
static java.lang.String	DIMENSION_PANEL_ID The identifier for the Dimensions panel.
static int	DIMENSIONS The Dimension panel.
static int	FAVORITES The Favorites panel.
static int	HIDDEN_DIMENSIONS The Hidden Dimensions panel.
static java.lang.String	HIDDEN_DIMENSIONS_PANEL_ID The identifier for the Hidden Dimensions panel.
static int	ITEMS The Items panel.
static java.lang.String	ITEMS_PANEL_ID The identifier for the Items panel.
static int	KEEP The keep action, which keeps the new members in the current selection and discards the others.
static int	LAYOUT The Layout panel.
static java.lang.String	LAYOUT_PANEL_ID The identifier for the Layout panel.
static int	MEMBERS The Members panel.
static int	PREVIEW The Preview panel.
static int	REMOVE The remove action, which removes the new members from the current selection and keeps the others.
static int	STEPS The Steps panel.
static int	WELCOME The Welcome panel.
static java.lang.String	WELCOME_PANEL_ID The identifier for the Welcome panel.

Fields inherited from interface oracle.dss.datautil.gui.BuilderContext

APPLY_MEASURE_FILTER, EVALUATE_MEASURE_DIMENSION, TABBED, WIZARD

Constructor Summary

QueryBuilder()
Deprecated. As of 2.6.0.20, replaced by QueryBuilder(Dialog) or by QueryBuilder(Frame).

QueryBuilder(java.awt.Dialog owner)
Constructor that specifies the dialog that serves as the parent for the QueryBuilder.

QueryBuilder(java.awt.Frame owner)
Constructor that specifies the frame that serves as the parent for the QueryBuilder.

Method Summary

boolean	addPanel(StandardPanel panel, java.lang.String panelId) Adds a panel to this QueryBuilder object, before the specified panel.
void	applyChanges() Applies the changes made in this QueryBuilder object to the query in the Query object and creates a new query, if necessary.
boolean	doApply() Signals that the user selected the Apply button.
boolean	doCancel() Signals that the user selected the Cancel button.
boolean	doOK() Signals that the user selected the OK button.
int	getDefaultAction() Retrieves the default action that appears in the Action box in the Conditions panel and the Favorites panel.
int	getDefaultAvailableDimensionsPanel() Retrieves which panel, in the group of panels on the left side of the Dimension panel (that is, the Members, Conditions, or Favorites panel), is visible by default.
int	getDefaultSelectedDimensionsPanel() Retrieves which panel, in the group of panels on the right side of the Dimension panel (that is, the Steps or Preview panel), is visible by default.
java.util.Vector	getDimensionPanels() Retrieves the DimensionPanel objects for this QueryBuilder object.
java.lang.String[]	getFavoriteSearchPathNames() Retrieves the array of names for renaming folders in the Favorites tab in the QueryBuilder.
java.lang.String[]	getFavoriteSearchPaths() Retrieves the array of folders for the Favorites tab in the QueryBuilder.
HiddenDimensionsPanel	getHiddenDimensionsPanel() Retrieves the HiddenDimensionsPanel object for this QueryBuilder object.
java.lang.String[]	getItemSearchPathNames() Retrieves the array of names for renaming folders in the Items panel in the QueryBuilder.
java.lang.String[]	getItemSearchPaths() Retrieves the array of folders for the Items panel in the QueryBuilder.
ItemsPanel	getItemsPanel() Retrieves the ItemsPanel object for this QueryBuilder object.
QueryBuilderLayoutPanel	getLayoutPanel() Retrieves the LayoutPanel object for this QueryBuilder object.
int	getPanelCount() Retrieves the number of panels in this QueryBuilder object.
java.util.Vector	getPanelList() Retrieves the list of panels for this QueryBuilder object.
QueryContext	getQuery() Retrieves the Query object for this QueryBuilder object.
Layout	getViewLayoutPanel() Retrieves the view Layout object that appears in the QueryBuilderPanel object.
int	getVisibleDimensionPanels() Retrieves which of the panels that are contained by the Dimension panel (that is, Members, Conditions, Favorites, Steps, and Preview) are visible in this QueryBuilder object.
java.lang.String[]	getVisibleDimensions() Retrieves the list of visible dimensions.
int	getVisiblePanels() Retrieves which top-level panels (that is, Welcome, Items, Layout, Dimension, and Hiddens Dimensions) are visible in the QueryBuilderDialog object that is used to display this QueryBuilder object.
boolean	initialize() Signals the QueryBuilder to create the graphical components.
void	initialize(java.util.Hashtable env) Initializes the implementation of the Persistable interface.
boolean	isAbstractConditionsEnabled() Indicates whether abstract names(such as Measure1 > Measure2) or actual names (such as Sales > Costs) are used to identify measures in conditions.
boolean	isApplyAllowed() Indicates whether the Apply button in the QueryBuilderDialog object is displayed, in tabbed mode only.
boolean	isConditionGroupingEnabled() Indicates whether the available conditions in the Conditions panel are grouped into folders.
boolean	isConditionsPanelVisible() Indicates whether the Conditions panel is visible.
boolean	isDimensionsPanelVisible() Indicates whether the Dimension panel is visible.
boolean	isDimensionVisible() Retrieves whether the Choose box on the Dimension panel is displayed.
boolean	isFavoritesPanelVisible() Indicates whether the Favorites panel is visible.
boolean	isHiddenDimensionsPanelVisible() Indicates whether the Hidden Dimensions panel is visible.
boolean	isHierarchyVisible() Indicates whether the Level/Hierarchy box in the appropriate Edit Step dialog boxes is displayed.
boolean	isItemsPanelVisible() Indicates whether the Items panel is visible.
boolean	isLayoutPanelVisible() Indicates whether the Layout panel is visible.
boolean	isManualSortAllowed() Indicates whether manual sorting is allowed in the Sort Items dialog box and whether drag-and-drop sorting is allowed in the Preview panel.
boolean	isMembersPanelVisible() Indicates whether the Members panel is visible.
boolean	isPreviewPanelVisible() Indicates whether the Preview panel is visible.
boolean	isQualifierVisible() Indicates whether, for each measure in a condition, the For box and the Qualify button in the Edit Condition dialog box are displayed.
boolean	isSaveAllowed() Indicates whether the Save button in the Dimension panel is displayed.
boolean	isSortAllowed() Indicates whether the Sort button in the Dimension panel is displayed.
boolean	isStartCollapsed() Indicates whether the dimension lists in the Dimensions panel first appear collapsed or expanded.
boolean	isStepsPanelVisible() Indicates whether the Steps panel is visible.
boolean	isVisible() Indicates whether this QueryBuilder object is displayed in a QueryBuilderDialog object.
boolean	isWelcomePanelVisible() Indicates whether the Welcome panel is visible.
boolean	removePanel(java.lang.String panelId) Removes the panel from the list of panels in the panel context.
boolean	run() Displays the QueryBuilder object.
void	setAbstractConditionsEnabled(boolean blnAbstractConditions) Specifies whether to use abstract names(such as Measure1 > Measure2) or actual names (such as Sales > Costs) to identify measures in conditions.
void	setApplyAllowed(boolean blnApplyAllowed) Specifies whether to display the Apply button in the QueryBuilderDialog
void	setConditionGroupingEnabled(boolean blnGroupConditions) Specifies whether to group the available conditions in the Conditions panel into folders.
void	setDefaultAction(int intDefaultAction) Specifies the default action to appear in the Action box in the Conditions panel and the Favorites panel.
void	setDefaultAvailableDimensionsPanel(int intDefaultAvailableDimensionsPanel) Specifies which panel, in the group of panels on the left side of the Dimension panel (that is, the Members, Conditions, or Favorites panel), is to be visible by default.
void	setDefaultSelectedDimensionsPanel(int intDefaultSelectedDimensionsPanel) Specifies which panel, in the group of panels on the right side of the Dimension panel (that is, the Steps or Preview panel), is to be visible by default.
void	setDimensionPanels(java.util.Vector dimensions) Specifies the DimensionPanel objects for this QueryBuilder object.
void	setDimensionVisible(boolean blnDimensionVisible) Specifies whether to display the Choose box in the Dimension panel.
void	setFavoriteSearchPathNames(java.lang.String[] pathNames) Specifies an array of names to use for renaming folders for display in the Favorites tab in the QueryBuilder.
void	setFavoriteSearchPaths(java.lang.String[] paths) Specifies an array of folders whose names are not displayed in the Favorites tab in the QueryBuilder.
void	setHierarchyVisible(boolean blnHierarchyVisible) Specifies whether to display the Level/Hierarchy box in the appropriate Edit Step dialog boxes.
void	setItemSearchPathNames(java.lang.String[] pathNames) Specifies an array of names to use for renaming folders for display in the Items panel in the QueryBuilder.
void	setItemSearchPaths(java.lang.String[] paths) Specifies an array of folders whose names are not displayed in the Items panel in the QueryBuilder.
void	setLocale(java.util.Locale locale) Specifies the locale for this QueryBuilder object.
void	setManualSortAllowed(boolean blnManualSortAllowed) Specifies whether to allow manual sorting in the Sort Items dialog box and to allow drag-and-drop sorting in the Preview panel.
void	setQualifierVisible(boolean blnQDRVisible) Specifies whether to display, for each measure in a condition, the For box and the Qualify button in the Edit Condition dialog box.
void	setQuery(QueryContext queryContext) Specifies the QueryContext object for this QueryBuilder object.
void	setQueryContext(QueryContext queryContext) Specifies the QueryContext object.
void	setSaveAllowed(boolean blnSaveAllowed) Specifies whether to display the Save button in the Dimension panel.
void	setSortAllowed(boolean blnSortAllowed) Specifies whether to display the Sort button in the Dimension panel.
void	setStartCollapsed(boolean blnStartCollapsed) Specifies whether the dimension lists in the Dimensions panel should first appear expanded or collapsed.
void	setViewLayoutPanel(Layout viewLayoutPanel) Specifies the view Layout object to appear in the QueryBuilderPanel object.
void	setVisible(boolean blnVisible) Specifies whether to display this QueryBuilder object in a QueryBuilderDialog object.
void	setVisibleDimensionPanels(int intVisibleDimensionPanels) Specifies which of the panels that are contained by the Dimension panel (that is, Members, Conditions, Favorites, Steps, and Preview) are to be visible in this QueryBuilder object.
void	setVisibleDimensions(java.lang.String[] strVisibleDimensions) Specifies the dimensions that are to be accessible from this QueryBuilder object.
void	setVisiblePanels(int intVisiblePanels) Specifies which top-level panels (that is, Welcome, Items, Layout, Dimension, and Hidden Dimensions) are to be visible in the QueryBuilderDialog object that is used to display this QueryBuilder object.

Methods inherited from class oracle.dss.datautil.gui.DefaultBuilderContext

addErrorHandler, getBuilderContent, getContainer, getDefaultPanelId, getErrorHandler, getHelpProvider, getLocale, getMode, getPanel, getResourcesLocation, getSize, getTitle, isPanelVisible, isShowWelcomeNextTime, removeErrorHandler, setBuilderContent, setContainer, setDefaultPanelId, setHelpProvider, setMode, setPanelVisible, setShowWelcomeNextTime, setSize, setTitle

Methods inherited from class oracle.dss.datautil.gui.DefaultComponentContext

getDimensionContext, getDisplayLabelType, getDisplayMemberLabelType, getMeasureContext, getParent, getPopupItemCount, setDimensionContext, setDisplayLabelType, setDisplayMemberLabelType, setMeasureContext, setParent, setPopupItemCount

Methods inherited from class oracle.dss.datautil.gui.DefaultGuiContext

getMetadataManager, getParentFrame, getQueryContext, setMetadataManager, setParentFrame

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.dss.datautil.gui.ComponentContext

getDimensionContext, getDisplayLabelType, getDisplayMemberLabelType, getMeasureContext, getParent, getPopupItemCount, setDimensionContext, setDisplayLabelType, setDisplayMemberLabelType, setMeasureContext, setParent, setPopupItemCount

Methods inherited from interface oracle.dss.datautil.gui.GuiContext

getMetadataManager, getParentFrame, getQueryContext, setMetadataManager, setParentFrame

Field Detail

ADD

public static final int ADD

The add action, which adds new members.

KEEP

public static final int KEEP

The keep action, which keeps the new members in the current selection and discards the others.

REMOVE

public static final int REMOVE

The remove action, which removes the new members from the current selection and keeps the others.

ITEMS_PANEL_ID

public static final java.lang.String ITEMS_PANEL_ID

The identifier for the Items panel.

LAYOUT_PANEL_ID

public static final java.lang.String LAYOUT_PANEL_ID

The identifier for the Layout panel.

DIMENSION_PANEL_ID

public static final java.lang.String DIMENSION_PANEL_ID

The identifier for the Dimensions panel.

HIDDEN_DIMENSIONS_PANEL_ID

public static final java.lang.String HIDDEN_DIMENSIONS_PANEL_ID

The identifier for the Hidden Dimensions panel.

WELCOME_PANEL_ID

public static final java.lang.String WELCOME_PANEL_ID

The identifier for the Welcome panel.

WELCOME

public static final int WELCOME

The Welcome panel.

ITEMS

public static final int ITEMS

The Items panel.

LAYOUT

public static final int LAYOUT

The Layout panel.

DIMENSIONS

public static final int DIMENSIONS

The Dimension panel.

HIDDEN_DIMENSIONS

public static final int HIDDEN_DIMENSIONS

The Hidden Dimensions panel.

DEFAULT_MEMBERS

public static final int DEFAULT_MEMBERS

Indicates that the Members panel is visible by default.

DEFAULT_CONDITIONS

public static final int DEFAULT_CONDITIONS

Indicates that the Conditions panel is visible by default.

DEFAULT_FAVORITES

public static final int DEFAULT_FAVORITES

Indicates that the Favorites panel is visible by default.

DEFAULT_STEPS

public static final int DEFAULT_STEPS

Indicates that the Steps panel is visible by default.

DEFAULT_PREVIEW

public static final int DEFAULT_PREVIEW

Indicates that the Preview panel is visible by default.

MEMBERS

public static final int MEMBERS

The Members panel.

CONDITIONS

public static final int CONDITIONS

The Conditions panel.

FAVORITES

public static final int FAVORITES

The Favorites panel.

STEPS

public static final int STEPS

The Steps panel.

PREVIEW

public static final int PREVIEW

The Preview panel.

DEFAULT

public static final int DEFAULT

The default label type.

Constructor Detail

QueryBuilder

public QueryBuilder(java.awt.Dialog owner)

Constructor that specifies the dialog that serves as the parent for the QueryBuilder.

Parameters:

owner - The dialog to serve as the parent.

QueryBuilder

public QueryBuilder(java.awt.Frame owner)

Constructor that specifies the frame that serves as the parent for the QueryBuilder.

Parameters:

owner - The frame to serve as the parent.

QueryBuilder

public QueryBuilder()

Deprecated. As of 2.6.0.20, replaced by QueryBuilder(Dialog) or by QueryBuilder(Frame).

A QueryBuilder should have a parent dialog or frame associated with it to ensure proper focus handling.

Method Detail

setQueryContext

public void setQueryContext(QueryContext queryContext)

Specifies the QueryContext object.

Overrides:

setQueryContext in class DefaultGuiContext

Parameters:

queryContext - The QueryContext object.

setSaveAllowed

public void setSaveAllowed(boolean blnSaveAllowed)

Specifies whether to display the Save button in the Dimension panel. The Save button displays the Save As Favorite dialog box, which allows a user to save a selection as a favorite.

Parameters:

blnSaveAllowed - true if the Save button is to be displayed, false if it is not.

isSaveAllowed

public boolean isSaveAllowed()

Indicates whether the Save button in the Dimension panel is displayed. The Save button displays the Save As Favorite dialog box, which allows a user to save a selection as a favorite.

Returns:

true if the Save button is displayed, false if it is not.

setManualSortAllowed

public void setManualSortAllowed(boolean blnManualSortAllowed)

Specifies whether to allow manual sorting in the Sort Items dialog box and to allow drag-and-drop sorting in the Preview panel.

Parameters:

blnManualSortAllowed - true if manual sorting is allowed, false if it is not.

isManualSortAllowed

public boolean isManualSortAllowed()

Indicates whether manual sorting is allowed in the Sort Items dialog box and whether drag-and-drop sorting is allowed in the Preview panel.

Returns:

true if manual sorting is allowed, false if it is not.

setSortAllowed

public void setSortAllowed(boolean blnSortAllowed)

Specifies whether to display the Sort button in the Dimension panel. The Sort button displays the Sort Items dialog box, which allows a user to specify the sort criteria for members of a particular dimension.

Parameters:

blnSortAllowed - true if the Sort button is to be displayed, false if it is not.

isSortAllowed

public boolean isSortAllowed()

Indicates whether the Sort button in the Dimension panel is displayed. The Sort button displays the Sort Items dialog box, which allows a user to specify the sort criteria for members of a particular dimension.

Returns:

true if the Sort button is displayed, false if it is not.

setApplyAllowed

public void setApplyAllowed(boolean blnApplyAllowed)

Specifies whether to display the Apply button in the QueryBuilderDialogApply button applies all previously unapplied changes without closing the QueryBuilder.

Parameters:

blnApplyAllowed - true if the Apply button is to be displayed, false if it is not.

isApplyAllowed

public boolean isApplyAllowed()

Indicates whether the Apply button in the QueryBuilderDialog object is displayed, in tabbed mode only. The Apply button applies all previously unapplied changes, without closing the QueryBuilder.

Returns:

true if the Apply button is displayed, false if it is not.

setDimensionVisible

public void setDimensionVisible(boolean blnDimensionVisible)

Specifies whether to display the Choose box in the Dimension panel. The Choose box allows a user to specify the dimension for which to specify a set of members. If the mode of this QueryBuilder object is wizard, then set this method to false, because a separate Dimension panel appears for each dimension, which eliminates the need for the Choose box.

Parameters:

blnDimensionsVisible - true if the Choose box is to be displayed, false if it is not.

setVisibleDimensions

public void setVisibleDimensions(java.lang.String[] strVisibleDimensions)

Specifies the dimensions that are to be accessible from this QueryBuilder object. By default, all dimensions in the cube are accessible.

Parameters:

dimensions - The unique dimension identifiers for the dimensions that are to be accessible. See your administrator for the unique dimension identifiers for your dimensions.

getVisibleDimensions

public java.lang.String[] getVisibleDimensions()

Retrieves the list of visible dimensions.

Returns:

The String that specifies the list of visible dimensions.

isDimensionVisible

public boolean isDimensionVisible()

Retrieves whether the Choose box on the Dimension panel is displayed. The Choose box allows a user to specify the dimension for which to specify a set of members.

Returns:

true if the Choose box is displayed, false if it is not.

setHierarchyVisible

public void setHierarchyVisible(boolean blnHierarchyVisible)

Specifies whether to display the Level/Hierarchy box in the appropriate Edit Step dialog boxes.

Parameters:

blnHierarchyVisible - true if the Level/Hierarchy box is to be displayed, false if it is not.

isHierarchyVisible

public boolean isHierarchyVisible()

Indicates whether the Level/Hierarchy box in the appropriate Edit Step dialog boxes is displayed.

Returns:

true if the Level/Hierarchy box is displayed, false if it is not.

setStartCollapsed

public void setStartCollapsed(boolean blnStartCollapsed)

Specifies whether the dimension lists in the Dimensions panel should first appear expanded or collapsed.

Parameters:

blnStartCollapsed - true if the dimension lists should first appear collapsed, false if they should not.

isStartCollapsed

public boolean isStartCollapsed()

Indicates whether the dimension lists in the Dimensions panel first appear collapsed or expanded.

Returns:

true if the dimension lists first appear collapsed, false if they do not.

setDefaultAction

public void setDefaultAction(int intDefaultAction)

Specifies the default action to appear in the Action box in the Conditions panel and the Favorites panel.

Parameters:

intDefaultAction - A constant that represents the action.

See Also:

ADD, KEEP, REMOVE

getDefaultAction

public int getDefaultAction()

Retrieves the default action that appears in the Action box in the Conditions panel and the Favorites panel.

Returns:

A constant that represents the action.

See Also:

ADD, KEEP, REMOVE

setQualifierVisible

public void setQualifierVisible(boolean blnQDRVisible)

Specifies whether to display, for each measure in a condition, the For box and the Qualify button in the Edit Condition dialog box. The Qualify button displays the Qualify Measure dialog box, which allows a user to qualify a measure in a condition.

Parameters:

blnQDRVisible - true if, for each measure in a condition, the For box and the Qualify button are to be displayed in the Edit Condition dialog box; false if they are not.

isQualifierVisible

public boolean isQualifierVisible()

Indicates whether, for each measure in a condition, the For box and the Qualify button in the Edit Condition dialog box are displayed. The Qualify button displays the Qualify Measure dialog box, which allows a user to qualify a measure in a condition.

Returns:

true if, for each measure in a condition, the For box and the Qualify button are displayed; false if they are not.

setVisible

public void setVisible(boolean blnVisible)

Specifies whether to display this QueryBuilder object in a QueryBuilderDialog object. If you do not display this QueryBuilder object in a QueryBuilderDialog object, then you must create your own container in which to display this QueryBuilder object.

Parameters:

blnVisible - true if the this QueryBuilder object is to be displayed in a QueryBuilderDialog object; false if it is not.

isVisible

public boolean isVisible()

Indicates whether this QueryBuilder object is displayed in a QueryBuilderDialog object.

Returns:

true if the this QueryBuilder object is displayed in a QueryBuilderDialog object; false if it is not.

isWelcomePanelVisible

public boolean isWelcomePanelVisible()

Indicates whether the Welcome panel is visible.

Returns:

true if the Welcome panel is visible, false if it is not.

isItemsPanelVisible

public boolean isItemsPanelVisible()

Indicates whether the Items panel is visible.

Returns:

true if the Items panel is visible, false if it is not.

isLayoutPanelVisible

public boolean isLayoutPanelVisible()

Indicates whether the Layout panel is visible.

Returns:

true if the Layout panel is visible, false if it is not.

isDimensionsPanelVisible

public boolean isDimensionsPanelVisible()

Indicates whether the Dimension panel is visible.

Returns:

true if the Dimension panel is visible, false if it is not.

isHiddenDimensionsPanelVisible

public boolean isHiddenDimensionsPanelVisible()

Indicates whether the Hidden Dimensions panel is visible.

Returns:

true if the Hidden Dimensions panel is visible, false if it is not.

setDefaultAvailableDimensionsPanel

public void setDefaultAvailableDimensionsPanel(int intDefaultAvailableDimensionsPanel)

Specifies which panel, in the group of panels on the left side of the Dimension panel (that is, the Members, Conditions, or Favorites panel), is to be visible by default.

Parameters:

intDefaultAvailableDimensionsPanel - A constant that represents the panel.

See Also:

DEFAULT_CONDITIONS, DEFAULT_FAVORITES, DEFAULT_MEMBERS

getDefaultAvailableDimensionsPanel

public int getDefaultAvailableDimensionsPanel()

Retrieves which panel, in the group of panels on the left side of the Dimension panel (that is, the Members, Conditions, or Favorites panel), is visible by default.

Returns:

A constant that represents the panel.

See Also:

DEFAULT_CONDITIONS, DEFAULT_FAVORITES, DEFAULT_MEMBERS

isFavoritesPanelVisible

public boolean isFavoritesPanelVisible()

Indicates whether the Favorites panel is visible.

Returns:

true if the Favorites panel is visible, false if it is not.

isMembersPanelVisible

public boolean isMembersPanelVisible()

Indicates whether the Members panel is visible.

Returns:

true if the Members panel is visible, false if it is not.

isConditionsPanelVisible

public boolean isConditionsPanelVisible()

Indicates whether the Conditions panel is visible.

Returns:

true if the Conditions panel is visible, false if it is not.

setDefaultSelectedDimensionsPanel

public void setDefaultSelectedDimensionsPanel(int intDefaultSelectedDimensionsPanel)

Specifies which panel, in the group of panels on the right side of the Dimension panel (that is, the Steps or Preview panel), is to be visible by default.

Parameters:

intDefaultSelectedDimensionsPanel - A constant that represents the panel.

See Also:

DEFAULT_PREVIEW, DEFAULT_STEPS

getDefaultSelectedDimensionsPanel

public int getDefaultSelectedDimensionsPanel()

Retrieves which panel, in the group of panels on the right side of the Dimension panel (that is, the Steps or Preview panel), is visible by default.

Returns:

A constant that represents the panel.

See Also:

DEFAULT_PREVIEW, DEFAULT_STEPS

isStepsPanelVisible

public boolean isStepsPanelVisible()

Indicates whether the Steps panel is visible.

Returns:

true if the Steps panel is visible, false if it is not.

isPreviewPanelVisible

public boolean isPreviewPanelVisible()

Indicates whether the Preview panel is visible.

Returns:

true if the Preview panel is visible, false if it is not.

setQuery

public void setQuery(QueryContext queryContext)

Specifies the QueryContext object for this QueryBuilder object.

Parameters:

queryContext - The QueryContext object that implements the QueryContext interface.

getQuery

public QueryContext getQuery()

Retrieves the Query object for this QueryBuilder object.

Returns:

The Query object that implements the QueryContext interface.

applyChanges

public void applyChanges()
                  throws DataUtilException

Applies the changes made in this QueryBuilder object to the query in the Query object and creates a new query, if necessary.

Parameters:

blnApplySelections - true if the changes are to be applied, false if they are not.

Throws:

DataUtilException - If an error occurs.

getPanelCount

public int getPanelCount()

Retrieves the number of panels in this QueryBuilder object.

Returns:

The number of panels.

getItemsPanel

public ItemsPanel getItemsPanel()

Retrieves the ItemsPanel object for this QueryBuilder object.

Returns:

The ItemsPanel object.

getLayoutPanel

public QueryBuilderLayoutPanel getLayoutPanel()

Retrieves the LayoutPanel object for this QueryBuilder object.

Returns:

The LayoutPanel object.

getViewLayoutPanel

public Layout getViewLayoutPanel()

Retrieves the view Layout object that appears in the QueryBuilderPanel object.

Returns:

The Layout object.

setViewLayoutPanel

public void setViewLayoutPanel(Layout viewLayoutPanel)

Specifies the view Layout object to appear in the QueryBuilderPanel object.

Parameters:

viewLayoutPanel - The Layout object.

getDimensionPanels

public java.util.Vector getDimensionPanels()

Retrieves the DimensionPanel objects for this QueryBuilder object.

Returns:

The vector of DimensionPanel objects.

setDimensionPanels

public void setDimensionPanels(java.util.Vector dimensions)

Specifies the DimensionPanel objects for this QueryBuilder object.

Parameters:

dimensions - The unique dimension identifiers for the dimensions that are to be displayed in a DimensionPanel object. See your administrator for the unique dimension identifiers for your dimensions.

getHiddenDimensionsPanel

public HiddenDimensionsPanel getHiddenDimensionsPanel()

Retrieves the HiddenDimensionsPanel object for this QueryBuilder object.

Returns:

The HiddenDimensionsPanel object.

setVisiblePanels

public void setVisiblePanels(int intVisiblePanels)

Specifies which top-level panels (that is, Welcome, Items, Layout, Dimension, and Hidden Dimensions) are to be visible in the QueryBuilderDialog object that is used to display this QueryBuilder object.

Parameters:

intVisiblePanels - A constant that represents the panels that are to be visible.

See Also:

DIMENSION_PANEL_ID, HIDDEN_DIMENSIONS_PANEL_ID, ITEMS_PANEL_ID, LAYOUT_PANEL_ID, WELCOME_PANEL_ID

getVisiblePanels

public int getVisiblePanels()

Retrieves which top-level panels (that is, Welcome, Items, Layout, Dimension, and Hiddens Dimensions) are visible in the QueryBuilderDialog object that is used to display this QueryBuilder object.

Returns:

A constant that represents the panels that are visible.

See Also:

DIMENSION_PANEL_ID, HIDDEN_DIMENSIONS_PANEL_ID, ITEMS_PANEL_ID, LAYOUT_PANEL_ID, WELCOME_PANEL_ID, isDimensionsPanelVisible(), isHiddenDimensionsPanelVisible(), isItemsPanelVisible(), isLayoutPanelVisible(), isWelcomePanelVisible()

setVisibleDimensionPanels

public void setVisibleDimensionPanels(int intVisibleDimensionPanels)

Specifies which of the panels that are contained by the Dimension panel (that is, Members, Conditions, Favorites, Steps, and Preview) are to be visible in this QueryBuilder object.

Parameters:

intVisibleDimensionPanels - A constant that represents the panels that are to be visible.

See Also:

DEFAULT_MEMBERS, DEFAULT_CONDITIONS, DEFAULT_FAVORITES, DEFAULT_STEPS

getVisibleDimensionPanels

public int getVisibleDimensionPanels()

Retrieves which of the panels that are contained by the Dimension panel (that is, Members, Conditions, Favorites, Steps, and Preview) are visible in this QueryBuilder object.

Returns:

The constant that represents the panels that are visible.

See Also:

DEFAULT_MEMBERS, DEFAULT_CONDITIONS, DEFAULT_FAVORITES, DEFAULT_STEPS

isConditionGroupingEnabled

public boolean isConditionGroupingEnabled()

Indicates whether the available conditions in the Conditions panel are grouped into folders.

Returns:

true if the available conditions are grouped into folders; false if they are not.

setConditionGroupingEnabled

public void setConditionGroupingEnabled(boolean blnGroupConditions)

Specifies whether to group the available conditions in the Conditions panel into folders.

Parameters:

blnGroupConditions - true if the available conditions are to be grouped into folders, false if they are not.

isAbstractConditionsEnabled

public boolean isAbstractConditionsEnabled()

Indicates whether abstract names(such as Measure1 > Measure2) or actual names (such as Sales > Costs) are used to identify measures in conditions.

Returns:

true if abstract names are used, false if actual names are used.

setAbstractConditionsEnabled

public void setAbstractConditionsEnabled(boolean blnAbstractConditions)

Specifies whether to use abstract names(such as Measure1 > Measure2) or actual names (such as Sales > Costs) to identify measures in conditions.

Parameters:

blnAbstractConditions - true if abstract names are to be used, false if actual names are to be used.

initialize

public void initialize(java.util.Hashtable env)

Initializes the implementation of the Persistable interface.

addPanel

public boolean addPanel(StandardPanel panel,
                        java.lang.String panelId)

Adds a panel to this QueryBuilder object, before the specified panel. See the BI Beans Help system for important information about adding panels, especially before the Welcome panel.

Overrides:

addPanel in class DefaultBuilderContext

Parameters:

panel - The panel to add.

panelId - The ID of the panel that appears after the new panel.

removePanel

public boolean removePanel(java.lang.String panelId)

Removes the panel from the list of panels in the panel context.

Overrides:

removePanel in class DefaultBuilderContext

Parameters:

panelId - The ID of the panel to be removed.

Returns:

true if the remove operation is successful, false if the remove operation is not successful.

doApply

public boolean doApply()
                throws DataUtilException

Signals that the user selected the Apply button.

Overrides:

doApply in class DefaultBuilderContext

Returns:

true if the apply operation is successful, false if it is not.

Throws:

DataUtilException - If an error occurs.

doOK

public boolean doOK()
             throws DataUtilException

Signals that the user selected the OK button.

Overrides:

doOK in class DefaultBuilderContext

Returns:

true if the apply and cleanup operations are successful, false if they are not.

Throws:

DataUtilException - If an error occurs.

doCancel

public boolean doCancel()

Signals that the user selected the Cancel button.

Overrides:

doCancel in class DefaultBuilderContext

Returns:

true if the cleanup operation is successful, false if it is not.

getPanelList

public java.util.Vector getPanelList()

Retrieves the list of panels for this QueryBuilder object.

Overrides:

getPanelList in class DefaultBuilderContext

Returns:

The list of panels for this QueryBuilder object.

initialize

public boolean initialize()

Signals the QueryBuilder to create the graphical components. Use this method when you need to add a listener to a graphical component before displaying the component.

Overrides:

initialize in class DefaultBuilderContext

Returns:

true if no problems were encountered, false if a problem was encountered.

run

public boolean run()
            throws DataUtilException

Displays the QueryBuilder object.

Overrides:

run in class DefaultBuilderContext

Throws:

DataUtilException - If an error occurs.

setLocale

public void setLocale(java.util.Locale locale)

Specifies the locale for this QueryBuilder object.

Overrides:

setLocale in class DefaultBuilderContext

Parameters:

locale - The locale object for this QueryBuilder object.

setItemSearchPaths

public void setItemSearchPaths(java.lang.String[] paths)

Specifies an array of folders whose names are not displayed in the Items panel in the QueryBuilder. Only those items within the folders whose names are specified in the array are displayed in the panel. Use this method to customize the display of folders in the Items panel. See the "Customizing the Display of Folders in QueryBuilder" topic in the Help system for more information and examples.

Parameters:

paths - The folder names.

getItemSearchPaths

public java.lang.String[] getItemSearchPaths()

Retrieves the array of folders for the Items panel in the QueryBuilder.

Returns:

The folder names.

setItemSearchPathNames

public void setItemSearchPathNames(java.lang.String[] pathNames)

Specifies an array of names to use for renaming folders for display in the Items panel in the QueryBuilder. Only those items within the folders whose names are specified in the array are displayed in the panel. Use this method to customize the display of folders in the Items panel. See the "Customizing the Display of Folders in QueryBuilder" topic in the Help system for more information and examples.

Parameters:

paths - The folder names.

getItemSearchPathNames

public java.lang.String[] getItemSearchPathNames()

Retrieves the array of names for renaming folders in the Items panel in the QueryBuilder.

Returns:

The folder names.

setFavoriteSearchPaths

public void setFavoriteSearchPaths(java.lang.String[] paths)

Specifies an array of folders whose names are not displayed in the Favorites tab in the QueryBuilder. Only those items within the folders whose names are specified in the array are displayed in the tab. Use this method to customize the display of folders in the Favorites tab. See the "Customizing the Display of Folders in QueryBuilder" topic in the Help system for more information and examples.

Parameters:

paths - The folder names.

getFavoriteSearchPaths

public java.lang.String[] getFavoriteSearchPaths()

Retrieves the array of folders for the Favorites tab in the QueryBuilder.

Returns:

The folder names.

setFavoriteSearchPathNames

public void setFavoriteSearchPathNames(java.lang.String[] pathNames)

Specifies an array of names to use for renaming folders for display in the Favorites tab in the QueryBuilder. Only those items within the folders whose names are specified in the array are displayed in the tab. Use this method to customize the display of folders in the Favorites tab. See the "Customizing the Display of Folders in QueryBuilder" topic in the Help system for more information and examples.

Parameters:

paths - The folder names.

getFavoriteSearchPathNames

public java.lang.String[] getFavoriteSearchPathNames()

Retrieves the array of names for renaming folders in the Favorites tab in the QueryBuilder.

Returns:

The folder names.