oracle.dss.calculation.client.calcBuilder
Class CalcBuilderStepStorage

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

All Implemented Interfaces:

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

public class CalcBuilderStepStorage

extends CalcBuilderDefault

Creates a MetadataManager enabled CalcBuilder implementation. This class lets users persist calculations through the CalcBuilder, PersistenceObjectChooser, and Persistence with minimal concern about underlying details.

See Also:

Serialized Form

Fields inherited from class oracle.dss.calculation.client.calcBuilder.CalcBuilder

CALCBUILDER_NAMEANDTYPE, CALCBUILDER_SAVECALC, CALCBUILDER_TEMPLATE, CALCBUILDER_WELCOME

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

APPLY_MEASURE_FILTER, EVALUATE_MEASURE_DIMENSION, TABBED, WIZARD

Constructor Summary

CalcBuilderStepStorage(java.awt.Component component, MDObject mdObject, QueryContext queryContext, MetadataManager metadataManager)
Constructor that creates a default CalcBuilder.

Method Summary

CalcStep	getCalcStep(MDObject mdObject) Retrieves the CalcStep that is associated with the specified MDObject.
CalcStepStorageHelper	getCalcStepStorageHelper() Retrieves the CalcStepStorageHelper used when attempting to save a calculation.
MDMeasure	getMDMeasure() Retrieves the original MDMeasure object.
boolean	hasPersistenceConnection(MetadataManager metadataManager) Determines whether a persistence connection has been associated with a MetadataManager object.
MDObject	invoke() Displays the CalcBuilderDialog object that represents this CalcBuilder object.
boolean	isAllowOverwrite() Determines whether calculations can be overwritten.
void	setAllowOverwrite(boolean bAllowOverwrite) Specifies whether calculations can be overwritten.
void	setCalcStepStorageHelper(CalcStepStorageHelper calcStepStorageHelper) Specifies the CalcStepStorageHelper used when attempting to save a calculation.
void	setMDMeasure(MDMeasure mdMeasure) Specifies the original MDMeasure object.
void	setMode(java.lang.String builderMode) Specifies the mode for the Builder instance.

Methods inherited from class oracle.dss.calculation.client.calcBuilder.CalcBuilder

addPanel, cleanup, doApply, doCancel, doOK, getCalcStep, getDefaultNumbers, getPanel, getPanelList, getQueryFilter, getResourcesLocation, getSavedLocationsDisplayCount, getSavedLocationsList, getViewFormats, initialize, isPanelVisible, removePanel, run, setDefaultNumbers, setLocale, setPanelVisible, setParent, setQueryFilter, setSavedLocationsDisplayCount, setSavedLocationsList, setViewFormats

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

Constructor Detail

CalcBuilderStepStorage

public CalcBuilderStepStorage(java.awt.Component component,
MDObject mdObject,
QueryContext queryContext,
MetadataManager metadataManager)
                       throws CalcBuilderException

Constructor that creates a default CalcBuilder.

Parameters:

component - The Component object that is the parent of the CalcBuilderDlg object.

mdObject - The MDObject object to be used as the initial step. If this value is null, a default step is generated.

queryContext - The QueryContext that is used to evaluate any new calculations which are added to the attached metadataManager.

metadataManager - The MetadataManager object that is used to save generated calculations.

Throws:

CalcBuilderException - If an invalid argument is encountered.

Method Detail

setAllowOverwrite

public void setAllowOverwrite(boolean bAllowOverwrite)

Specifies whether calculations can be overwritten.

Parameters:

bAllowOverwrite - a boolean value that is true when a calculation can be overwritten and false otherwise.

isAllowOverwrite

public boolean isAllowOverwrite()

Determines whether calculations can be overwritten.

Returns:

boolean which is true when calculations can be overwritten, false otherwise.

setMode

public void setMode(java.lang.String builderMode)

Specifies the mode for the Builder instance.

Overrides:

setMode in class CalcBuilder

Parameters:

builderMode - The mode for the Builder instance.

hasPersistenceConnection

public boolean hasPersistenceConnection(MetadataManager metadataManager)
                                 throws CalcBuilderException

Determines whether a persistence connection has been associated with a MetadataManager object.

Parameters:

metadataManager - The MetadataManager object that is used to save generated calculations.

Returns:

true if a persistence connection is found and false if it is not.

Throws:

CalcBuilderException - If an invalid argument is encountered.

getCalcStep

public CalcStep getCalcStep(MDObject mdObject)
                     throws MetadataManagerException

Retrieves the CalcStep that is associated with the specified MDObject.

Parameters:

mdObject - The MDObject to retrieve the CalcStep from.

Returns:

A CalcStep that represents the CalcStep that is associated with the specified MDObject.

Throws:

MetadataManagerException - If a CalcStep object cannot be retrieved from the MDObject.

invoke

public MDObject invoke()
                throws CalcBuilderException

Displays the CalcBuilderDialog object that represents this CalcBuilder object.

Returns:

The MDObject that represents the newly created or modified object, or null.

Throws:

CalcBuilderException - If there are problems invoking the CalcBuilder or saving a newly created MDMeasure object.

setMDMeasure

public void setMDMeasure(MDMeasure mdMeasure)

Specifies the original MDMeasure object.

Parameters:

mdMeasure - The MDMeasure value to saved.

getMDMeasure

public MDMeasure getMDMeasure()

Retrieves the original MDMeasure object.

Returns:

MDMeasure object that represents the original object.

setCalcStepStorageHelper

public void setCalcStepStorageHelper(CalcStepStorageHelper calcStepStorageHelper)

Specifies the CalcStepStorageHelper used when attempting to save a calculation. If this value is null, the CalcBuilderStepStorage object will not attempt to save any generated calculation.

Parameters:

calcStepStorageHelper - The CalcStepStorageHelper used to save the calculation.

getCalcStepStorageHelper

public CalcStepStorageHelper getCalcStepStorageHelper()

Retrieves the CalcStepStorageHelper used when attempting to save a calculation. If this value is null, the CalcBuilderStepStorage object will not attempt to save any generated calculation.

Returns:

CalcStepStorageHelper object that can be used to save the calculation.