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

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

com.sas.iquery.metadata.business.step.olap.DataItemTimeNPeriodsFilter
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 DataItemTimeNPeriodsFilter

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

See Also:
StepFilterInterface, DataItemTimeFilter

Field Summary
static java.lang.String EVENT_DATE_CHANGED
          Indication that date attribute 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
DataItemTimeNPeriodsFilter()
          No-argument constructor.
DataItemTimeNPeriodsFilter(ExpressionInterface periods, java.lang.String searchDirection, ExpressionInterface dateMember)
          Create a filter to return N contiguous or parallel periods.
DataItemTimeNPeriodsFilter(int nPeriods, java.lang.String searchDirection, java.lang.String date)
          Deprecated. use DataItemTimeNPeriodsFilter(ExpressionInterface, String, ExpressionInterface)
 
Method Summary
 java.lang.String getDateMember()
          Deprecated. use getMember
 ExpressionInterface getMember()
          Get date member
 java.util.Locale getMemberLocale()
          Get the locale that is associated with the member names for this step.
 void setDateMember(java.lang.String date)
          Deprecated. use setMember
 void setMember(ExpressionInterface date)
          Set date member
 void setMember(ExpressionInterface date, java.util.Locale locale)
          Set date member
 
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_DATE_CHANGED

public static final java.lang.String EVENT_DATE_CHANGED
Indication that date attribute has been changed.

See Also:
Constant Field Values
Constructor Detail

DataItemTimeNPeriodsFilter

public DataItemTimeNPeriodsFilter()
No-argument constructor.


DataItemTimeNPeriodsFilter

@Deprecated
public DataItemTimeNPeriodsFilter(int nPeriods,
                                             java.lang.String searchDirection,
                                             java.lang.String date)
                           throws java.lang.IllegalArgumentException
Deprecated. use DataItemTimeNPeriodsFilter(ExpressionInterface, String, ExpressionInterface)

Create a filter to return n contiguous or parallel periods.

Parameters:
nPeriods - number of periods to return
searchDirection - return members after or before date. Valid values are DataItemTimeFilter.FORWARD and DataItemTimeFilter.BACKWARD.
date - the date for set delimiter
Throws:
IllegalArugmentException - if the search direction or date is null
java.lang.IllegalArgumentException

DataItemTimeNPeriodsFilter

public DataItemTimeNPeriodsFilter(ExpressionInterface periods,
                                  java.lang.String searchDirection,
                                  ExpressionInterface dateMember)
                           throws java.lang.IllegalArgumentException
Create a filter to return N contiguous or parallel periods.

Parameters:
nPeriods - number of periods to return
searchDirection - return members after or before date. Valid values are DataItemTimeFilter.FORWARD and DataItemTimeFilter.BACKWARD.
date - the date for set delimiter
Throws:
IllegalArugmentException - if the search direction or date is null
java.lang.IllegalArgumentException
Method Detail

setDateMember

public void setDateMember(java.lang.String date)
                   throws java.lang.IllegalArgumentException
Deprecated. use setMember

Set date member

Parameters:
date - - staring date for period filtered.
Throws:
java.lang.IllegalArgumentException - if the date is null

setMember

public void setMember(ExpressionInterface date,
                      java.util.Locale locale)
               throws java.lang.IllegalArgumentException
Set date member

Parameters:
date - - staring date for period filtered.
Throws:
java.lang.IllegalArgumentException - if the date is null

setMember

public void setMember(ExpressionInterface date)
               throws java.lang.IllegalArgumentException
Set date member

Parameters:
date - - staring date for period filtered.
Throws:
java.lang.IllegalArgumentException - if the date is null

getMemberLocale

public java.util.Locale getMemberLocale()
Get the locale that is associated with the member names for this step.

Returns:

getDateMember

@Nonnull
public java.lang.String getDateMember()
Deprecated. use getMember

Get date member

Returns:
date - staring date for period filtered.

getMember

public ExpressionInterface getMember()
Get date member

Returns:
date - staring date for period filtered.

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




Copyright © 2009 SAS Institute Inc. All Rights Reserved.