oracle.dss.calculation.client.calcBuilder
Class CalcBuilder

java.lang.Object
  |
  +--oracle.dss.datautil.gui.DefaultGuiContext
        |
        +--oracle.dss.datautil.gui.DefaultComponentContext
              |
              +--oracle.dss.datautil.gui.DefaultBuilderContext
                    |
                    +--oracle.dss.calculation.client.calcBuilder.CalcBuilder

All Implemented Interfaces:

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

Direct Known Subclasses:

CalcBuilderDefault

public class CalcBuilder

extends DefaultBuilderContext

implements CalcBuilderContext, java.io.Serializable

The main class of the CalcBuilder bean. The CalcBuilder lets users create and edit calculations. It simplifies and harnesses the calculation capability of Oracle OLAP.

See Also:

Serialized Form

Field Summary

static java.lang.String	CALCBUILDER_NAMEANDTYPE A NameTypePanel object.
static java.lang.String	CALCBUILDER_SAVECALC A SaveCalcPanel object.
static java.lang.String	CALCBUILDER_TEMPLATE A TemplatePanel object.
static java.lang.String	CALCBUILDER_WELCOME A WelcomePanel object.

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

APPLY_MEASURE_FILTER, EVALUATE_MEASURE_DIMENSION, TABBED, WIZARD

Constructor Summary

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

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

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

Method Summary

boolean	addPanel(StandardPanel panel, java.lang.String panelId) Adds a panel to this CalcBuilder object, before the specified panel.
void	cleanup() Performs clean-up on resources that were allocated by the CalcBuilder object or any panels.
boolean	doApply() Signals the occurrence of the Apply event.
boolean	doCancel() Signals the occurrence of the Cancel event.
boolean	doOK() Signals the occurrence of the OK event.
CalcStep	getCalcStep() Retrieves the current CalcStep object that is associated with the CalcBuilder.
java.util.Vector	getDefaultNumbers() Retrieves a list of default numbers that are formatted by each associated ViewFormat that should be added to the Calculation Builder's number format combo box.
StandardPanel	getPanel(java.lang.String panelId) Retrieves the panel with the specified ID.
java.util.Vector	getPanelList() Retrieves the list of panels for the Builder instance.
Query	getQueryFilter() Retrieves the Query to use to filter the panels of the CalcBuilder, based on the associated measures, dimensions, and hierarchies.
java.lang.String	getResourcesLocation() Retrieves the string location of the resource bundle of the Builder object that extends this default implementation of the Builder Context.
int	getSavedLocationsDisplayCount() Retrieves the count of saved location paths that are to be displayed in the save location page.
java.util.Vector	getSavedLocationsList() Retrieves the list of saved location paths.
java.util.Vector	getViewFormats() Retrieves a list of ViewFormat objects that are used to format each associated default number that should be added to the Calculation Builder's number format combo box.
boolean	initialize() Signals the CalcBuilder to create the graphical components.
boolean	isPanelVisible(java.lang.String panelId) Indicates whether the specified panel id is visible.
boolean	removePanel(java.lang.String panelId) Removes the panel from the list of panels in the panel context.
boolean	run() Displays the CalcBuilderDialog object that displays this CalcBuilder object.
java.util.Vector	setDefaultNumbers(java.util.Vector vstrDefaultNumbers) Specifies a list of default numbers that are formatted by each associated ViewFormat that should be added to the Calculation Builder's number format combo box.
void	setLocale(java.util.Locale locale) Specifies the locale for this Builder instance.
void	setMode(java.lang.String builderMode) Specifies the mode of the CalcBuilderDialog object that will display this CalcBuilder object.
boolean	setPanelVisible(java.lang.String panelId, boolean bVisible) Indicates whether the specified panel is to be shown or hidden.
void	setParent(java.awt.Component component) Specifies the parent of the Component.
void	setQueryFilter(Query queryFilter) Specifies the Query to use to filter the panels of the CalcBuilder, based on the associated measures, dimensions, and hierarchies.
void	setSavedLocationsDisplayCount(int nCount) Specifies the count of saved location paths that are to be displayed in the save location page.
void	setSavedLocationsList(java.util.Vector listSavedLocations) Specifies the list of saved locations.
void	setViewFormats(java.util.Vector vViewFormats) Specifies a list of ViewFormat objects that are used to format each associated default number that should be added to the Calculation Builder's number format combo box.

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

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

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

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

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

getMetadataManager, getParentFrame, getQueryContext, setMetadataManager, setParentFrame, setQueryContext

Methods inherited from class java.lang.Object

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

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

getBuilderContent, getContainer, getDefaultPanelId, getHelpProvider, getLocale, getMode, getSize, getTitle, setBuilderContent, setContainer, setDefaultPanelId, setHelpProvider, setSize, setTitle

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

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

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

getMetadataManager, getParentFrame, getQueryContext, setMetadataManager, setParentFrame, setQueryContext

Field Detail

CALCBUILDER_WELCOME

public static final java.lang.String CALCBUILDER_WELCOME

A WelcomePanel object. The Welocome panel presents a template for creating a particular type of calculation.

CALCBUILDER_NAMEANDTYPE

public static final java.lang.String CALCBUILDER_NAMEANDTYPE

A NameTypePanel object. The Name and Type panel lets users specify the dimension to which a calculation is to be added (if not already identified), the name and type of the calculation.

CALCBUILDER_TEMPLATE

public static final java.lang.String CALCBUILDER_TEMPLATE

A TemplatePanel object. The Template panel presents a template for creating a particular type of calculation.

CALCBUILDER_SAVECALC

public static final java.lang.String CALCBUILDER_SAVECALC

A SaveCalcPanel object. The Save panel lets users save a calculation and specify information such as the short name, long name, and a description for the calculation.

Constructor Detail

CalcBuilder

public CalcBuilder(java.awt.Dialog owner)
            throws CalcBuilderException

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

Parameters:

owner - The dialog to serve as the parent.

Throws:

CalcBuilderException - if the CalcBuilder cannot be created or initialized.

CalcBuilder

public CalcBuilder(java.awt.Frame owner)
            throws CalcBuilderException

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

Parameters:

owner - The frame to serve as the parent.

Throws:

CalcBuilderException - if the CalcBuilder cannot be created or initialized.

CalcBuilder

public CalcBuilder()
            throws CalcBuilderException

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

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

Throws:

CalcBuilderException - if the CalcBuilder cannot be created or initialized.

Method Detail

getCalcStep

public CalcStep getCalcStep()

Retrieves the current CalcStep object that is associated with the CalcBuilder.

Returns:

The CalcStep that is associated with the CalcBuilder.

cleanup

public void cleanup()

Performs clean-up on resources that were allocated by the CalcBuilder object or any panels.

getResourcesLocation

public java.lang.String getResourcesLocation()

Retrieves the string location of the resource bundle of the Builder object that extends this default implementation of the Builder Context.

Overrides:

getResourcesLocation in class DefaultBuilderContext

Returns:

The String that specifies the location of the resource bundle.

setLocale

public void setLocale(java.util.Locale locale)

Specifies the locale for this Builder instance.

Specified by:

setLocale in interface BuilderContext

Overrides:

setLocale in class DefaultBuilderContext

Parameters:

locale - The Locale object for this Builder instance.

addPanel

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

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

Specified by:

addPanel in interface BuilderContext

Overrides:

addPanel in class DefaultBuilderContext

Parameters:

panel - The panel to add.

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

doApply

public boolean doApply()

Signals the occurrence of the Apply event.

Specified by:

doApply in interface BuilderContext

Overrides:

doApply in class DefaultBuilderContext

Returns:

true if the operation was successful; false if the operation was not successful.

doCancel

public boolean doCancel()

Signals the occurrence of the Cancel event.

Specified by:

doCancel in interface BuilderContext

Overrides:

doCancel in class DefaultBuilderContext

Returns:

true if the operation was successful; false if the operation was not successful.

doOK

public boolean doOK()

Signals the occurrence of the OK event.

Specified by:

doOK in interface BuilderContext

Overrides:

doOK in class DefaultBuilderContext

Returns:

true if the operation was successful; false if the operation was not successful.

getPanel

public StandardPanel getPanel(java.lang.String panelId)

Retrieves the panel with the specified ID.

Specified by:

getPanel in interface BuilderContext

Overrides:

getPanel in class DefaultBuilderContext

Parameters:

panelId - The ID for the panel that should be retrieved.

Returns:

The panel with the specified ID.

getPanelList

public java.util.Vector getPanelList()

Retrieves the list of panels for the Builder instance.

Specified by:

getPanelList in interface BuilderContext

Overrides:

getPanelList in class DefaultBuilderContext

Returns:

The list of panels for the Builder instance.

isPanelVisible

public boolean isPanelVisible(java.lang.String panelId)

Indicates whether the specified panel id is visible.

Specified by:

isPanelVisible in interface BuilderContext

Overrides:

isPanelVisible in class DefaultBuilderContext

Parameters:

panelId - The id of the specified panel.

Returns:

true if the specified panel is visible; false if the specified panel is not visible.

removePanel

public boolean removePanel(java.lang.String panelId)

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

Specified by:

removePanel in interface BuilderContext

Overrides:

removePanel in class DefaultBuilderContext

Parameters:

panelId - The ID of the panel to be removed.

Returns:

true if the remove operation was successful; false if the remove operation was not successful.

initialize

public boolean initialize()

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

Specified by:

initialize in interface BuilderContext

Overrides:

initialize in class DefaultBuilderContext

Returns:

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

run

public boolean run()
            throws CalcBuilderException

Displays the CalcBuilderDialog object that displays this CalcBuilder object.

Specified by:

run in interface BuilderContext

Overrides:

run in class DefaultBuilderContext

Returns:

true if the mode of the CalcBuilderDialog object is set to WIZARD and the object ran successfully, or if the mode is set to TABBED; false if the mode is set to WIZARD and the CalcBuilderDialog object was cancelled.

Throws:

CalcBuilderException - If an error is encountered.

See Also:

BuilderContext.TABBED, BuilderContext.WIZARD

setMode

public void setMode(java.lang.String builderMode)

Specifies the mode of the CalcBuilderDialog object that will display this CalcBuilder object.

Specified by:

setMode in interface BuilderContext

Overrides:

setMode in class DefaultBuilderContext

Parameters:

builderMode - A constant that represents the mode of the CalcBuilderDialog object. The valid constants are: TABBED or WIZARD.

See Also:

BuilderContext.TABBED, BuilderContext.WIZARD

setPanelVisible

public boolean setPanelVisible(java.lang.String panelId,
                               boolean bVisible)

Indicates whether the specified panel is to be shown or hidden.

Specified by:

setPanelVisible in interface BuilderContext

Overrides:

setPanelVisible in class DefaultBuilderContext

Parameters:

panelId - The ID of the specified panel.

bVisible - true if the panel is to be marked visible, false if the panel is not to be marked visible.

Returns:

true if the panel was marked successfully, false if the operation failed.

setQueryFilter

public void setQueryFilter(Query queryFilter)

Specifies the Query to use to filter the panels of the CalcBuilder, based on the associated measures, dimensions, and hierarchies.

Specified by:

setQueryFilter in interface CalcBuilderContext

Parameters:

query - The Query to use for filtering.

getQueryFilter

public Query getQueryFilter()

Retrieves the Query to use to filter the panels of the CalcBuilder, based on the associated measures, dimensions, and hierarchies.

Specified by:

getQueryFilter in interface CalcBuilderContext

Returns:

The Query to use for filtering.

getSavedLocationsDisplayCount

public int getSavedLocationsDisplayCount()

Retrieves the count of saved location paths that are to be displayed in the save location page.

Specified by:

getSavedLocationsDisplayCount in interface CalcBuilderContext

Returns:

The count of saved location paths that are to be displayed.

getSavedLocationsList

public java.util.Vector getSavedLocationsList()

Retrieves the list of saved location paths.

Specified by:

getSavedLocationsList in interface CalcBuilderContext

Returns:

A list of saved location paths.

setSavedLocationsDisplayCount

public void setSavedLocationsDisplayCount(int nCount)

Specifies the count of saved location paths that are to be displayed in the save location page.

Specified by:

setSavedLocationsDisplayCount in interface CalcBuilderContext

Parameters:

nCount - The number of saved location paths to be displayed.

setSavedLocationsList

public void setSavedLocationsList(java.util.Vector listSavedLocations)

Specifies the list of saved locations.

Specified by:

setSavedLocationsList in interface CalcBuilderContext

Parameters:

listSavedLocations - List of saved locations.

getDefaultNumbers

public java.util.Vector getDefaultNumbers()

Retrieves a list of default numbers that are formatted by each associated ViewFormat that should be added to the Calculation Builder's number format combo box. Each default number that appears in the list should have an associated ViewFormat specified in the same relative position. If this value is null, a default list of numbers is used.

Specified by:

getDefaultNumbers in interface CalcBuilderContext

Returns:

Vector value containing the list of String values which contain the numbers that should formatted and added to the number format combo box.

See Also:

getViewFormats(), setDefaultNumbers(Vector vstrDefaultNumbers)

setDefaultNumbers

public java.util.Vector setDefaultNumbers(java.util.Vector vstrDefaultNumbers)

Specifies a list of default numbers that are formatted by each associated ViewFormat that should be added to the Calculation Builder's number format combo box. Each default number that appears in the list should have an associated ViewFormat specified in the same relative position. If this value is null, a default list of numbers is used.

Specified by:

setDefaultNumbers in interface CalcBuilderContext

Parameters:

vstrDefaultNumbers - A Vector of String values which represent the numbers that should formatted and added to the number format combo box.

Returns:

Vector value containing the list of String values which represent the numbers that should formatted and added to the number format combo box.

See Also:

setViewFormats(Vector vViewFormats), getDefaultNumbers()

getViewFormats

public java.util.Vector getViewFormats()

Retrieves a list of ViewFormat objects that are used to format each associated default number that should be added to the Calculation Builder's number format combo box. Each ViewFormat object that appears in the list should have an associated default number specified in the same relative position. The formatted numbers are added to the number format combo box in the same order that they appear in the ViewFormat and default number lists. If this value is null, a default list of ViewFormat values is used.

Specified by:

getViewFormats in interface CalcBuilderContext

Returns:

Vector of ViewFormat objects associated with the Calculation Builder's number format combo box.

See Also:

getDefaultNumbers(), setViewFormats(Vector vViewFormats)

setViewFormats

public void setViewFormats(java.util.Vector vViewFormats)

Specifies a list of ViewFormat objects that are used to format each associated default number that should be added to the Calculation Builder's number format combo box. Each ViewFormat object that appears in the list should have an associated default number specified in the same relative position. The formatted numbers are added to the number format combo box in the same order that they appear in the ViewFormat and default number lists. If this value is null, a default list of ViewFormat values is used.

Specified by:

setViewFormats in interface CalcBuilderContext

Parameters:

vViewFormats - A Vector of ViewFormat objects used to format each associated default number.

See Also:

setDefaultNumbers(Vector vstrDefaultNumbers), getViewFormats()

setParent

public void setParent(java.awt.Component component)

Specifies the parent of the Component.

Specified by:

setParent in interface ComponentContext

Overrides:

setParent in class DefaultComponentContext

Parameters:

component - The parent of the Component instance.