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

com.sas.dataselectors.filters.timebased.olap.OLAPTimeBasedFilterAdapterDataSource

All Implemented Interfaces:

OLAPTimeBasedFilterAdapterDataSourceInterface, java.lang.Cloneable

public class OLAPTimeBasedFilterAdapterDataSource
implements OLAPTimeBasedFilterAdapterDataSourceInterface

Constructor Summary

protected	OLAPTimeBasedFilterAdapterDataSource()
	OLAPTimeBasedFilterAdapterDataSource(com.sas.iquery.metadata.business.BusinessModel model, MetadataInterface md)
	OLAPTimeBasedFilterAdapterDataSource(com.sas.iquery.intelligentquery.BusinessQueryProviderInterface model)
	OLAPTimeBasedFilterAdapterDataSource(FilterBaseModelData baseModel)

Method Summary

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

Constructor Detail

OLAPTimeBasedFilterAdapterDataSource

protected OLAPTimeBasedFilterAdapterDataSource()

OLAPTimeBasedFilterAdapterDataSource

public OLAPTimeBasedFilterAdapterDataSource(FilterBaseModelData baseModel)

OLAPTimeBasedFilterAdapterDataSource

public OLAPTimeBasedFilterAdapterDataSource(com.sas.iquery.intelligentquery.BusinessQueryProviderInterface model)

OLAPTimeBasedFilterAdapterDataSource

public OLAPTimeBasedFilterAdapterDataSource(com.sas.iquery.metadata.business.BusinessModel model,
                                            MetadataInterface md)

Method Detail

getMetadataInterface

protected MetadataInterface getMetadataInterface()

releaseResources

public void releaseResources()

setCubeName

protected void setCubeName(java.lang.Object model)

setDataItem

public void setDataItem(java.lang.Object dataItem)

Specified by:

setDataItem in interface OLAPTimeBasedFilterAdapterDataSourceInterface

getCurrentFirstPeriod

public java.lang.String getCurrentFirstPeriod()

Specified by:

getCurrentFirstPeriod in interface OLAPTimeBasedFilterAdapterDataSourceInterface

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.

getCurrentLastPeriod

public java.lang.String getCurrentLastPeriod()

Specified by:

getCurrentLastPeriod in interface OLAPTimeBasedFilterAdapterDataSourceInterface

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.

getCurrentFirstPeriodLabel

public java.lang.String getCurrentFirstPeriodLabel()

Specified by:

getCurrentFirstPeriodLabel in interface OLAPTimeBasedFilterAdapterDataSourceInterface

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.

getCurrentLastPeriodLabel

public java.lang.String getCurrentLastPeriodLabel()

Specified by:

getCurrentLastPeriodLabel in interface OLAPTimeBasedFilterAdapterDataSourceInterface

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.

setPeriodType

public void setPeriodType(java.lang.String periodType)

Description copied from interface: OLAPTimeBasedFilterAdapterDataSourceInterface

Sets the period type

Specified by:

setPeriodType in interface OLAPTimeBasedFilterAdapterDataSourceInterface

Parameters:

periodType - the period type

getPeriodType

public java.lang.String getPeriodType()

Description copied from interface: OLAPTimeBasedFilterAdapterDataSourceInterface

Returns the period type currently selected

Specified by:

getPeriodType in interface OLAPTimeBasedFilterAdapterDataSourceInterface

Returns:

something like

getPeriodType

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

Description copied from interface: OLAPTimeBasedFilterAdapterDataSourceInterface

Returns the period type related to a specific uniqueDateMemberName

Specified by:

getPeriodType in interface OLAPTimeBasedFilterAdapterDataSourceInterface

Returns:

something like

getPeriodLevelType

public int getPeriodLevelType(java.lang.String uniqueDateLevelName)

Description copied from interface: OLAPTimeBasedFilterAdapterDataSourceInterface

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

Specified by:

getPeriodLevelType in interface OLAPTimeBasedFilterAdapterDataSourceInterface

Returns:

something like

getPeriodTypes

public java.util.List getPeriodTypes()

Description copied from interface: OLAPTimeBasedFilterAdapterDataSourceInterface

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

Specified by:

getPeriodTypes in interface OLAPTimeBasedFilterAdapterDataSourceInterface

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

getStartTreeModel

public javax.swing.tree.TreeModel getStartTreeModel()

Specified by:

getStartTreeModel in interface OLAPTimeBasedFilterAdapterDataSourceInterface

Returns:

return the model for the 'Starting xx' TreeView

getEndTreeModel

public javax.swing.tree.TreeModel getEndTreeModel()

Specified by:

getEndTreeModel in interface OLAPTimeBasedFilterAdapterDataSourceInterface

Returns:

return the model for the 'Ending xx' TreeView

getPeriodTypeLabels

public java.util.List getPeriodTypeLabels()

Description copied from interface: OLAPTimeBasedFilterAdapterDataSourceInterface

Returns the periodType labels

Specified by:

getPeriodTypeLabels in interface OLAPTimeBasedFilterAdapterDataSourceInterface

Returns:

a list of periodTypeLabels

getLabel

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

Specified by:

getLabel in interface OLAPTimeBasedFilterAdapterDataSourceInterface

clone

public java.lang.Object clone()

Description copied from interface: OLAPTimeBasedFilterAdapterDataSourceInterface

Returns a duplicate and seperate instance of the implementing object.

Specified by:

clone in interface OLAPTimeBasedFilterAdapterDataSourceInterface

Overrides:

clone in class java.lang.Object

Returns:

A clone of the object being called upon.