***  This class is subject to change.  ***

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 can filter based where either the start or end (or both) members are relative. An example would be something like this:

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.Base
EVENT_OBJECT_DEFINITION_CHANGED
 
Fields inherited from interface com.sas.iquery.metadata.business.ModelItem
EVENT_OBJECT_PROPERTY_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

***  This field is subject to change.  ***

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(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
Method Detail

setRangePrompt

public void setRangePrompt(Prompt rangePrompt)
                    throws java.lang.IllegalArgumentException
Set range prompt

Throws:
java.lang.IllegalArgumentException

getRangePrompt

public Prompt getRangePrompt()
Get range prompt


***  This class is subject to change.  ***




Copyright © 2009 SAS Institute Inc. All Rights Reserved.