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

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

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

All Implemented Interfaces:

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

@SASScope(value="ALL")
@SubjectToChange
public class DataItemMemberFilter
implements BusinessModelResourceReferencer

A step that filters a data item based on a particular member or set of members. The result of a member filter is the set of specified members.

See Also:

StepFilterInterface, BaseFilter

Field Summary

static java.lang.String	EVENT_MEMBER_FILTER_TYPE_CHANGED Indication that member filter type has been changed
static java.lang.String	EVENT_MEMBER_NAMES_CHANGED Indication that member name has been changed
static java.lang.String	EVENT_NEGATION_CHANGED Indication that negation flag has been changed
static int	LIST_MEMBER_FILTER_TYPE This member filter type provides a set of member names that are equal to the list of member names passed into the Member Filter.
static int	RANGE_MEMBER_FILTER_TYPE This member filter type creates a set of members by creating a range from the member names that are passed into the Member Filter.

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.Base

EVENT_OBJECT_DEFINITION_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

Constructor Summary

DataItemMemberFilter()

DataItemMemberFilter(java.lang.String[] memberNames, int memberFilterType)
Apply a filter based on the value of several members.

Method Summary

int	getMemberFilterType() This method returns the type of member filter that is used.
java.util.Locale	getMemberLocale() Get the locale that is associated with the member names for this step.
java.util.List<NonCalculatedValue>	getMemberNames() This method returns the names of the members to be used for filtering.
boolean	isNegated() Tests if this conditional expression is negated
void	setIsNegated(boolean flag) Sets whether this conditional expression is negated.
void	setMemberFilterType(int memberFilterType) This method defines the type of member filter to be applied.
void	setMemberNames(java.util.List<? extends NonCalculatedValue> memberNames) This method defines the names of the members to use for filtering (always replace existing member names).
void	setMemberNames(java.util.List<? extends NonCalculatedValue> memberNames, java.util.Locale locale) This method defines the names of the members to use for filtering (always replace existing member names).

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_MEMBER_FILTER_TYPE_CHANGED

public static final java.lang.String EVENT_MEMBER_FILTER_TYPE_CHANGED

Indication that member filter type has been changed

See Also:

Constant Field Values

EVENT_MEMBER_NAMES_CHANGED

public static final java.lang.String EVENT_MEMBER_NAMES_CHANGED

Indication that member name has been changed

See Also:

Constant Field Values

EVENT_NEGATION_CHANGED

public static final java.lang.String EVENT_NEGATION_CHANGED

Indication that negation flag has been changed

See Also:

Constant Field Values

LIST_MEMBER_FILTER_TYPE

public static final int LIST_MEMBER_FILTER_TYPE

This member filter type provides a set of member names that are equal to the list of member names passed into the Member Filter. In order to exclude the list set an actionType of DIFFERENCE_ACTION_TYPE on the StepFilterInterface. A type of INITIAL_ACTION_TYPE can be used to include the list.

See Also:

Constant Field Values

RANGE_MEMBER_FILTER_TYPE

public static final int RANGE_MEMBER_FILTER_TYPE

This member filter type creates a set of members by creating a range from the member names that are passed into the Member Filter. If more than two member names are passed in the first two are used to create the range. If only one member is passed in the range extends from that member to its last sibling.

See Also:

Constant Field Values

Constructor Detail

DataItemMemberFilter

public DataItemMemberFilter()

DataItemMemberFilter

public DataItemMemberFilter(@NonNull
                            java.lang.String[] memberNames,
                            int memberFilterType)

Apply a filter based on the value of several members.

Parameters:

memberNames - Name of members to be filtered

memberFilterType - The type of member filter to be applied

Method Detail

setMemberFilterType

public void setMemberFilterType(int memberFilterType)

This method defines the type of member filter to be applied.

Parameters:

memberFilterType - The type of member filter to be applied

getMemberFilterType

public int getMemberFilterType()

This method returns the type of member filter that is used.

Returns:

The type of member filter

isNegated

public boolean isNegated()

Tests if this conditional expression is negated

setIsNegated

public void setIsNegated(boolean flag)

Sets whether this conditional expression is negated.

setMemberNames

public void setMemberNames(java.util.List<? extends NonCalculatedValue> memberNames,
                           java.util.Locale locale)

This method defines the names of the members to use for filtering (always replace existing member names).

Parameters:

memberNames - The names of the members to be used for filtering

setMemberNames

public void setMemberNames(java.util.List<? extends NonCalculatedValue> memberNames)

This method defines the names of the members to use for filtering (always replace existing member names).

Parameters:

memberNames - The names of the members to be used for filtering

getMemberLocale

public java.util.Locale getMemberLocale()

Get the locale that is associated with the member names for this step.

Returns:

getMemberNames

public java.util.List<NonCalculatedValue> getMemberNames()

This method returns the names of the members to be used for filtering.

Returns:

The names of the members

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