oracle.dss.datautil.gui
Interface BuilderContext

All Superinterfaces:

ComponentContext, GuiContext

All Known Subinterfaces:

CalcBuilderContext

All Known Implementing Classes:

DefaultBuilderContext

public interface BuilderContext

extends ComponentContext

Methods and fields that are specific to QueryBuilder and CalcBuilder objects. In this interface, the term "Builder" is used to refer to both kinds of objects.

Field Summary

static java.lang.String	APPLY_MEASURE_FILTER Indicates that measure filtering is used instead of evaluating the measure dimension.
static java.lang.String	EVALUATE_MEASURE_DIMENSION Indicates that the MeasureDimension is evaluated in order to obtain the list of dimensions.
static java.lang.String	TABBED The tabbed mode of the Builder; provides dialog boxes that you can access in any order.
static java.lang.String	WIZARD The wizard mode of the Builder; provides dialog boxes that you access in sequential order.

Method Summary

boolean	addPanel(StandardPanel panel, java.lang.String panelId) Adds a panel to this Builder object after the other 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.
java.lang.Object	getBuilderContent() Retrieves the content that is associated with the BuilderContext object.
BuilderDialog	getContainer() Retrieves the container that is associated with the BuilderContext object.
java.lang.String	getDefaultPanelId() Retrieves the identifier for the default panel in the Builder instance.
oracle.bali.ewt.help.HelpProvider	getHelpProvider() Retrieves the HelpProvider for the Builder instance.
java.util.Locale	getLocale() Retrieves the locale for this Builder object.
java.lang.String	getMode() Retrieves the mode for the Builder instance.
StandardPanel	getPanel(java.lang.String panelId) Retrieves a panel with the specified identifier.
java.util.Vector	getPanelList() Retrieves the list of panels for the Builder instance.
java.awt.Dimension	getSize() Retrieves the size for the Builder instance.
java.lang.String	getTitle() Retrieves the title for the Builder instance.
boolean	initialize() Signals the Builder to create the graphical components.
boolean	isPanelVisible(java.lang.String panelId) Indicates whether the panel with the specified identifier is visible.
boolean	removePanel(java.lang.String panelId) Removes a panel from the list of panels in the panel context.
boolean	run() Signals the Builder to run the dialog.
void	setBuilderContent(java.lang.Object builderContent) Specifies the content that is associated with the BuilderContext.
void	setContainer(BuilderDialog container) Specifies the container that is associated with the BuilderContext.
void	setDefaultPanelId(java.lang.String defaultPanelId) Specifies the identifier for the default panel in the Builder instance.
void	setHelpProvider(oracle.bali.ewt.help.HelpProvider helpProvider) Specifies the HelpProvider in the Builder instance.
void	setLocale(java.util.Locale locale) Specifies the locale for this Builder instance.
void	setMode(java.lang.String builderMode) Specifies the mode for the Builder instance.
boolean	setPanelVisible(java.lang.String panelId, boolean bVisible) Specifies whether the specified panel is to be shown or hidden.
void	setSize(java.awt.Dimension size) Specifies the size for the Builder instance.
void	setTitle(java.lang.String title) Specifies the title for the Builder instance.

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, setQueryContext

Field Detail

TABBED

public static final java.lang.String TABBED

The tabbed mode of the Builder; provides dialog boxes that you can access in any order.

WIZARD

public static final java.lang.String WIZARD

The wizard mode of the Builder; provides dialog boxes that you access in sequential order.

APPLY_MEASURE_FILTER

public static final java.lang.String APPLY_MEASURE_FILTER

Indicates that measure filtering is used instead of evaluating the measure dimension. The MeasureList is used.

EVALUATE_MEASURE_DIMENSION

public static final java.lang.String EVALUATE_MEASURE_DIMENSION

Indicates that the MeasureDimension is evaluated in order to obtain the list of dimensions. The DimensionList is used.

Method Detail

addPanel

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

Adds a panel to this Builder object after the other panels.

Parameters:

panel - The panel to add.

panelId - The identifier of the panel that will come after the new panel.

Returns:

true/code> if the panel is added successfully; false if the panel is not added successfully.

doApply

public boolean doApply()
                throws DataUtilException

Signals the occurrence of the Apply event.

Returns:

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

Throws:

DataUtilException - if an error is encountered.

doCancel

public boolean doCancel()

Signals the occurrence of the Cancel event.

Returns:

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

doOK

public boolean doOK()
             throws DataUtilException

Signals the occurrence of the OK event.

Returns:

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

Throws:

DataUtilException - if an error is encountered.

getBuilderContent

public java.lang.Object getBuilderContent()

Retrieves the content that is associated with the BuilderContext object.

Returns:

The content that is associated with the BuilderContext.

getContainer

public BuilderDialog getContainer()

Retrieves the container that is associated with the BuilderContext object.

Returns:

A reference to the BuilderContext object.

getDefaultPanelId

public java.lang.String getDefaultPanelId()

Retrieves the identifier for the default panel in the Builder instance.

Returns:

The identifier for the default panel in the Builder instance.

getHelpProvider

public oracle.bali.ewt.help.HelpProvider getHelpProvider()

Retrieves the HelpProvider for the Builder instance.

Returns:

The HelpProvider for the Builder instance.

getLocale

public java.util.Locale getLocale()

Retrieves the locale for this Builder object.

Returns:

The Locale object for this Builder object.

getMode

public java.lang.String getMode()

Retrieves the mode for the Builder instance.

Returns:

The mode for the Builder instance. The mode is one of the following constants in this interface: TABBED or WIZARD.

See Also:

TABBED, WIZARD

getPanel

public StandardPanel getPanel(java.lang.String panelId)

Retrieves a panel with the specified identifier.

Returns:

The panel with the specified identifier.

getPanelList

public java.util.Vector getPanelList()

Retrieves the list of panels for the Builder instance.

Returns:

The list of panels for the Builder instance.

getSize

public java.awt.Dimension getSize()

Retrieves the size for the Builder instance.

Returns:

The size for the Builder instance.

getTitle

public java.lang.String getTitle()

Retrieves the title for the Builder instance.

Returns:

The title for the Builder instance.

initialize

public boolean initialize()

Signals the Builder to create the graphical components.

Returns:

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

Throws:

Exception - if an error is encountered.

isPanelVisible

public boolean isPanelVisible(java.lang.String panelId)

Indicates whether the panel with the specified identifier is visible.

Returns:

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

removePanel

public boolean removePanel(java.lang.String panelId)

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

Parameters:

panelId - The identifier of the panel to be removed.

Returns:

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

run

public boolean run()
            throws java.lang.Exception

Signals the Builder to run the dialog.

Returns:

true if the dialog is dismissed with an OK command; false if the dialog is cancelled.

Throws:

Exception - if an error is encountered.

setBuilderContent

public void setBuilderContent(java.lang.Object builderContent)

Specifies the content that is associated with the BuilderContext.

Parameters:

builderContent - The content that is associated with the BuilderContext.

setContainer

public void setContainer(BuilderDialog container)

Specifies the container that is associated with the BuilderContext.

Parameters:

container - A reference to the BuilderDialog.

setDefaultPanelId

public void setDefaultPanelId(java.lang.String defaultPanelId)

Specifies the identifier for the default panel in the Builder instance.

Parameters:

defaultPanelId - The identifier for the default panel in the Builder instance.

setHelpProvider

public void setHelpProvider(oracle.bali.ewt.help.HelpProvider helpProvider)

Specifies the HelpProvider in the Builder instance.

Parameters:

helpProvider - The HelpProvider in the Builder instance.

setLocale

public void setLocale(java.util.Locale locale)

Specifies the locale for this Builder instance.

Parameters:

locale - The Locale object for this Builder instance.

setMode

public void setMode(java.lang.String builderMode)

Specifies the mode for the Builder instance.

Parameters:

builderMode - The mode for the Builder instance. Use one of the following constants from this interface: TABBED or WIZARD.

See Also:

TABBED, WIZARD

setPanelVisible

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

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

Parameters:

panelId - The identifier of the specified panel.

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

Returns:

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

setSize

public void setSize(java.awt.Dimension size)

Specifies the size for the Builder instance.

Parameters:

size - The size for the Builder instance.

setTitle

public void setTitle(java.lang.String title)

Specifies the title for the Builder instance.

Parameters:

title - The title for the Builder instance.