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

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

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 DataItemTimeFirstLastPeriodsFilter

A step that filters a data item to reflect requests for the first or last specified number of members at a level.

Field Summary

static java.lang.String

EVENT_TIME_LEVEL_NAME_CHANGED Indication that level name has been changed

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

BACKWARD, EVENT_NPERIODS_CHANGED, EVENT_PERIODS_CHANGED, EVENT_SEARCH_DIRECTION_CHANGED, FORWARD

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

DataItemTimeFirstLastPeriodsFilter()
No-argument constructor.

DataItemTimeFirstLastPeriodsFilter(int nPeriods, java.lang.String searchDirection, java.lang.String levelName)
Deprecated. use DataItemTimeFirstLastPeriodsFilter(ExpressionInterface,String,ExpressionInterface)

Method Summary

ExpressionInterface	getLevel() Gets the level as an expression interface
java.lang.String	getLevelName() Deprecated. use getLevel()
void	setLevel(ExpressionInterface levelName) Sets the level name.
void	setLevelName(java.lang.String levelName) Deprecated. use setLevel(ExpressionInterface)

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

getnPeriods, getPeriods, getSearchDirection, setnPeriods, setSearchDirection

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_TIME_LEVEL_NAME_CHANGED

public static final java.lang.String EVENT_TIME_LEVEL_NAME_CHANGED

Indication that level name has been changed

See Also:

Constant Field Values

Constructor Detail

DataItemTimeFirstLastPeriodsFilter

public DataItemTimeFirstLastPeriodsFilter()

No-argument constructor.

DataItemTimeFirstLastPeriodsFilter

@Deprecated
public DataItemTimeFirstLastPeriodsFilter(int nPeriods,
                                                     java.lang.String searchDirection,
                                                     java.lang.String levelName)
                                   throws java.lang.IllegalArgumentException

Deprecated. use DataItemTimeFirstLastPeriodsFilter(ExpressionInterface,String,ExpressionInterface)

Create a filter to return First/Last n periods.

Parameters:

nPeriods - number of periods to return

searchDirection - return members after opening date or before closing date? Valid values are DataItemTimeFilter.FORWARD and DataItemTimeFilter.BACKWARD.

levelName - the name of the level representing the selected period type

Throws:

java.lang.IllegalArgumentException

Method Detail

setLevelName

@Deprecated
public void setLevelName(java.lang.String levelName)
                  throws java.lang.IllegalArgumentException

Deprecated. use setLevel(ExpressionInterface)

Sets the level name

Parameters:

levelName - the name of period being filtered

Throws:

java.lang.IllegalArgumentException

getLevelName

public java.lang.String getLevelName()

Deprecated. use getLevel()

Gets the level name as a string

setLevel

public void setLevel(@Nonnull
                     ExpressionInterface levelName)

Sets the level name.

Parameters:

levelName - the name of period being filtered

getLevel

@Nullable
public ExpressionInterface getLevel()

Gets the level as an expression interface

Returns:

an expression interface representing the level