oracle.dss.calculation.client.calcBuilder
Interface CalcBuilderContext

All Superinterfaces:

BuilderContext, ComponentContext, GuiContext

All Known Implementing Classes:

CalcBuilder

public interface CalcBuilderContext

extends BuilderContext

Methods specific to CalcBuilder objects.

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

APPLY_MEASURE_FILTER, EVALUATE_MEASURE_DIMENSION, TABBED, WIZARD

Method Summary

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.
Query	getQueryFilter() Retrieves the Query to use to filter the panels of the CalcBuilder, based on the associated measures, dimensions, and hierarchies.
int	getSavedLocationsDisplayCount() Retrieves the count of saved locations to display in the saved locations panel.
java.util.Vector	getSavedLocationsList() Retrieves the list of saved locations.
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.
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	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 nSavedLocationsDisplayCount) Specifies the count of saved locations to display in the saved locations panel.
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 interface oracle.dss.datautil.gui.BuilderContext

addPanel, doApply, doCancel, doOK, getBuilderContent, getContainer, getDefaultPanelId, getHelpProvider, getLocale, getMode, getPanel, getPanelList, getSize, getTitle, initialize, isPanelVisible, removePanel, run, setBuilderContent, setContainer, setDefaultPanelId, setHelpProvider, setLocale, setMode, setPanelVisible, setSize, setTitle

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

Method Detail

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.

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.

Returns:

The Query to use for filtering.

getSavedLocationsDisplayCount

public int getSavedLocationsDisplayCount()

Retrieves the count of saved locations to display in the saved locations panel.

Returns:

The count of the saved locations in the saved locations panel.

getSavedLocationsList

public java.util.Vector getSavedLocationsList()

Retrieves the list of saved locations.

Returns:

List of saved locations.

setSavedLocationsDisplayCount

public void setSavedLocationsDisplayCount(int nSavedLocationsDisplayCount)

Specifies the count of saved locations to display in the saved locations panel.

Parameters:

nSavedLocationsDisplayCount - The count of the saved locations in the saved locations panel.

setSavedLocationsList

public void setSavedLocationsList(java.util.Vector listSavedLocations)

Specifies the list of saved locations.

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.

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.

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.

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.

Parameters:

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

See Also:

setDefaultNumbers(Vector vstrDefaultNumbers), getViewFormats()