com.sas.dataselectors.filters
Class DefaultAdvancedFilterCondition

com.sas.dataselectors.filters.DefaultAdvancedFilterCondition

All Implemented Interfaces:

AdvancedFilterConditionInterface, FilterConditionInterface

public class DefaultAdvancedFilterCondition
implements AdvancedFilterConditionInterface

Field Summary

protected boolean	_allowPrompt An internal flag for whether prompted values are allowed for this condition.
static FilterConditionInterface	CONTAINS
static FilterConditionInterface	DOES_NOT_CONTAIN
static FilterConditionInterface	IS_BETWEEN
static FilterConditionInterface	IS_BETWEEN_TIME
static FilterConditionInterface	IS_EQUALS
static FilterConditionInterface	IS_GREATER_THAN
static FilterConditionInterface	IS_GREATER_THAN_OR_EQUAL
static FilterConditionInterface	IS_IN_LIST
static FilterConditionInterface	IS_LESS_THAN
static FilterConditionInterface	IS_LESS_THAN_OR_EQUAL
static FilterConditionInterface	IS_MISSING_VALUE
static FilterConditionInterface	IS_NOT_BETWEEN
static FilterConditionInterface	IS_NOT_BETWEEN_TIME
static FilterConditionInterface	IS_NOT_EQUALS
static FilterConditionInterface	IS_NOT_IN_LIST
static FilterConditionInterface	IS_NOT_MISSING_VALUE
static FilterConditionInterface	IS_NOT_NULL
static FilterConditionInterface	IS_NULL
static FilterConditionInterface	LAST_N_PERIODS
static FilterConditionInterface	MONTH_TO_DATE
static FilterConditionInterface	NEXT_N_PERIODS
static FilterConditionInterface	OLAP_RELATIVE_TIME
static java.lang.String	RB_KEY
static java.lang.String	RB_KEY2
static FilterConditionInterface	YEAR_TO_DATE

Fields inherited from class com.sas.dataselectors.filters.DefaultFilterCondition

_allowSelected, _allowTyped, _argumentCount, _argumentLabels, _conditionLabel, _conditionMessageFormat, _conditionObject, _isConditionObjectNegated, IS_AFTER, IS_AFTER_OR_EQUAL, IS_BEFORE, IS_BEFORE_OR_EQUAL

Constructor Summary

DefaultAdvancedFilterCondition()

DefaultAdvancedFilterCondition(FilterConditionInterface conditionToCopy)
Constructs a new instance that is a copy of the given condition.

DefaultAdvancedFilterCondition(java.lang.String label, java.lang.String format, int parmCount, java.lang.String[] parmLabels)

DefaultAdvancedFilterCondition(java.lang.String label, java.lang.String format, int parmCount, java.lang.String[] parmLabels, java.lang.Object conditionObject)

DefaultAdvancedFilterCondition(java.lang.String label, java.lang.String format, int parmCount, java.lang.String[] parmLabels, java.lang.Object conditionObject, boolean isConditionObjectNegated)

DefaultAdvancedFilterCondition(java.lang.String label, java.lang.String format, int parmCount, java.lang.String[] parmLabels, java.lang.Object conditionObject, boolean isConditionObjectNegated, boolean isValueListAllowed, boolean isUserValueAllowed)

Method Summary

static FilterConditionInterface	getAdvancedConditionFromRB(java.lang.String key) Constructs a new DefaultAdvancedFilterCondition based on resources using the given key and the default locale.
static FilterConditionInterface	getAdvancedConditionFromRB(java.lang.String key, java.util.Locale locale) Constructs a new DefaultAdvancedFilterCondition based on resources using the given key and locale.
static FilterConditionInterface	getAdvancedConditionFromRB(java.lang.String key, java.lang.Object conditionObject, boolean isNegated, boolean isPromptable, java.util.Locale locale) Constructs a new DefaultAdvancedFilterCondition based on resources using the given key and locale.
boolean	isPromptValueAllowed() Returns TRUE if users are allowed to create a prompt value, false otherwise.
void	setPromptValueAllowed(boolean allow)

Methods inherited from class com.sas.dataselectors.filters.DefaultFilterCondition

equals, format, format, format, format, getCondition, getConditionArgumentCount, getConditionArgumentLabel, getConditionArgumentLabels, getConditionFromRB, getConditionFromRB, getConditionFromRB, getConditionLabel, getConditionLabel, getConditionMessageFormat, isConditionObjectNegated, isExpressionValueAllowed, isUserValueAllowed, isValueListAllowed, setCondition, setConditionArgumentCount, setConditionArgumentLabels, setConditionLabel, setConditionMessageFormat, setConditionObjectNegated, setLocale, setUserValueAllowed, setValueListAllowed, toString

Methods inherited from interface com.sas.dataselectors.filters.AdvancedFilterConditionInterface

isUserValueAllowed, isValueListAllowed

Methods inherited from interface com.sas.dataselectors.filters.FilterConditionInterface

format, getCondition, getConditionArgumentCount, getConditionArgumentLabel, getConditionArgumentLabels, getConditionLabel, getConditionLabel, getConditionMessageFormat, isConditionObjectNegated, isExpressionValueAllowed, setConditionMessageFormat, setLocale

Field Detail

RB_KEY

public static final java.lang.String RB_KEY

See Also:

Constant Field Values

RB_KEY2

public static final java.lang.String RB_KEY2

See Also:

Constant Field Values

IS_EQUALS

public static final FilterConditionInterface IS_EQUALS

IS_NOT_EQUALS

public static final FilterConditionInterface IS_NOT_EQUALS

IS_IN_LIST

public static final FilterConditionInterface IS_IN_LIST

IS_NOT_IN_LIST

public static final FilterConditionInterface IS_NOT_IN_LIST

IS_LESS_THAN

public static final FilterConditionInterface IS_LESS_THAN

IS_LESS_THAN_OR_EQUAL

public static final FilterConditionInterface IS_LESS_THAN_OR_EQUAL

IS_GREATER_THAN

public static final FilterConditionInterface IS_GREATER_THAN

IS_GREATER_THAN_OR_EQUAL

public static final FilterConditionInterface IS_GREATER_THAN_OR_EQUAL

IS_BETWEEN

public static final FilterConditionInterface IS_BETWEEN

IS_NOT_BETWEEN

public static final FilterConditionInterface IS_NOT_BETWEEN

IS_NULL

public static final FilterConditionInterface IS_NULL

IS_NOT_NULL

public static final FilterConditionInterface IS_NOT_NULL

IS_MISSING_VALUE

public static final FilterConditionInterface IS_MISSING_VALUE

IS_NOT_MISSING_VALUE

public static final FilterConditionInterface IS_NOT_MISSING_VALUE

CONTAINS

public static final FilterConditionInterface CONTAINS

DOES_NOT_CONTAIN

public static final FilterConditionInterface DOES_NOT_CONTAIN

OLAP_RELATIVE_TIME

public static final FilterConditionInterface OLAP_RELATIVE_TIME

YEAR_TO_DATE

public static final FilterConditionInterface YEAR_TO_DATE

MONTH_TO_DATE

public static final FilterConditionInterface MONTH_TO_DATE

IS_BETWEEN_TIME

public static final FilterConditionInterface IS_BETWEEN_TIME

IS_NOT_BETWEEN_TIME

public static final FilterConditionInterface IS_NOT_BETWEEN_TIME

LAST_N_PERIODS

public static final FilterConditionInterface LAST_N_PERIODS

NEXT_N_PERIODS

public static final FilterConditionInterface NEXT_N_PERIODS

_allowPrompt

protected boolean _allowPrompt

An internal flag for whether prompted values are allowed for this condition.

Constructor Detail

DefaultAdvancedFilterCondition

public DefaultAdvancedFilterCondition()

DefaultAdvancedFilterCondition

public DefaultAdvancedFilterCondition(java.lang.String label,
                                      java.lang.String format,
                                      int parmCount,
                                      java.lang.String[] parmLabels)

DefaultAdvancedFilterCondition

public DefaultAdvancedFilterCondition(java.lang.String label,
                                      java.lang.String format,
                                      int parmCount,
                                      java.lang.String[] parmLabels,
                                      java.lang.Object conditionObject)

DefaultAdvancedFilterCondition

public DefaultAdvancedFilterCondition(java.lang.String label,
                                      java.lang.String format,
                                      int parmCount,
                                      java.lang.String[] parmLabels,
                                      java.lang.Object conditionObject,
                                      boolean isConditionObjectNegated)

DefaultAdvancedFilterCondition

public DefaultAdvancedFilterCondition(java.lang.String label,
                                      java.lang.String format,
                                      int parmCount,
                                      java.lang.String[] parmLabels,
                                      java.lang.Object conditionObject,
                                      boolean isConditionObjectNegated,
                                      boolean isValueListAllowed,
                                      boolean isUserValueAllowed)

DefaultAdvancedFilterCondition

public DefaultAdvancedFilterCondition(FilterConditionInterface conditionToCopy)

Constructs a new instance that is a copy of the given condition.

Parameters:

conditionToCopy - the FilterConditionInterface instance to copy

Method Detail

getAdvancedConditionFromRB

public static FilterConditionInterface getAdvancedConditionFromRB(java.lang.String key)

Constructs a new DefaultAdvancedFilterCondition based on resources using the given key and the default locale.

Parameters:

key - the resource key common to all properties for the desired condition

Returns:

the new DefaultAdvancedFilterCondition object

getAdvancedConditionFromRB

public static FilterConditionInterface getAdvancedConditionFromRB(java.lang.String key,
                                                                  java.util.Locale locale)

Constructs a new DefaultAdvancedFilterCondition based on resources using the given key and locale. The native condition object is assumed to be null, the condition is not set as negated, and prompts will be allowed by default.

Parameters:

key - the resource key common to all properties for the desired condition

locale - the locale to use when retrieving properties for the condition

Returns:

the new DefaultAdvancedFilterCondition object

getAdvancedConditionFromRB

public static FilterConditionInterface getAdvancedConditionFromRB(java.lang.String key,
                                                                  java.lang.Object conditionObject,
                                                                  boolean isNegated,
                                                                  boolean isPromptable,
                                                                  java.util.Locale locale)

Constructs a new DefaultAdvancedFilterCondition based on resources using the given key and locale.

Parameters:

key - the resource key common to all properties for the desired condition

conditionObject - the native object this condition should represent

isNegated - the boolean flag to specify if this condition is negated

isPromptable - the boolean flag to specify if this condition allows prompted values

locale - the locale to use when retrieving properties for the condition

Returns:

the new DefaultAdvancedFilterCondition object

setPromptValueAllowed

public void setPromptValueAllowed(boolean allow)

Parameters:

allow - whether to allow prompted values or not

isPromptValueAllowed

public boolean isPromptValueAllowed()

Returns TRUE if users are allowed to create a prompt value, false otherwise.

Specified by:

isPromptValueAllowed in interface FilterConditionInterface

Overrides:

isPromptValueAllowed in class DefaultFilterCondition