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

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

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

All Implemented Interfaces:

Base, BusinessModelResourceReferencer, ModelItem, StepFilterInterface, StepInterface, UsabilityInterface, PropertyChangeListenee, com.sas.util.LocalizableToStringInterface, java.beans.PropertyChangeListener, java.lang.Cloneable, java.util.EventListener

Direct Known Subclasses:

DataItemTimeFirstLastPeriodsFilter, DataItemTimeNParallelPeriodsFilter, DataItemTimeNPeriodsFilter

public abstract class DataItemTimeFilter

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

StepFilterInterface, BaseFilter

Field Summary

static java.lang.String	BACKWARD Search direction that is 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 Indicates a change in search direction
static java.lang.String	FORWARD Search direction that is going forward in time

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

DataItemTimeFilter()

Method Summary

int	getnPeriods() Deprecated. use getPeriods
ExpressionInterface	getPeriods() Get number of periods
java.lang.String	getSearchDirection() Get search direction
void	setnPeriods(int nPeriods) Deprecated. use setPeriods
void	setSearchDirection(java.lang.String searchDirection) Set which direction to retrieve members

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_SEARCH_DIRECTION_CHANGED

public static final java.lang.String EVENT_SEARCH_DIRECTION_CHANGED

Indicates a change in search direction

See Also:

Constant Field Values

EVENT_PERIODS_CHANGED

public static final java.lang.String EVENT_PERIODS_CHANGED

Indicates a change in number of periods

See Also:

Constant Field Values

EVENT_NPERIODS_CHANGED

public static final java.lang.String EVENT_NPERIODS_CHANGED

Deprecated. use EVENT_PERIODS_CHANGED

Indicates a change in number of periods

See Also:

Constant Field Values

FORWARD

public static final java.lang.String FORWARD

Search direction that is going forward in time

See Also:

Constant Field Values

BACKWARD

public static final java.lang.String BACKWARD

Search direction that is going backward in time.

See Also:

Constant Field Values

Constructor Detail

DataItemTimeFilter

public DataItemTimeFilter()

Method Detail

setnPeriods

public void setnPeriods(int nPeriods)

Deprecated. use setPeriods

Set number of periods to return (negative values are not allowed)

Parameters:

nPeriods - number of periods being return in query.

setSearchDirection

public void setSearchDirection(java.lang.String searchDirection)
                        throws java.lang.IllegalArgumentException

Set which direction to retrieve members

Parameters:

searchDirection - set path of processing - either BACKWARD or FORWARD in time

Throws:

java.lang.IllegalArgumentException

getnPeriods

public int getnPeriods()

Deprecated. use getPeriods

Get number of periods

Returns:

number of periods being processed in the query.

getPeriods

public ExpressionInterface getPeriods()

Get number of periods

Returns:

number of periods being processed in the query.

getSearchDirection

public java.lang.String getSearchDirection()

Get search direction

Returns:

either FORWARD or BACKWARD

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