|
Query |
|
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
com.sas.iquery.metadata.expr.olap.TimeFilterExpression
public abstract class TimeFilterExpression
Models an expression that filters a data item based on time members and time function arguments submitted. It is the superclass for all time-based filtering operations.
See the ConditionalExpression
class for a description of the organization of
of ConditionalExpression classes.
com.sas.iquery.metadata.business.step.olap.DataTimeFilter
Field Summary | |
---|---|
static java.lang.String |
BACKWARD
This indicates a search direction of filtering going backward in time. |
static java.lang.String |
EVENT_NPERIODS_CHANGED
Deprecated. use EVENT_PERIODS_CHANGED |
static java.lang.String |
EVENT_PERIODS_CHANGED
Indicates a change in number of periods |
static java.lang.String |
EVENT_SEARCH_DIRECTION_CHANGED
Change Event Message Strings |
static java.lang.String |
FORWARD
This indicates a search direction of filtering going forward in time. |
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 | |
---|---|
TimeFilterExpression()
|
Method Summary | |
---|---|
java.lang.String |
getMemberLevelRoot()
Get the highest member level in the member that has been selected. |
int |
getnPeriods()
Deprecated. use getPeriods |
ExpressionInterface |
getPeriods()
Get number of periods |
java.lang.String |
getSearchDirection()
Get search direction |
boolean |
isNegated()
ConditionalExpression which is inherited by this class has a isNegated. |
void |
setIsNegated(boolean flag)
ConditionalExpression which is inherited by this class has a isNegated. |
void |
setnPeriods(int nPeriods)
Deprecated. use setPeriods |
void |
setPeriods(ExpressionInterface periods)
Set number of periods to return (negative values are not allowed) |
void |
setSearchDirection(java.lang.String searchDirection)
Set which direction to retrieve members |
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 |
---|
public static final java.lang.String EVENT_SEARCH_DIRECTION_CHANGED
public static final java.lang.String EVENT_PERIODS_CHANGED
public static final java.lang.String EVENT_NPERIODS_CHANGED
public static final java.lang.String FORWARD
public static final java.lang.String BACKWARD
Constructor Detail |
---|
public TimeFilterExpression()
Method Detail |
---|
public void setnPeriods(int nPeriods)
nPeriods
- number of periods being return in query.public java.lang.String getMemberLevelRoot()
public void setPeriods(ExpressionInterface periods)
periods
- number of periods being return in query.public boolean isNegated()
isNegated
in class ConditionalExpression
public void setIsNegated(boolean flag)
setIsNegated
in class ConditionalExpression
flag
- boolean indicating if this expression is negatedpublic void setSearchDirection(java.lang.String searchDirection) throws java.lang.IllegalArgumentException
set
- path of processing - either BACKWARD or FORWARD in time
java.lang.IllegalArgumentException
public int getnPeriods()
public ExpressionInterface getPeriods()
public java.lang.String getSearchDirection()
|
Query |
|
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |