|
Components |
|
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
com.sas.dataselectors.filters.timebased.olap.OLAPTimeBasedFilterAdapter
public class OLAPTimeBasedFilterAdapter
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 |
---|
public static final java.lang.String RB_KEY
public static int MINIMUM_N_PERIOD_VALUE
public static int DEFAULT_PERIOD_TYPE_INDEX
Constructor Detail |
---|
public OLAPTimeBasedFilterAdapter(OLAPTimeBasedFilterAdapterDataSourceInterface model)
Method Detail |
---|
public void setDataItem(java.lang.Object dataItem)
TimeBasedFilterAdapterInterface
setDataItem
in interface TimeBasedFilterAdapterInterface
setDataItem
in class TimeBasedFilterAdapter
dataItem
- the data item the time based filter is working with.
It's a or belongs to a 'Time' dimensionpublic void setRuntime(boolean runtime)
runtime
- Set to true to indicate runtime, false to indicate design-timepublic boolean isRuntime()
public java.lang.Object getPropertiesBean()
Required to satisfy the SelectorCommitInterface but not used in this implementation.
getPropertiesBean
in interface SelectorCommitInterface
SelectorCommitInterface
public java.util.Map commit()
Required to satisfy the SelectorCommitInterface
commit
in interface SelectorCommitInterface
public void setLocale(java.util.Locale locale)
OLAPTimeBasedFilterAdapterInterface
setLocale
in interface OLAPTimeBasedFilterAdapterInterface
locale
- The locale.public java.util.Locale getLocale()
OLAPTimeBasedFilterAdapterInterface
getLocale
in interface OLAPTimeBasedFilterAdapterInterface
public void setFilterExpression(java.lang.Object filterExpr)
OLAPTimeBasedFilterAdapterInterface
setFilterExpression
in interface OLAPTimeBasedFilterAdapterInterface
filterExpr
- A filter expression to associate with the adapter.public java.lang.Object getFilterExpression()
OLAPTimeBasedFilterAdapterInterface
getFilterExpression
in interface OLAPTimeBasedFilterAdapterInterface
public void setFilterStep(java.lang.Object step)
OLAPTimeBasedFilterAdapterInterface
setFilterStep
in interface OLAPTimeBasedFilterAdapterInterface
step
- the filter step associated with the adapter.public java.util.List getPeriodTypes()
OLAPTimeBasedFilterAdapterInterface
getPeriodTypes
in interface OLAPTimeBasedFilterAdapterInterface
public java.util.List getShowOptionsList()
OLAPTimeBasedFilterAdapterInterface
getShowOptionsList
in interface OLAPTimeBasedFilterAdapterInterface
public java.util.List getFullShowOptionsList()
OLAPTimeBasedFilterAdapterInterface
getFullShowOptionsList
in interface OLAPTimeBasedFilterAdapterInterface
public java.lang.String getShowOption()
OLAPTimeBasedFilterAdapterInterface
getShowOption
in interface OLAPTimeBasedFilterAdapterInterface
OLAPTimeBasedFilterConstants.OTFS_SHOW_RADIO_N_PERIODS_VALUE
OLAPTimeBasedFilterConstants.OTFS_SHOW_RADIO_ACROSS_VALUE
OLAPTimeBasedFilterConstants.OTFS_SHOW_RADIO_RANGE_OF_PERIODS_VALUE
public void setShowOption(java.lang.String value)
OLAPTimeBasedFilterAdapterInterface
setShowOption
in interface OLAPTimeBasedFilterAdapterInterface
value
- one of
OLAPTimeBasedFilterConstants.OTFS_SHOW_RADIO_N_PERIODS_VALUE
OLAPTimeBasedFilterConstants.OTFS_SHOW_RADIO_ACROSS_VALUE
OLAPTimeBasedFilterConstants.OTFS_SHOW_RADIO_RANGE_OF_PERIODS_VALUE
public java.lang.String getNumberOfPeriods()
OLAPTimeBasedFilterAdapterInterface
getNumberOfPeriods
in interface OLAPTimeBasedFilterAdapterInterface
public void setNumberOfPeriods(java.lang.String value)
OLAPTimeBasedFilterAdapterInterface
setNumberOfPeriods
in interface OLAPTimeBasedFilterAdapterInterface
value
- the number of periodspublic java.lang.String getLocalizedSelectLabelParameter()
getLocalizedSelectLabelParameter
in interface OLAPTimeBasedFilterAdapterInterface
public java.lang.String getLocalizedNPeriodsLabelParameter()
getLocalizedNPeriodsLabelParameter
in interface OLAPTimeBasedFilterAdapterInterface
public java.lang.String getLocalizedAcrossLabelFirstParameter()
getLocalizedAcrossLabelFirstParameter
in interface OLAPTimeBasedFilterAdapterInterface
public java.lang.String getLocalizedAcrossLabelSecondParameter()
getLocalizedAcrossLabelSecondParameter
in interface OLAPTimeBasedFilterAdapterInterface
public java.lang.String getLocalizedRangeLabelParameter()
getLocalizedRangeLabelParameter
in interface OLAPTimeBasedFilterAdapterInterface
public java.lang.String getLocalizedPeriodType()
getLocalizedPeriodType
in interface OLAPTimeBasedFilterAdapterInterface
public java.util.List getSelectablePeriods()
OLAPTimeBasedFilterAdapterInterface
getSelectablePeriods
in interface OLAPTimeBasedFilterAdapterInterface
public java.lang.String getCurrentFirstPeriod()
getCurrentFirstPeriod
in interface OLAPTimeBasedFilterAdapterInterface
public java.lang.String getCurrentFirstPeriodLabel()
getCurrentFirstPeriodLabel
in interface OLAPTimeBasedFilterAdapterInterface
public java.lang.String getCurrentLastPeriod()
getCurrentLastPeriod
in interface OLAPTimeBasedFilterAdapterInterface
public java.lang.String getCurrentLastPeriodLabel()
getCurrentLastPeriodLabel
in interface OLAPTimeBasedFilterAdapterInterface
public javax.swing.tree.TreeModel getStartTreeModel()
getStartTreeModel
in interface OLAPTimeBasedFilterAdapterInterface
public javax.swing.tree.TreeModel getEndTreeModel()
getEndTreeModel
in interface OLAPTimeBasedFilterAdapterInterface
public void setPanelVisible(boolean visible)
OLAPTimeBasedFilterAdapterInterface
setPanelVisible
in interface OLAPTimeBasedFilterAdapterInterface
visible
- true if the OLAPTimeBasedFilterSelectorPanel should be displayed, false otherwisepublic boolean isPanelVisible()
isPanelVisible
in interface OLAPTimeBasedFilterAdapterInterface
public int getPeriodType(java.lang.String uniquePeriodName)
OLAPTimeBasedFilterAdapterInterface
getPeriodType
in interface OLAPTimeBasedFilterAdapterInterface
uniquePeriodName
- A string representing the unique name of the period to query.
public java.lang.String getPeriodType()
OLAPTimeBasedFilterAdapterInterface
getPeriodType
in interface OLAPTimeBasedFilterAdapterInterface
public void setPeriodType(java.lang.String value)
OLAPTimeBasedFilterAdapterInterface
setPeriodType
in interface OLAPTimeBasedFilterAdapterInterface
value
- the period typepublic java.util.List getSelectOptionsList()
OLAPTimeBasedFilterAdapterInterface
getSelectOptionsList
in interface OLAPTimeBasedFilterAdapterInterface
public java.lang.String getSelectOption()
OLAPTimeBasedFilterAdapterInterface
getSelectOption
in interface OLAPTimeBasedFilterAdapterInterface
OLAPTimeBasedFilterConstants.OTFS_SELECT_RADIO_STARTING_PERIOD_VALUE
OLAPTimeBasedFilterConstants.OTFS_SELECT_RADIO_ENDING_PERIOD_VALUE
public void setSelectOption(java.lang.String value)
OLAPTimeBasedFilterAdapterInterface
setSelectOption
in interface OLAPTimeBasedFilterAdapterInterface
value
- one of
OLAPTimeBasedFilterConstants.OTFS_SELECT_RADIO_STARTING_PERIOD_VALUE
OLAPTimeBasedFilterConstants.OTFS_SELECT_RADIO_ENDING_PERIOD_VALUE
public java.lang.String getStartingPeriodLabel()
OLAPTimeBasedFilterAdapterInterface
getStartingPeriodLabel
in interface OLAPTimeBasedFilterAdapterInterface
public java.util.List getStartingPeriodOptionsList()
OLAPTimeBasedFilterAdapterInterface
getStartingPeriodOptionsList
in interface OLAPTimeBasedFilterAdapterInterface
public java.lang.String getStartingPeriodOption()
OLAPTimeBasedFilterAdapterInterface
getStartingPeriodOption
in interface OLAPTimeBasedFilterAdapterInterface
OLAPTimeBasedFilterConstants.OTFS_STARTING_RADIO_FIRST_PERIOD_VALUE
OLAPTimeBasedFilterConstants.OTFS_STARTING_ENDING_RADIO_SELECTED_PERIOD_VALUE
public void setStartingPeriodOption(java.lang.String value)
OLAPTimeBasedFilterAdapterInterface
setStartingPeriodOption
in interface OLAPTimeBasedFilterAdapterInterface
value
- one of
OLAPTimeBasedFilterConstants.OTFS_STARTING_RADIO_FIRST_PERIOD_VALUE
OLAPTimeBasedFilterConstants.OTFS_STARTING_ENDING_RADIO_SELECTED_PERIOD_VALUE
public java.lang.String getEndingPeriodLabel()
OLAPTimeBasedFilterAdapterInterface
getEndingPeriodLabel
in interface OLAPTimeBasedFilterAdapterInterface
public java.util.List getEndingPeriodOptionsList()
OLAPTimeBasedFilterAdapterInterface
getEndingPeriodOptionsList
in interface OLAPTimeBasedFilterAdapterInterface
public java.lang.String getEndingPeriodOption()
OLAPTimeBasedFilterAdapterInterface
getEndingPeriodOption
in interface OLAPTimeBasedFilterAdapterInterface
OLAPTimeBasedFilterConstants.OTFS_ENDING_RADIO_LAST_PERIOD_VALUE
OLAPTimeBasedFilterConstants.OTFS_STARTING_ENDING_RADIO_SELECTED_PERIOD_VALUE
public void setEndingPeriodOption(java.lang.String value)
OLAPTimeBasedFilterAdapterInterface
setEndingPeriodOption
in interface OLAPTimeBasedFilterAdapterInterface
value
- one of
OLAPTimeBasedFilterConstants.OTFS_ENDING_RADIO_LAST_PERIOD_VALUE
OLAPTimeBasedFilterConstants.OTFS_STARTING_ENDING_RADIO_SELECTED_PERIOD_VALUE
public java.lang.String getSelectedStartingPeriod()
OLAPTimeBasedFilterAdapterInterface
getSelectedStartingPeriod
in interface OLAPTimeBasedFilterAdapterInterface
public java.lang.String getSelectedStartingPeriodLabel()
OLAPTimeBasedFilterAdapterInterface
getSelectedStartingPeriodLabel
in interface OLAPTimeBasedFilterAdapterInterface
public void setSelectedStartingPeriod(java.lang.String value)
OLAPTimeBasedFilterAdapterInterface
setSelectedStartingPeriod
in interface OLAPTimeBasedFilterAdapterInterface
value
- the value selected in the 'Selected -period-:' TreeView of the 'Starting -period-:' radio box.public void setSelectedStartingPeriod(javax.swing.tree.TreeNode treeNode)
OLAPTimeBasedFilterAdapterInterface
setSelectedStartingPeriod
in interface OLAPTimeBasedFilterAdapterInterface
public java.lang.String getSelectedEndingPeriod()
OLAPTimeBasedFilterAdapterInterface
getSelectedEndingPeriod
in interface OLAPTimeBasedFilterAdapterInterface
public java.lang.String getSelectedEndingPeriodLabel()
OLAPTimeBasedFilterAdapterInterface
getSelectedEndingPeriodLabel
in interface OLAPTimeBasedFilterAdapterInterface
public void setSelectedEndingPeriod(java.lang.String value)
OLAPTimeBasedFilterAdapterInterface
setSelectedEndingPeriod
in interface OLAPTimeBasedFilterAdapterInterface
value
- the value selected in the 'Selected -period-:' TreeView of the 'Ending -period-:' radio box.public void setSelectedEndingPeriod(javax.swing.tree.TreeNode treeNode)
OLAPTimeBasedFilterAdapterInterface
setSelectedEndingPeriod
in interface OLAPTimeBasedFilterAdapterInterface
public java.lang.String[] getSelectedPeriods()
OLAPTimeBasedFilterAdapterInterface
getSelectedPeriods
in interface OLAPTimeBasedFilterAdapterInterface
public void setSelectedPeriods(java.lang.String[] values)
OLAPTimeBasedFilterAdapterInterface
setSelectedPeriods
in interface OLAPTimeBasedFilterAdapterInterface
values
- the values selected in the 'Select -periods-:' TreeView.public void resetValuesToDefault()
OLAPTimeBasedFilterAdapterInterface
resetValuesToDefault
in interface OLAPTimeBasedFilterAdapterInterface
public java.lang.String getDefaultNumberOfPeriods()
OLAPTimeBasedFilterAdapterInterface
getDefaultNumberOfPeriods
in interface OLAPTimeBasedFilterAdapterInterface
public java.lang.String getDefaultShowOption()
OLAPTimeBasedFilterAdapterInterface
getDefaultShowOption
in interface OLAPTimeBasedFilterAdapterInterface
public java.lang.String getDefaultSelectOption()
OLAPTimeBasedFilterAdapterInterface
getDefaultSelectOption
in interface OLAPTimeBasedFilterAdapterInterface
public java.lang.String getDefaultStartingPeriodOption()
OLAPTimeBasedFilterAdapterInterface
getDefaultStartingPeriodOption
in interface OLAPTimeBasedFilterAdapterInterface
public java.lang.String getDefaultEndingPeriodOption()
OLAPTimeBasedFilterAdapterInterface
getDefaultEndingPeriodOption
in interface OLAPTimeBasedFilterAdapterInterface
public void setModified(boolean modified)
OLAPTimeBasedFilterAdapterInterface
setModified
in interface OLAPTimeBasedFilterAdapterInterface
modified
- true if the user explicitally modified the initial values, false otherwise.public boolean isModified()
OLAPTimeBasedFilterAdapterInterface
isModified
in interface OLAPTimeBasedFilterAdapterInterface
public java.lang.Object clone()
OLAPTimeBasedFilterAdapterInterface
clone
in interface OLAPTimeBasedFilterAdapterInterface
clone
in class java.lang.Object
|
Components |
|
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |