com.sas.dataselectors.filters.timebased.olap
Class OLAPTimeBasedFilterAdapter

com.sas.dataselectors.filters.timebased.olap.OLAPTimeBasedFilterAdapter

All Implemented Interfaces:

OLAPTimeBasedFilterAdapterInterface, TimeBasedFilterAdapterInterface, SelectorCommitInterface, java.lang.Cloneable

public class OLAPTimeBasedFilterAdapter
implements OLAPTimeBasedFilterAdapterInterface

Field Summary

static int	DEFAULT_PERIOD_TYPE_INDEX
static int	MINIMUM_N_PERIOD_VALUE
static java.lang.String	RB_KEY

Fields inherited from class com.sas.dataselectors.filters.timebased.TimeBasedFilterAdapter

dataItem

Fields inherited from interface com.sas.dataselectors.SelectorCommitInterface

EXCEPTION_OCCURRED

Constructor Summary

OLAPTimeBasedFilterAdapter(OLAPTimeBasedFilterAdapterDataSourceInterface model)

Method Summary

java.lang.Object	clone() Returns a duplicate and seperate instance of the implementing object.
java.util.Map	commit() Required to satisfy the SelectorCommitInterface
java.lang.String	getCurrentFirstPeriod()
java.lang.String	getCurrentFirstPeriodLabel()
java.lang.String	getCurrentLastPeriod()
java.lang.String	getCurrentLastPeriodLabel()
java.lang.String	getDefaultEndingPeriodOption() Returns the default ending period option.
java.lang.String	getDefaultNumberOfPeriods() Returns the default number of periods.
java.lang.String	getDefaultSelectOption() Returns the default select option.
java.lang.String	getDefaultShowOption() Returns the default show option.
java.lang.String	getDefaultStartingPeriodOption() Returns the default starting period option.
java.lang.String	getEndingPeriodLabel() Returns the localized ending period label for the currently defined period.
java.lang.String	getEndingPeriodOption() Returns the the currently selected 'Ending -period-:' option
java.util.List	getEndingPeriodOptionsList() Returns the list of options the user can choose for a ending period.
javax.swing.tree.TreeModel	getEndTreeModel()
java.lang.Object	getFilterExpression() Returns the filter expression associated with the adapter.
java.util.List	getFullShowOptionsList() Returns the list of all possible viewing options the user can choose from regardless of the period type.
java.util.Locale	getLocale() Returns the locale
java.lang.String	getLocalizedAcrossLabelFirstParameter()
java.lang.String	getLocalizedAcrossLabelSecondParameter()
java.lang.String	getLocalizedNPeriodsLabelParameter()
java.lang.String	getLocalizedPeriodType()
java.lang.String	getLocalizedRangeLabelParameter()
java.lang.String	getLocalizedSelectLabelParameter()
java.lang.String	getNumberOfPeriods() Returns the number of periods entered for the 'N -periods- where N =' view
java.lang.String	getPeriodType() Returns the period type currently selected
int	getPeriodType(java.lang.String uniquePeriodName) Returns the integer period type for the specified period name.
java.util.List	getPeriodTypes() Returns the list of period types which the user can choose from
java.lang.Object	getPropertiesBean() Required to satisfy the SelectorCommitInterface but not used in this implementation.
java.util.List	getSelectablePeriods() Returns a List of selectable periods used to populate the 'Select' CheckBoxList.
java.lang.String	getSelectedEndingPeriod() Returns the value selected in the 'Selected -period-:' TreeView of the 'Ending -period-:' radio box.
java.lang.String	getSelectedEndingPeriodLabel() Returns the label of the value selected in the 'Selected -period-:' TreeView of the 'Ending -period-:' radio box.
java.lang.String[]	getSelectedPeriods() Returns the values selected in the 'Select -periods-:' TreeView.
java.lang.String	getSelectedStartingPeriod() Returns the value selected in the 'Selected -period-:' TreeView of the 'Starting -period-:' radio box.
java.lang.String	getSelectedStartingPeriodLabel() Returns the label of the value selected in the 'Selected -period-:' TreeView of the 'Starting -period-:' radio box.
java.lang.String	getSelectOption() Returns the the currently selected 'Select:' option
java.util.List	getSelectOptionsList() Returns the list of options the user can choose for a date range.
java.lang.String	getShowOption() Returns the currently selected show option
java.util.List	getShowOptionsList() Returns the list of viewing options the user can choose from for a specific period type.
java.lang.String	getStartingPeriodLabel() Returns the localized starting period label for the currently defined period.
java.lang.String	getStartingPeriodOption() Returns the the currently selected 'Starting -period-:' option
java.util.List	getStartingPeriodOptionsList() Returns the list of options the user can choose for a starting period.
javax.swing.tree.TreeModel	getStartTreeModel()
boolean	isModified() Returns true if the user explicitally modified the initial values, false otherwise.
boolean	isPanelVisible()
boolean	isRuntime() Returns the property indicating whether or not this adapter is operating within a runtime environment (versus design-time)
void	resetValuesToDefault() Resets the values in the adapter to their default.
void	setDataItem(java.lang.Object dataItem) Sets the data item the time based filter is working with.
void	setEndingPeriodOption(java.lang.String value) Sets the selected 'Ending -period-:' option
void	setFilterExpression(java.lang.Object filterExpr) Sets the filter expression associated with the adapter.
void	setFilterStep(java.lang.Object step) Sets the filter step associated with the adapter.
void	setLocale(java.util.Locale locale) Sets the locale
void	setModified(boolean modified) Sets the modified flag.
void	setNumberOfPeriods(java.lang.String value) Sets the number of periods entered for the 'N -periods- where N =' view
void	setPanelVisible(boolean visible) To indicates if the OLAPTimeBasedFilterSelectorPanel should or should not be displayed
void	setPeriodType(java.lang.String value) Sets the period type
void	setRuntime(boolean runtime) Sets the property indicating whether or not this adapter is operating within a runtime environment (versus design-time)
void	setSelectedEndingPeriod(java.lang.String value) Sets the value selected in the 'Selected -period-:' TreeView of the 'Ending -period-:' radio box.
void	setSelectedEndingPeriod(javax.swing.tree.TreeNode treeNode) Sets the value selected in the 'Selected -period-:' TreeView of the 'Ending -period-:' radio box.
void	setSelectedPeriods(java.lang.String[] values) Sets the values selected in the 'Select -periods-:' TreeView.
void	setSelectedStartingPeriod(java.lang.String value) Sets the value selected in the 'Selected -period-:' TreeView of the 'Starting -period-:' radio box.
void	setSelectedStartingPeriod(javax.swing.tree.TreeNode treeNode) Sets the value selected in the 'Selected -period-:' TreeView of the 'Starting -period-:' radio box.
void	setSelectOption(java.lang.String value) Sets the selected 'Select:' option
void	setShowOption(java.lang.String value) Sets the selected show option
void	setStartingPeriodOption(java.lang.String value) Sets the selected 'Starting -period-:' option

Methods inherited from class com.sas.dataselectors.filters.timebased.TimeBasedFilterAdapter

getDataItem

Field Detail

RB_KEY

public static final java.lang.String RB_KEY

See Also:

Constant Field Values

MINIMUM_N_PERIOD_VALUE

public static int MINIMUM_N_PERIOD_VALUE

DEFAULT_PERIOD_TYPE_INDEX

public static int DEFAULT_PERIOD_TYPE_INDEX

Constructor Detail

OLAPTimeBasedFilterAdapter

public OLAPTimeBasedFilterAdapter(OLAPTimeBasedFilterAdapterDataSourceInterface model)

Method Detail

setDataItem

public void setDataItem(java.lang.Object dataItem)

Description copied from interface: TimeBasedFilterAdapterInterface

Sets the data item the time based filter is working with.

Specified by:

setDataItem in interface TimeBasedFilterAdapterInterface

Overrides:

setDataItem in class TimeBasedFilterAdapter

Parameters:

dataItem - the data item the time based filter is working with. It's a or belongs to a 'Time' dimension

setRuntime

public void setRuntime(boolean runtime)

Sets the property indicating whether or not this adapter is operating within a runtime environment (versus design-time)

Parameters:

runtime - Set to true to indicate runtime, false to indicate design-time

isRuntime

public boolean isRuntime()

Returns the property indicating whether or not this adapter is operating within a runtime environment (versus design-time)

Returns:

True if the environment is runtime, false if its design-time

getPropertiesBean

public java.lang.Object getPropertiesBean()

Required to satisfy the SelectorCommitInterface but not used in this implementation.

Specified by:

getPropertiesBean in interface SelectorCommitInterface

Returns:

this implementation always returns null.

See Also:

SelectorCommitInterface

commit

public java.util.Map commit()

Required to satisfy the SelectorCommitInterface

Specified by:

commit in interface SelectorCommitInterface

setLocale

public void setLocale(java.util.Locale locale)

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Sets the locale

Specified by:

setLocale in interface OLAPTimeBasedFilterAdapterInterface

Parameters:

locale - The locale.

getLocale

public java.util.Locale getLocale()

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Returns the locale

Specified by:

getLocale in interface OLAPTimeBasedFilterAdapterInterface

Returns:

The locale.

setFilterExpression

public void setFilterExpression(java.lang.Object filterExpr)

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Sets the filter expression associated with the adapter. Used for the Swing version of the selector that uses this adapter.

Specified by:

setFilterExpression in interface OLAPTimeBasedFilterAdapterInterface

Parameters:

filterExpr - A filter expression to associate with the adapter.

getFilterExpression

public java.lang.Object getFilterExpression()

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Returns the filter expression associated with the adapter. Used for the Swing version of the selector that uses this adapter.

Specified by:

getFilterExpression in interface OLAPTimeBasedFilterAdapterInterface

Returns:

The associated filter expression.

setFilterStep

public void setFilterStep(java.lang.Object step)

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Sets the filter step associated with the adapter. Used for the Web version of the selector that uses this adapter.

Specified by:

setFilterStep in interface OLAPTimeBasedFilterAdapterInterface

Parameters:

step - the filter step associated with the adapter.

getPeriodTypes

public java.util.List getPeriodTypes()

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Returns the list of period types which the user can choose from

Specified by:

getPeriodTypes in interface OLAPTimeBasedFilterAdapterInterface

Returns:

a List of String[2] elements where the first String is the localized text and the second String is a unique id associated to the localized text. Example [0] = "Years" and [1] = "YEAR".

getShowOptionsList

public java.util.List getShowOptionsList()

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Returns the list of viewing options the user can choose from for a specific period type.
Example for a period type like Month, the user can choose to see either 'N months' or 'Months across years' or 'Range of months' etc.
While for a period type like Year, the user can only choose to see either 'N years' or 'Range of years'.

Specified by:

getShowOptionsList in interface OLAPTimeBasedFilterAdapterInterface

Returns:

a List of String[2] elements where the first String is the localized text and the second String is a unique id associated to the localized text. Example [0] = "Months across years" and [1] = "OTFS_SHOW_RADIO_ACROSS_VALUE".

getFullShowOptionsList

public java.util.List getFullShowOptionsList()

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Returns the list of all possible viewing options the user can choose from regardless of the period type.
For example 'N months' or 'Months across years' or 'Range of months' etc. It's a utility method only used to initially populate the JSP version of the 'Show:' radio box with all the possible values. At run time those values will be hidden/displayed depending on the selected period type.
Internal API only.

Specified by:

getFullShowOptionsList in interface OLAPTimeBasedFilterAdapterInterface

Returns:

a List of String[2] elements where the first String is the localized text and the second String is a unique id associated to the localized text. Example [0] = "Months across years" and [1] = "OTFS_SHOW_RADIO_ACROSS_VALUE".

getShowOption

public java.lang.String getShowOption()

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Returns the currently selected show option

Specified by:

getShowOption in interface OLAPTimeBasedFilterAdapterInterface

Returns:

one of OLAPTimeBasedFilterConstants.OTFS_SHOW_RADIO_N_PERIODS_VALUE OLAPTimeBasedFilterConstants.OTFS_SHOW_RADIO_ACROSS_VALUE OLAPTimeBasedFilterConstants.OTFS_SHOW_RADIO_RANGE_OF_PERIODS_VALUE

setShowOption

public void setShowOption(java.lang.String value)

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Sets the selected show option

Specified by:

setShowOption in interface OLAPTimeBasedFilterAdapterInterface

Parameters:

value - one of OLAPTimeBasedFilterConstants.OTFS_SHOW_RADIO_N_PERIODS_VALUE OLAPTimeBasedFilterConstants.OTFS_SHOW_RADIO_ACROSS_VALUE OLAPTimeBasedFilterConstants.OTFS_SHOW_RADIO_RANGE_OF_PERIODS_VALUE

getNumberOfPeriods

public java.lang.String getNumberOfPeriods()

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Returns the number of periods entered for the 'N -periods- where N =' view

Specified by:

getNumberOfPeriods in interface OLAPTimeBasedFilterAdapterInterface

Returns:

a String containing an integer number

setNumberOfPeriods

public void setNumberOfPeriods(java.lang.String value)

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Sets the number of periods entered for the 'N -periods- where N =' view

Specified by:

setNumberOfPeriods in interface OLAPTimeBasedFilterAdapterInterface

Parameters:

value - the number of periods

getLocalizedSelectLabelParameter

public java.lang.String getLocalizedSelectLabelParameter()

Specified by:

getLocalizedSelectLabelParameter in interface OLAPTimeBasedFilterAdapterInterface

Returns:

the localized parameter to put into the label of the Select radiobox, something like 'months' or 'years' so that we can create the full localized label for the Select radiobox, something like 'Select months:' or 'Select years:' An empty string is returned if it cannot provide with a localized one.

getLocalizedNPeriodsLabelParameter

public java.lang.String getLocalizedNPeriodsLabelParameter()

Specified by:

getLocalizedNPeriodsLabelParameter in interface OLAPTimeBasedFilterAdapterInterface

Returns:

the localized parameter to put into the label of the 'N Periods' item of th 'Show' radiobox, something like 'months' or 'years' so that we can create the full localized label for that item, something like 'N months where N =' or 'N years where N =' An empty string is returned if it cannot provide with a localized one.

getLocalizedAcrossLabelFirstParameter

public java.lang.String getLocalizedAcrossLabelFirstParameter()

Specified by:

getLocalizedAcrossLabelFirstParameter in interface OLAPTimeBasedFilterAdapterInterface

Returns:

the localized first parameter to put into the label of the 'Across periods' item of th 'Show' radiobox, something like 'Months' or 'Days' so that we can create the full localized label for that item, something like 'Months across years' or 'Days across months' An empty string is returned if it cannot provide with a localized one.

getLocalizedAcrossLabelSecondParameter

public java.lang.String getLocalizedAcrossLabelSecondParameter()

Specified by:

getLocalizedAcrossLabelSecondParameter in interface OLAPTimeBasedFilterAdapterInterface

Returns:

the localized second parameter to put into the label of the 'Across periods' item of th 'Show' radiobox, something like 'years' or 'months' so that we can create the full localized label for that item, something like 'Months across years' or 'Days across months' An empty string is returned if it cannot provide with a localized one.

getLocalizedRangeLabelParameter

public java.lang.String getLocalizedRangeLabelParameter()

Specified by:

getLocalizedRangeLabelParameter in interface OLAPTimeBasedFilterAdapterInterface

Returns:

the localized parameter to put into the label of the 'Range of' item of th 'Show' radiobox, something like 'months' or 'years' so that we can create the full localized label for that item, something like 'Range of months' or 'Range of years' An empty string is returned if it cannot provide with a localized one.

getLocalizedPeriodType

public java.lang.String getLocalizedPeriodType()

Specified by:

getLocalizedPeriodType in interface OLAPTimeBasedFilterAdapterInterface

Returns:

the localized period type, something like 'month' or 'year' so that we can create localized labels like 'The first month', 'The first year', 'The last month', 'The last year', 'Selected month' and 'Selected year'

getSelectablePeriods

public java.util.List getSelectablePeriods()

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Returns a List of selectable periods used to populate the 'Select' CheckBoxList.

Specified by:

getSelectablePeriods in interface OLAPTimeBasedFilterAdapterInterface

Returns:

the List of String[2] elements where the first String is the localized text and the second String is a unique id associated to the localized text. Example [0] = "January" and [1] = "DIR_1".

getCurrentFirstPeriod

public java.lang.String getCurrentFirstPeriod()

Specified by:

getCurrentFirstPeriod in interface OLAPTimeBasedFilterAdapterInterface

Returns:

the current value of the 'The first xx' period, something like '[TIME].[All TIME].[2000].[1].[1]' An empty string is returned if it cannot provide with a value.

getCurrentFirstPeriodLabel

public java.lang.String getCurrentFirstPeriodLabel()

Specified by:

getCurrentFirstPeriodLabel in interface OLAPTimeBasedFilterAdapterInterface

Returns:

the current label of the 'The first xx' period, something like '2000.1.1' An empty string is returned if it cannot provide with a label.

getCurrentLastPeriod

public java.lang.String getCurrentLastPeriod()

Specified by:

getCurrentLastPeriod in interface OLAPTimeBasedFilterAdapterInterface

Returns:

the current value of the 'The last xx' period, something like '[TIME].[All TIME].[2001].[4].[12]' An empty string is returned if it cannot provide with a value.

getCurrentLastPeriodLabel

public java.lang.String getCurrentLastPeriodLabel()

Specified by:

getCurrentLastPeriodLabel in interface OLAPTimeBasedFilterAdapterInterface

Returns:

the current label of the 'The last xx' period, something like '2001.4.12' An empty string is returned if it cannot provide with a value.

getStartTreeModel

public javax.swing.tree.TreeModel getStartTreeModel()

Specified by:

getStartTreeModel in interface OLAPTimeBasedFilterAdapterInterface

Returns:

return the model for the 'Starting xx' TreeView

getEndTreeModel

public javax.swing.tree.TreeModel getEndTreeModel()

Specified by:

getEndTreeModel in interface OLAPTimeBasedFilterAdapterInterface

Returns:

return the model for the 'Ending xx' TreeView

setPanelVisible

public void setPanelVisible(boolean visible)

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

To indicates if the OLAPTimeBasedFilterSelectorPanel should or should not be displayed

Specified by:

setPanelVisible in interface OLAPTimeBasedFilterAdapterInterface

Parameters:

visible - true if the OLAPTimeBasedFilterSelectorPanel should be displayed, false otherwise

isPanelVisible

public boolean isPanelVisible()

Specified by:

isPanelVisible in interface OLAPTimeBasedFilterAdapterInterface

Returns:

true if the OLAPTimeBasedFilterSelectorPanel should be displayed, false otherwise

getPeriodType

public int getPeriodType(java.lang.String uniquePeriodName)

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Returns the integer period type for the specified period name.

Specified by:

getPeriodType in interface OLAPTimeBasedFilterAdapterInterface

Parameters:

uniquePeriodName - A string representing the unique name of the period to query.

Returns:

The integer value representing the period type.

getPeriodType

public java.lang.String getPeriodType()

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Returns the period type currently selected

Specified by:

getPeriodType in interface OLAPTimeBasedFilterAdapterInterface

Returns:

something like

setPeriodType

public void setPeriodType(java.lang.String value)

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Sets the period type

Specified by:

setPeriodType in interface OLAPTimeBasedFilterAdapterInterface

Parameters:

value - the period type

getSelectOptionsList

public java.util.List getSelectOptionsList()

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Returns the list of options the user can choose for a date range. Example either 'Starting period' or 'Ending period'.

Specified by:

getSelectOptionsList in interface OLAPTimeBasedFilterAdapterInterface

Returns:

a List of String[2] elements where the first String is the localized text and the second String is a unique id associated to the localized text. Example [0] = "Starting period" and [1] = "OTFS_SELECT_RADIO_STARTING_PERIOD_VALUE".

getSelectOption

public java.lang.String getSelectOption()

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Returns the the currently selected 'Select:' option

Specified by:

getSelectOption in interface OLAPTimeBasedFilterAdapterInterface

Returns:

one of OLAPTimeBasedFilterConstants.OTFS_SELECT_RADIO_STARTING_PERIOD_VALUE OLAPTimeBasedFilterConstants.OTFS_SELECT_RADIO_ENDING_PERIOD_VALUE

setSelectOption

public void setSelectOption(java.lang.String value)

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Sets the selected 'Select:' option

Specified by:

setSelectOption in interface OLAPTimeBasedFilterAdapterInterface

Parameters:

value - one of OLAPTimeBasedFilterConstants.OTFS_SELECT_RADIO_STARTING_PERIOD_VALUE OLAPTimeBasedFilterConstants.OTFS_SELECT_RADIO_ENDING_PERIOD_VALUE

getStartingPeriodLabel

public java.lang.String getStartingPeriodLabel()

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Returns the localized starting period label for the currently defined period. Examples: "Starting year:", "Starting month:", etc.

Specified by:

getStartingPeriodLabel in interface OLAPTimeBasedFilterAdapterInterface

Returns:

The starting label for the current period

getStartingPeriodOptionsList

public java.util.List getStartingPeriodOptionsList()

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Returns the list of options the user can choose for a starting period. Example either 'The first -period-' or 'Selected -period-'.

Specified by:

getStartingPeriodOptionsList in interface OLAPTimeBasedFilterAdapterInterface

Returns:

a List of String[2] elements where the first String is the localized text and the second String is a unique id associated to the localized text. Example [0] = "The first month" and [1] = "OTFS_STARTING_RADIO_FIRST_PERIOD_VALUE".

getStartingPeriodOption

public java.lang.String getStartingPeriodOption()

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Returns the the currently selected 'Starting -period-:' option

Specified by:

getStartingPeriodOption in interface OLAPTimeBasedFilterAdapterInterface

Returns:

one of OLAPTimeBasedFilterConstants.OTFS_STARTING_RADIO_FIRST_PERIOD_VALUE OLAPTimeBasedFilterConstants.OTFS_STARTING_ENDING_RADIO_SELECTED_PERIOD_VALUE

setStartingPeriodOption

public void setStartingPeriodOption(java.lang.String value)

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Sets the selected 'Starting -period-:' option

Specified by:

setStartingPeriodOption in interface OLAPTimeBasedFilterAdapterInterface

Parameters:

value - one of OLAPTimeBasedFilterConstants.OTFS_STARTING_RADIO_FIRST_PERIOD_VALUE OLAPTimeBasedFilterConstants.OTFS_STARTING_ENDING_RADIO_SELECTED_PERIOD_VALUE

getEndingPeriodLabel

public java.lang.String getEndingPeriodLabel()

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Returns the localized ending period label for the currently defined period. Examples: "Ending year:", "Ending month:", etc.

Specified by:

getEndingPeriodLabel in interface OLAPTimeBasedFilterAdapterInterface

Returns:

The ending label for the current period

getEndingPeriodOptionsList

public java.util.List getEndingPeriodOptionsList()

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Returns the list of options the user can choose for a ending period. Example either 'The last -period-' or 'Selected -period-'.

Specified by:

getEndingPeriodOptionsList in interface OLAPTimeBasedFilterAdapterInterface

Returns:

a List of String[2] elements where the first String is the localized text and the second String is a unique id associated to the localized text. Example [0] = "The last month" and [1] = "OTFS_ENDING_RADIO_LAST_PERIOD_VALUE".

getEndingPeriodOption

public java.lang.String getEndingPeriodOption()

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Returns the the currently selected 'Ending -period-:' option

Specified by:

getEndingPeriodOption in interface OLAPTimeBasedFilterAdapterInterface

Returns:

one of OLAPTimeBasedFilterConstants.OTFS_ENDING_RADIO_LAST_PERIOD_VALUE OLAPTimeBasedFilterConstants.OTFS_STARTING_ENDING_RADIO_SELECTED_PERIOD_VALUE

setEndingPeriodOption

public void setEndingPeriodOption(java.lang.String value)

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Sets the selected 'Ending -period-:' option

Specified by:

setEndingPeriodOption in interface OLAPTimeBasedFilterAdapterInterface

Parameters:

value - one of OLAPTimeBasedFilterConstants.OTFS_ENDING_RADIO_LAST_PERIOD_VALUE OLAPTimeBasedFilterConstants.OTFS_STARTING_ENDING_RADIO_SELECTED_PERIOD_VALUE

getSelectedStartingPeriod

public java.lang.String getSelectedStartingPeriod()

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Returns the value selected in the 'Selected -period-:' TreeView of the 'Starting -period-:' radio box.

Specified by:

getSelectedStartingPeriod in interface OLAPTimeBasedFilterAdapterInterface

Returns:

the value selected in the 'Selected -period-:' TreeView of the 'Starting -period-:' radio box.

getSelectedStartingPeriodLabel

public java.lang.String getSelectedStartingPeriodLabel()

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Returns the label of the value selected in the 'Selected -period-:' TreeView of the 'Starting -period-:' radio box.

Specified by:

getSelectedStartingPeriodLabel in interface OLAPTimeBasedFilterAdapterInterface

Returns:

the label of the value selected in the 'Selected -period-:' TreeView of the 'Starting -period-:' radio box.

setSelectedStartingPeriod

public void setSelectedStartingPeriod(java.lang.String value)

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Sets the value selected in the 'Selected -period-:' TreeView of the 'Starting -period-:' radio box.

Specified by:

setSelectedStartingPeriod in interface OLAPTimeBasedFilterAdapterInterface

Parameters:

value - the value selected in the 'Selected -period-:' TreeView of the 'Starting -period-:' radio box.

setSelectedStartingPeriod

public void setSelectedStartingPeriod(javax.swing.tree.TreeNode treeNode)

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Sets the value selected in the 'Selected -period-:' TreeView of the 'Starting -period-:' radio box.

Specified by:

setSelectedStartingPeriod in interface OLAPTimeBasedFilterAdapterInterface

getSelectedEndingPeriod

public java.lang.String getSelectedEndingPeriod()

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Returns the value selected in the 'Selected -period-:' TreeView of the 'Ending -period-:' radio box.

Specified by:

getSelectedEndingPeriod in interface OLAPTimeBasedFilterAdapterInterface

Returns:

the value selected in the 'Selected -period-:' TreeView of the 'Ending -period-:' radio box.

getSelectedEndingPeriodLabel

public java.lang.String getSelectedEndingPeriodLabel()

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Returns the label of the value selected in the 'Selected -period-:' TreeView of the 'Ending -period-:' radio box.

Specified by:

getSelectedEndingPeriodLabel in interface OLAPTimeBasedFilterAdapterInterface

Returns:

the label of the value selected in the 'Selected -period-:' TreeView of the 'Ending -period-:' radio box.

setSelectedEndingPeriod

public void setSelectedEndingPeriod(java.lang.String value)

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Sets the value selected in the 'Selected -period-:' TreeView of the 'Ending -period-:' radio box.

Specified by:

setSelectedEndingPeriod in interface OLAPTimeBasedFilterAdapterInterface

Parameters:

value - the value selected in the 'Selected -period-:' TreeView of the 'Ending -period-:' radio box.

setSelectedEndingPeriod

public void setSelectedEndingPeriod(javax.swing.tree.TreeNode treeNode)

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Sets the value selected in the 'Selected -period-:' TreeView of the 'Ending -period-:' radio box.

Specified by:

setSelectedEndingPeriod in interface OLAPTimeBasedFilterAdapterInterface

getSelectedPeriods

public java.lang.String[] getSelectedPeriods()

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Returns the values selected in the 'Select -periods-:' TreeView.

Specified by:

getSelectedPeriods in interface OLAPTimeBasedFilterAdapterInterface

Returns:

the values selected in the 'Select -periods-:' TreeView.

setSelectedPeriods

public void setSelectedPeriods(java.lang.String[] values)

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Sets the values selected in the 'Select -periods-:' TreeView.

Specified by:

setSelectedPeriods in interface OLAPTimeBasedFilterAdapterInterface

Parameters:

values - the values selected in the 'Select -periods-:' TreeView.

resetValuesToDefault

public void resetValuesToDefault()

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Resets the values in the adapter to their default.

Specified by:

resetValuesToDefault in interface OLAPTimeBasedFilterAdapterInterface

getDefaultNumberOfPeriods

public java.lang.String getDefaultNumberOfPeriods()

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Returns the default number of periods.

Specified by:

getDefaultNumberOfPeriods in interface OLAPTimeBasedFilterAdapterInterface

Returns:

the default number of periods.

getDefaultShowOption

public java.lang.String getDefaultShowOption()

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Returns the default show option.

Specified by:

getDefaultShowOption in interface OLAPTimeBasedFilterAdapterInterface

Returns:

the default show option.

getDefaultSelectOption

public java.lang.String getDefaultSelectOption()

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Returns the default select option.

Specified by:

getDefaultSelectOption in interface OLAPTimeBasedFilterAdapterInterface

Returns:

the default select option.

getDefaultStartingPeriodOption

public java.lang.String getDefaultStartingPeriodOption()

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Returns the default starting period option.

Specified by:

getDefaultStartingPeriodOption in interface OLAPTimeBasedFilterAdapterInterface

Returns:

the default starting period option.

getDefaultEndingPeriodOption

public java.lang.String getDefaultEndingPeriodOption()

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Returns the default ending period option.

Specified by:

getDefaultEndingPeriodOption in interface OLAPTimeBasedFilterAdapterInterface

Returns:

the default ending period option.

setModified

public void setModified(boolean modified)

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Sets the modified flag.

Specified by:

setModified in interface OLAPTimeBasedFilterAdapterInterface

Parameters:

modified - true if the user explicitally modified the initial values, false otherwise.

isModified

public boolean isModified()

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Returns true if the user explicitally modified the initial values, false otherwise.

Specified by:

isModified in interface OLAPTimeBasedFilterAdapterInterface

Returns:

true if the user explicitally modified the initial values, false otherwise.

clone

public java.lang.Object clone()

Description copied from interface: OLAPTimeBasedFilterAdapterInterface

Returns a duplicate and seperate instance of the implementing object.

Specified by:

clone in interface OLAPTimeBasedFilterAdapterInterface

Overrides:

clone in class java.lang.Object

Returns:

A clone of the object being called upon.