com.sas.dataselectors.filters.timebased.olap
Interface OLAPTimeBasedFilterAdapterDataSourceInterface

All Superinterfaces:

java.lang.Cloneable

All Known Implementing Classes:

OLAPTimeBasedFilterAdapterDataSource

@SASScope(value="ALL")
public interface OLAPTimeBasedFilterAdapterDataSourceInterface
extends java.lang.Cloneable

Method Summary

abstract java.lang.Object	clone() Returns a duplicate and seperate instance of the implementing object.
abstract java.lang.String	getCurrentFirstPeriod()
abstract java.lang.String	getCurrentFirstPeriodLabel()
abstract java.lang.String	getCurrentLastPeriod()
abstract java.lang.String	getCurrentLastPeriodLabel()
abstract javax.swing.tree.TreeModel	getEndTreeModel()
abstract java.lang.String	getLabel(java.lang.String uniqueMemberName)
abstract int	getPeriodLevelType(java.lang.String uniqueDateMemberName) Returns the period's level type related to a specific uniqueDateMemberName
abstract java.lang.String	getPeriodType() Returns the period type currently selected
abstract java.lang.String	getPeriodType(java.lang.String uniqueDateMemberName) Returns the period type related to a specific uniqueDateMemberName
abstract java.util.List	getPeriodTypeLabels() Returns the periodType labels
abstract java.util.List	getPeriodTypes() Returns the list of period types which the user can choose from
abstract javax.swing.tree.TreeModel	getStartTreeModel()
abstract void	setDataItem(java.lang.Object dataitem)
abstract void	setPeriodType(java.lang.String value) Sets the period type

Method Detail

setDataItem

void setDataItem(java.lang.Object dataitem)

getPeriodTypes

java.util.List getPeriodTypes()

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

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".

getPeriodTypeLabels

java.util.List getPeriodTypeLabels()

Returns the periodType labels

Returns:

a list of periodTypeLabels

getPeriodType

java.lang.String getPeriodType()

Returns the period type currently selected

Returns:

something like

getPeriodType

java.lang.String getPeriodType(java.lang.String uniqueDateMemberName)

Returns the period type related to a specific uniqueDateMemberName

Returns:

something like

setPeriodType

void setPeriodType(java.lang.String value)

Sets the period type

Parameters:

value - the period type

getPeriodLevelType

int getPeriodLevelType(java.lang.String uniqueDateMemberName)

Returns the period's level type related to a specific uniqueDateMemberName

Returns:

something like

getStartTreeModel

javax.swing.tree.TreeModel getStartTreeModel()

Returns:

return the model for the 'Starting xx' TreeView

getEndTreeModel

javax.swing.tree.TreeModel getEndTreeModel()

Returns:

return the model for the 'Ending xx' TreeView

getCurrentFirstPeriod

java.lang.String getCurrentFirstPeriod()

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

java.lang.String getCurrentFirstPeriodLabel()

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

java.lang.String getCurrentLastPeriod()

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

java.lang.String getCurrentLastPeriodLabel()

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.

getLabel

java.lang.String getLabel(java.lang.String uniqueMemberName)

clone

java.lang.Object clone()

Returns a duplicate and seperate instance of the implementing object.

Returns:

A clone of the object being called upon.