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

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

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

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:

BusinessQueryDataBasedFilter, BusinessQueryRankFilter, BusinessQueryTupleFilter, DataItemMemberFilter, DataItemMemberPropertiesFilter, DataItemNavigationFilter, DataItemRankFilter, DataItemRankFilter, DataItemTimeFilter, DataItemTimeRangeFilter, PromptedTimeRangeFilter

public abstract class BaseFilter
implements StepFilterInterface, java.lang.Cloneable, com.sas.util.LocalizableToStringInterface

An abstract class that represents a step that filters. This is the superclass for each of the various kinds of filters that can be applied to a data item.

See Also:

StepFilterInterface

Field Summary

static java.lang.String	EVENT_ACTION_TYPE_CHANGED
static java.lang.String	EVENT_LOCALIZABLE_LABELS_CHANGED Label associated with the object has 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

BaseFilter()

Method Summary

int	getActionType() This method returns the operation used to define how a Filter Step interacts with the previous Step.
java.lang.String	getDisplayedText(com.sas.storage.olap.MetadataInterface metadata, DataItem dataItem, boolean showPromptValues, java.util.Locale locale) Return the displayed readable text for this step filter.
java.util.List<com.sas.iquery.metadata.business.QualifiedLevel>	getLevels(com.sas.storage.olap.MetadataInterface metadata, DataItem dataItem) Get the levels defined for this step.
void	setActionType(int inActionType) This method defines the operation used to define how a Filter Step interacts with the previous 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

EVENT_ACTION_TYPE_CHANGED

public static final java.lang.String EVENT_ACTION_TYPE_CHANGED

See Also:

Constant Field Values

EVENT_LOCALIZABLE_LABELS_CHANGED

public static final java.lang.String EVENT_LOCALIZABLE_LABELS_CHANGED

Label associated with the object has changed.

See Also:

Constant Field Values

Constructor Detail

BaseFilter

public BaseFilter()

Method Detail

getLevels

public java.util.List<com.sas.iquery.metadata.business.QualifiedLevel> getLevels(com.sas.storage.olap.MetadataInterface metadata,
                                                                                 DataItem dataItem)

Get the levels defined for this step.

Not yet implemented.

Parameters:

metadata -

dataItem -

Returns:

getDisplayedText

public java.lang.String getDisplayedText(com.sas.storage.olap.MetadataInterface metadata,
                                         DataItem dataItem,
                                         boolean showPromptValues,
                                         java.util.Locale locale)

Return the displayed readable text for this step filter.

Example 1: The label of the "[PRODUCT].[CATEGORY].[CHILDREN]" is "Product Equal to Children".

Parameters:

metadata -

dataItem -

show - prompt values or labels

locale - locale used to display or null (use locale in business query).

Returns:

getActionType

public int getActionType()

This method returns the operation used to define how a Filter Step interacts with the previous Step. The action types are defined in this interface.

Specified by:

getActionType in interface StepFilterInterface

Returns:

The actionType defining how this step interacts with the previous step

setActionType

public void setActionType(int inActionType)

This method defines the operation used to define how a Filter Step interacts with the previous Step. The valid action types are defined in this interface.

Specified by:

setActionType in interface StepFilterInterface

Parameters:

inActionType - The actionType defining how this step interacts with the previous step and if action type is invalid, then INITIAL_ACTION_TYPE is assumed.

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