*** This interface is subject to change. ***

com.sas.iquery.metadata.business.step
Interface StepFilterInterface

All Superinterfaces:

Base, BusinessModelResourceReferencer, java.util.EventListener, ModelItem, PropertyChangeListenee, java.beans.PropertyChangeListener, StepInterface, UsabilityInterface

All Known Implementing Classes:

BaseFilter, BusinessQueryDataBasedFilter, BusinessQueryRankFilter, BusinessQueryTupleFilter, DataItemMemberFilter, DataItemMemberPropertiesFilter, DataItemNavigationFilter, DataItemRankFilter, DataItemRankFilter, DataItemTimeFilter, DataItemTimeFirstLastPeriodsFilter, DataItemTimeNParallelPeriodsFilter, DataItemTimeNPeriodsFilter, DataItemTimeRangeFilter, PromptedTimeRangeFilter

@SASScope(value="ALL")
@SubjectToChange
public interface StepFilterInterface
extends StepInterface

Provides modeling for steps that filter data. A filtering step defines a set of members that are associated with a given step. The relationship between a filter and the current step is defined by the action type, which defines how the new set of members should be incorporated with the existing set of members. For example, the members might replace the existing set of members or they might be added to whatever is already there.

See Also:

StepInterface

Field Summary

static int	APPEND_ACTION_TYPE The members defined in this step are appended to the members of the previous step.
static int	DIFFERENCE_ACTION_TYPE The members defined in this step are removed from the set of members defined in the previous step.
static int	INITIAL_ACTION_TYPE This step represents the initial set of members or an operation that is meant to completely replace the pre-existing state of the DataItem (eg DrillDown).
static int	INSERT_ACTION_TYPE The members defined in this step are inserted in the set of members defined in the previous step.
static int	INTERSECT_ACTION_TYPE The members defined by the intersection of this step and the outcome of previous steps.
static int	PREPEND_ACTION_TYPE The members defined in this step are prepended to the members of the previous step.
static int	SPECIAL_ACTION_TYPE This action type is used specifically for expand and collapse
static int	UNION_ACTION_TYPE The members defined by the union of this step and the outcome of previous steps.

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

Method Summary

abstract int	getActionType() This method returns the action to be performed by this filter step.
abstract java.lang.String	getLabel() Returns a label for this step.
abstract void	setActionType(int actionType) This method defines the action to be performed by this filter step.
abstract void	setLabel(java.lang.String label) Set a label for this step.

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

*** This field is subject to change. ***

INITIAL_ACTION_TYPE

@SASScope(value="ALL")
@SubjectToChange
static final int INITIAL_ACTION_TYPE

This step represents the initial set of members or an operation that is meant to completely replace the pre-existing state of the DataItem (eg DrillDown). The previous steps, however, should be maintained in the event that this Step is removed.

Examples of how MDX for step is applied using action type.

Example 1:

Step 1: Navigation - drill down - generates MDX string of [CARS].[CAR].[CHILDREN] where initial MDX expression enters step. MDX generated from navigation step will enter as current expression for second step.

Step 2: Rank - top percent - generates TopPercent([CARS].[CAR].[CHILDREN]) where MDX uses expression from step 1 to complete.

Example 2:

Step 1: Rank - top percent - generates TopPercent([CARS].[CAR].Members) where MDX is using the initial MDX expression to complete MDX.

Step 2: Navigation - drill down generates MDX string of [CARS].[CAR].[CHILDREN] where MDX generated from navigation overrides any MDX generated in step 1

Example 3:

Step 1: Filter - filter based on data base range - generate ([CARS].[CAR].[Ford]: [CARS].[CAR].[Toyota]) where initial MDX enters this step. MDX generated from filter step will enter as current expression for second step.

Step 2: Rank top percent - generates TopPercent([CARS].[CAR].[Ford]: [CARS].[CAR].[Toyota]) where MDX uses expression from step to complete.

Example 4:

Step 1: Rank - top percent - generates TopPercent([CARS].[CAR].Members) where MDX is using the initial MDX expression to complete MDX.

Step 2: Filter -filter based on data base range - generate ([CARS].[CAR].[Ford]: [CARS].[CAR].[Toyota]) where MDX generated from filter overrides any MDX generated in step 1

See Also:

Constant Field Values

*** This field is subject to change. ***

APPEND_ACTION_TYPE

@SASScope(value="ALL")
@SubjectToChange
static final int APPEND_ACTION_TYPE

The members defined in this step are appended to the members of the previous step.

See Also:

Constant Field Values

*** This field is subject to change. ***

PREPEND_ACTION_TYPE

@SASScope(value="ALL")
@SubjectToChange
static final int PREPEND_ACTION_TYPE

The members defined in this step are prepended to the members of the previous step.

See Also:

Constant Field Values

*** This field is subject to change. ***

INSERT_ACTION_TYPE

@SASScope(value="ALL")
@SubjectToChange
static final int INSERT_ACTION_TYPE

The members defined in this step are inserted in the set of members defined in the previous step.

See Also:

Constant Field Values

*** This field is subject to change. ***

DIFFERENCE_ACTION_TYPE

@SASScope(value="ALL")
@SubjectToChange
static final int DIFFERENCE_ACTION_TYPE

The members defined in this step are removed from the set of members defined in the previous step.

See Also:

Constant Field Values

*** This field is subject to change. ***

INTERSECT_ACTION_TYPE

@SASScope(value="ALL")
@SubjectToChange
static final int INTERSECT_ACTION_TYPE

The members defined by the intersection of this step and the outcome of previous steps.

See Also:

Constant Field Values

*** This field is subject to change. ***

SPECIAL_ACTION_TYPE

@SASScope(value="ALL")
@SubjectToChange
static final int SPECIAL_ACTION_TYPE

This action type is used specifically for expand and collapse

See Also:

Constant Field Values

*** This field is subject to change. ***

UNION_ACTION_TYPE

@SASScope(value="ALL")
@SubjectToChange
static final int UNION_ACTION_TYPE

The members defined by the union of this step and the outcome of previous steps.

See Also:

Constant Field Values

Method Detail

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

setActionType

@SASScope(value="ALL")
@SubjectToChange
void setActionType(int actionType)

This method defines the action to be performed by this filter step. This action is to be performed on the data resulting from applying the steps previous to this step in the list of steps set on a data item or query. The valid action types are defined in this interface.

Parameters:

actionType - The action to be performed

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

getActionType

@SASScope(value="ALL")
@SubjectToChange
int getActionType()

This method returns the action to be performed by this filter step. This action is to be performed on the data resulting from applying the steps previous to this step in the list of steps set on a data item or query. The action types are defined in this interface.

Returns:

The action to be performed

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

getLabel

@SASScope(value="ALL")
@SubjectToChange
java.lang.String getLabel()

Returns a label for this step.

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

setLabel

@SASScope(value="ALL")
@SubjectToChange
void setLabel(java.lang.String label)

Set a label for this step.

*** This interface is subject to change. ***