*** This class contains elements that are subject to change. ***

com.sas.iquery.metadata.expr.olap
Class DataBasedFilterExpression

com.sas.iquery.metadata.expr.olap.DataBasedFilterExpression

All Implemented Interfaces:

Base, BusinessModelResourceReferencer, ModelItem, UsabilityInterface, ExpressionInterface, PropertyChangeListenee, java.beans.PropertyChangeListener, java.lang.Cloneable, java.util.EventListener

@SASScope(value="ALL")
public class DataBasedFilterExpression

Models the "comparison" simple conditional expression. This is of the format {WhatToFilter} where {LeftExpression} {ComparisonOperator} {RightExpression}.

See the ConditionalExpression class for a description of the organization of of ConditionalExpression classes.

Field Summary

static java.lang.String	EVENT_COMPARISON_OPERATOR_CHANGED Indication that what comparison operator has changed.
static java.lang.String	EVENT_LEFT_EXPRESSION_CHANGED Indication that left portion of expression has changed.
static java.lang.String	EVENT_RIGHT_EXPRESSION_CHANGED Indication that right portion of expression has changed.
static java.lang.String	EVENT_WHAT_TO_FILTER_CHANGED Indication that what to filter has changed.

Fields inherited from class com.sas.iquery.metadata.expr.olap.BaseFilterExpression

EVENT_WHAT_TO_COMPARE_CHANGED

Fields inherited from class com.sas.iquery.metadata.expr.ConditionalExpression

EVENT_NEGATION_CHANGED

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

DataBasedFilterExpression()

Method Summary

java.util.List<ExpressionInterface>	getLeftExpression() Gets the left expression for this conditional expression.
java.util.List<ExpressionInterface>	getRightExpression() Gets the right expression for this conditional expression.
ExpressionInterface	getWhatToFilter() Gets the value of what is being filtered.
void	setComparisonOperator(ComparisonOperator operator) Sets the comparison used in this expression
void	setLeftExpression(java.util.List<? extends ExpressionInterface> values) Sets the left expression portion of the conditional expression.
void	setRightExpression(java.util.List<? extends ExpressionInterface> values) Sets the right expression portion of the conditional expression.
void	setWhatToFilter(ExpressionInterface expr) Sets the value of what will be filtered.

Methods inherited from class com.sas.iquery.metadata.expr.olap.BaseFilterExpression

getDisplayedText, getLevels, getWhatToCompare

Methods inherited from class com.sas.iquery.metadata.expr.ConditionalExpression

getExpressionType, isNegated, setIsNegated

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_WHAT_TO_FILTER_CHANGED

public static final java.lang.String EVENT_WHAT_TO_FILTER_CHANGED

Indication that what to filter has changed.

See Also:

Constant Field Values

EVENT_COMPARISON_OPERATOR_CHANGED

public static final java.lang.String EVENT_COMPARISON_OPERATOR_CHANGED

Indication that what comparison operator has changed.

See Also:

Constant Field Values

EVENT_LEFT_EXPRESSION_CHANGED

public static final java.lang.String EVENT_LEFT_EXPRESSION_CHANGED

Indication that left portion of expression has changed.

See Also:

Constant Field Values

EVENT_RIGHT_EXPRESSION_CHANGED

public static final java.lang.String EVENT_RIGHT_EXPRESSION_CHANGED

Indication that right portion of expression has changed.

See Also:

Constant Field Values

Constructor Detail

DataBasedFilterExpression

public DataBasedFilterExpression()

Method Detail

setWhatToFilter

public void setWhatToFilter(ExpressionInterface expr)

Sets the value of what will be filtered.

Parameters:

expr - is the value in question and must be a DataItem

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

getWhatToFilter

@SASScope(value="ALL")
@SubjectToChange
public ExpressionInterface getWhatToFilter()

Gets the value of what is being filtered.

Returns:

expression of filter.

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

setComparisonOperator

@SASScope(value="ALL")
@SubjectToChange
public void setComparisonOperator(ComparisonOperator operator)

Sets the comparison used in this expression

Parameters:

operator -

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

setLeftExpression

@SASScope(value="ALL")
@SubjectToChange
public void setLeftExpression(java.util.List<? extends ExpressionInterface> values)

Sets the left expression portion of the conditional expression. This is commonly a List of StringExpression representing Member Names or DataItem (with structure of Measure).

Parameters:

values - left side of conditional expression

getLeftExpression

public java.util.List<ExpressionInterface> getLeftExpression()

Gets the left expression for this conditional expression. This is commonly a List of StringExpressions representing Member Names or DataItem (with structure of Measure).

Returns:

the left side expression.

setRightExpression

public void setRightExpression(java.util.List<? extends ExpressionInterface> values)

Sets the right expression portion of the conditional expression. This is commonly a single ConstantExpression representing a constant value to be used in the expression, but could also be a more general expression or a list of StringExpressions representing Member Names.

Parameters:

values - right side of conditional expression

getRightExpression

public java.util.List<ExpressionInterface> getRightExpression()

Gets the right expression for this conditional expression. This is commonly a single ConstantExpression representing a constant value to be used in the expression, but could also be a more general expression or a list of StringExpressions representing Member Names.

Returns:

the right side expression.

*** This class contains elements that are subject to change. ***