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

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

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

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 DataItemTimeRangeFilter

A 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:

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

Field Summary

static java.lang.String	EVENT_END_DATE_MEMBER_CHANGED Indication that end date has been changed
static java.lang.String	EVENT_START_DATE_MEMBER_CHANGED Indication that start date 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

DataItemTimeRangeFilter()
No-argument constructor.

DataItemTimeRangeFilter(ExpressionInterface startDateMember, ExpressionInterface endDateMember)
Create a filter to return a specific range of members.

DataItemTimeRangeFilter(java.lang.String startDateMember, java.lang.String endDateMember)
Deprecated. use DataItemTimeRangeFilter(ExpressionInterface, ExpressionInterface)

Method Summary

java.lang.String	getEndDateMember() Deprecated. use getEndMember
ExpressionInterface	getEndMember() Get the end date as an expression interface
java.util.Locale	getMemberLocale() Get the locale that is associated with the member names for this step.
java.lang.String	getStartDateMember() Deprecated. use getStartMember
ExpressionInterface	getStartMember() Get the start date as an expression interface
void	setEndDateMember(java.lang.String endDateMember) Deprecated. use setEndMember(ExpressionInterface)
void	setEndMember(ExpressionInterface endDateMember) Set the end date member for this filter
void	setStartDateMember(java.lang.String startDateMember) Deprecated. use setStartMember(ExpressionInterface)
void	setStartMember(ExpressionInterface startDateMember) Set the start date member for this filter

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_START_DATE_MEMBER_CHANGED

public static final java.lang.String EVENT_START_DATE_MEMBER_CHANGED

Indication that start date has been changed

See Also:

Constant Field Values

EVENT_END_DATE_MEMBER_CHANGED

public static final java.lang.String EVENT_END_DATE_MEMBER_CHANGED

Indication that end date has been changed

See Also:

Constant Field Values

Constructor Detail

DataItemTimeRangeFilter

public DataItemTimeRangeFilter()

No-argument constructor.

DataItemTimeRangeFilter

@Deprecated
public DataItemTimeRangeFilter(java.lang.String startDateMember,
                                          java.lang.String endDateMember)
                        throws java.lang.IllegalArgumentException

Deprecated. use DataItemTimeRangeFilter(ExpressionInterface, ExpressionInterface)

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:

startDateMember -

endDateMember -

Throws:

java.lang.IllegalArgumentException - if the start or end date member is null

DataItemTimeRangeFilter

public DataItemTimeRangeFilter(ExpressionInterface startDateMember,
                               ExpressionInterface endDateMember)
                        throws java.lang.IllegalArgumentException

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:

startDateMember -

endDateMember -

Throws:

java.lang.IllegalArgumentException - if the start or end date member is null

Method Detail

setStartDateMember

@Deprecated
public void setStartDateMember(@Nonnull
                                          java.lang.String startDateMember)
                        throws java.lang.IllegalArgumentException

Deprecated. use setStartMember(ExpressionInterface)

Set the start date for this filter

Throws:

java.lang.IllegalArgumentException - if the start date member is null

getMemberLocale

public java.util.Locale getMemberLocale()

Get the locale that is associated with the member names for this step.

Returns:

setEndDateMember

@Deprecated
public void setEndDateMember(@Nonnull
                                        java.lang.String endDateMember)
                      throws java.lang.IllegalArgumentException

Deprecated. use setEndMember(ExpressionInterface)

Set the end date for this filter

Throws:

java.lang.IllegalArgumentException - if the end date member is null

setStartMember

public void setStartMember(@Nonnull
                           ExpressionInterface startDateMember)
                    throws java.lang.IllegalArgumentException

Set the start date member for this filter

Throws:

java.lang.IllegalArgumentException - if the start date member is null

setEndMember

public void setEndMember(@Nonnull
                         ExpressionInterface endDateMember)
                  throws java.lang.IllegalArgumentException

Set the end date member for this filter

Throws:

java.lang.IllegalArgumentException - if the end date member is null

getStartDateMember

@Deprecated
public java.lang.String getStartDateMember()

Deprecated. use getStartMember

Get the start date as a string

getEndDateMember

@Deprecated
public java.lang.String getEndDateMember()

Deprecated. use getEndMember

Get the end date as a string

getStartMember

public ExpressionInterface getStartMember()

Get the start date as an expression interface

getEndMember

public ExpressionInterface getEndMember()

Get the end date as an expression interface

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