com.sas.iquery.metadata.business.step.olap
Class PromptedTimeRangeFilter

com.sas.iquery.metadata.business.step.olap.PromptedTimeRangeFilter

All Implemented Interfaces:

Base, BusinessModelResourceReferencer, ModelItem, StepFilterInterface, StepInterface, UsabilityInterface, PropertyChangeListenee, com.sas.util.LocalizableToStringInterface, java.beans.PropertyChangeListener, java.lang.Cloneable, java.util.EventListener

public class PromptedTimeRangeFilter

A prompted step that filters a data item based on start and end date period or relative start or end member(s). An example would be something like this:

• Years (all) from the first year (currently 2000) to the last year (currently 2005).
• All years from the first relative year to a specific end year (such as 2003).
• All years from a specific start year (such as 2001) to the relative end year.

See Also:

StepFilterInterface, BaseFilter

Field Summary

static java.lang.String

EVENT_RANGE_PROMPT_MEMBER_CHANGED Indication that the range prompt has been changed

Fields inherited from class com.sas.iquery.metadata.business.step.olap.BaseFilter

EVENT_ACTION_TYPE_CHANGED, EVENT_LOCALIZABLE_LABELS_CHANGED

Fields inherited from interface com.sas.iquery.metadata.business.step.StepFilterInterface

APPEND_ACTION_TYPE, DIFFERENCE_ACTION_TYPE, INITIAL_ACTION_TYPE, INSERT_ACTION_TYPE, INTERSECT_ACTION_TYPE, PREPEND_ACTION_TYPE, SPECIAL_ACTION_TYPE, UNION_ACTION_TYPE

Fields inherited from interface com.sas.iquery.metadata.business.ModelItem

EVENT_OBJECT_PROPERTY_CHANGED

Fields inherited from interface com.sas.iquery.metadata.business.Base

EVENT_OBJECT_DEFINITION_CHANGED

Constructor Summary

PromptedTimeRangeFilter()
No-argument constructor.

PromptedTimeRangeFilter(Prompt rangePrompt)
Create a filter to return a specific range of members.

Method Summary

Prompt	getRangePrompt() Get range prompt
void	setRangePrompt(Prompt rangePrompt) Set range prompt

Methods inherited from class com.sas.iquery.metadata.business.step.olap.BaseFilter

getActionType, getDisplayedText, getLevels, setActionType

Methods inherited from interface com.sas.iquery.metadata.business.BusinessModelResourceReferencer

getResources

Methods inherited from interface com.sas.iquery.metadata.PropertyChangeListenee

addListener, getListeners, removeListener

Methods inherited from interface com.sas.iquery.metadata.business.UsabilityInterface

getReasonsUnusable, isUsableInQuery

Field Detail

EVENT_RANGE_PROMPT_MEMBER_CHANGED

public static final java.lang.String EVENT_RANGE_PROMPT_MEMBER_CHANGED

Indication that the range prompt has been changed

See Also:

Constant Field Values

Constructor Detail

PromptedTimeRangeFilter

public PromptedTimeRangeFilter()

No-argument constructor.

PromptedTimeRangeFilter

public PromptedTimeRangeFilter(@Nonnull
                               Prompt rangePrompt)

Create a filter to return a specific range of members. Range can represent periods to date for a selected time level. In the PTD case, ending period is the most recent member in the cube at the selected level. Opening period is the descendant at the same level whose level 1 ancestor is the same as the ending period's. So in this implementation, periods to date are returned as a rangeExample: If user selects Quarter and the most recent Quarter entered is Q3 2004, opening period will be Q1 2004.

Parameters:

rangePrompt - a range prompt for selecting start and end date members

Throws:

java.lang.IllegalArgumentException - if the rangePrompt is null

Method Detail

setRangePrompt

public void setRangePrompt(@Nonnull
                           Prompt rangePrompt)
                    throws java.lang.IllegalArgumentException

Set range prompt

Throws:

java.lang.IllegalArgumentException - if the rangePrompt is null

getRangePrompt

public Prompt getRangePrompt()

Get range prompt