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

com.sas.iquery.metadata.expr.olap
Class TimeRangeFilterExpression

com.sas.iquery.metadata.expr.olap.TimeRangeFilterExpression

All Implemented Interfaces:

Base, BusinessModelResourceReferencer, ModelItem, UsabilityInterface, ExpressionInterface, PropertyChangeListenee, java.beans.PropertyChangeListener, java.lang.Cloneable, java.util.EventListener

public class TimeRangeFilterExpression

Models an expression 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 specifc end year (such as 2003).
• All years from a specific start year (such as 2001) to the relative end year.

See the ConditionalExpression class for a description of the organization of of ConditionalExpression classes.

See Also:

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

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.expr.olap.BaseFilterExpression

EVENT_WHAT_TO_COMPARE_CHANGED

Fields inherited from class com.sas.iquery.metadata.expr.ConditionalExpression

EVENT_NEGATION_CHANGED

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

TimeRangeFilterExpression()
No-argument constructor.

Method Summary

java.lang.String	getEndDateMember() Deprecated. use getEndMember
ExpressionInterface	getEndMember() Get end date
java.lang.String	getMemberLevelRoot() Get the highest member level in the member that has been selected.
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 start date
boolean	isNegated() ConditionalExpression which is inherited by this class has a isNegated.
void	setEndDateMember(java.lang.String endDateMember) Deprecated. use setEndMember
void	setEndMember(ExpressionInterface endDateMember) Set end date member
void	setIsNegated(boolean flag) ConditionalExpression which is inherited by this class has a isNegated.
void	setStartDateMember(java.lang.String startDateMember) Deprecated. use setStartMember
void	setStartMember(ExpressionInterface startDateMember) Set start date member

Methods inherited from class com.sas.iquery.metadata.expr.olap.BaseFilterExpression

getDisplayedText, getLevels, getWhatToCompare, setWhatToCompare

Methods inherited from class com.sas.iquery.metadata.expr.ConditionalExpression

getExpressionType

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

*** This constructor is subject to change. ***

TimeRangeFilterExpression

public TimeRangeFilterExpression()

No-argument constructor.

Method Detail

*** This method is subject to change. ***

getStartDateMember

public java.lang.String getStartDateMember()

Deprecated. use getStartMember

Get start date

*** This method is subject to change. ***

getEndDateMember

public java.lang.String getEndDateMember()

Deprecated. use getEndMember

Get end date

*** This method is subject to change. ***

getStartMember

public ExpressionInterface getStartMember()

Get start date

*** This method is subject to change. ***

getEndMember

public ExpressionInterface getEndMember()

Get end date

*** This method is subject to change. ***

isNegated

public boolean isNegated()

ConditionalExpression which is inherited by this class has a isNegated. However, this class does not use negation, therefore this overridden method will always return false.

Overrides:

isNegated in class ConditionalExpression

Returns:

whether expression is negated

*** This method is subject to change. ***

setIsNegated

public void setIsNegated(boolean flag)

ConditionalExpression which is inherited by this class has a isNegated. However, this class does not use negation, therefore this method is not supported

Overrides:

setIsNegated in class ConditionalExpression

Parameters:

flag - boolean indicating if this expression is negated

*** This method is subject to change. ***

getMemberLevelRoot

public java.lang.String getMemberLevelRoot()

Get the highest member level in the member that has been selected.

Returns:

memberLevelRoot

setStartDateMember

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

Deprecated. use setStartMember

Set start date

Parameters:

startDateMember - - start date in range.

Throws:

java.lang.IllegalArgumentException

setEndDateMember

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

Deprecated. use setEndMember

Set end date

Parameters:

endDateMember - - end date in range.

Throws:

java.lang.IllegalArgumentException

setStartMember

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

Set start date member

Throws:

java.lang.IllegalArgumentException

setEndMember

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

Set end date member

Throws:

java.lang.IllegalArgumentException

getMemberLocale

public java.util.Locale getMemberLocale()

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

Returns:

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