com.ssaglobal.bde
Interface IBdeFilter

public interface IBdeFilter

The IBdeFilter interface helps define the Filters required for the formation of a request. A Filter is defined by creating a IBdeFilterExpression object. An instance of IBdeFilter can be created using BdeToolkit

There are 2 basic types of expressions that can be used.

1. A Comparison expression is used to create a comparison condition such as 'AttributeX eq ValueX'. The comparisonOperator can be 'less than or equal', 'less than', 'greater than or equal', 'greater than', 'not equal' and 'equal'.
2. A Logical expression is used to logically combine multiple Comparison Expressions. A logicalOperator can be either 'and' or 'or'.

For example:
IBdeFilter filter = BdeToolkit.getDefaultToolkit().createBdeFilter();
IBdeFilterExpression compExp = filter.createComparisonEqual( "AttributeX", "ValueX");
filter.setExpression(compExp);


Method Summary

IBdeFilterExpression	createAttributeComparisonEqual(java.lang.String attribute1, java.lang.String attribute2) Creates an 'equal' Attribute comparison IBdeFilterExpression.
IBdeFilterExpression	createAttributeComparisonGreater(java.lang.String attribute1, java.lang.String attribute2) Creates a 'greater' Attribute comparison IBdeFilterExpression.
IBdeFilterExpression	createAttributeComparisonGreaterOrEqual(java.lang.String attribute1, java.lang.String attribute2) Creates a 'greater or equal' Attribute comparison IBdeFilterExpression.
IBdeFilterExpression	createAttributeComparisonLess(java.lang.String attribute1, java.lang.String attribute2) Creates a 'less' Attribute comparison IBdeFilterExpression.
IBdeFilterExpression	createAttributeComparisonLessOrEqual(java.lang.String attribute1, java.lang.String attribute2) Creates a 'less or equal' Attribute comparison IBdeFilterExpression.
IBdeFilterExpression	createAttributeComparisonNotEqual(java.lang.String attribute1, java.lang.String attribute2) Creates a 'not equal' Attribute comparison IBdeFilterExpression.
IBdeFilterExpression	createComparisonEqual(java.lang.String attribute, java.lang.String value) Creates an 'equal' comparison IBdeFilterExpression.
IBdeFilterExpression	createComparisonGreater(java.lang.String attribute, java.lang.String value) Creates a 'greater' comparison IBdeFilterExpression.
IBdeFilterExpression	createComparisonGreaterOrEqual(java.lang.String attribute, java.lang.String value) Creates a 'greater or equal' comparison IBdeFilterExpression.
IBdeFilterExpression	createComparisonLess(java.lang.String attribute, java.lang.String value) Creates a 'less' comparison IBdeFilterExpression.
IBdeFilterExpression	createComparisonLessOrEqual(java.lang.String attribute, java.lang.String value) Creates a 'less or equal' comparison IBdeFilterExpression.
IBdeFilterExpression	createComparisonNotEqual(java.lang.String attribute, java.lang.String value) Creates a 'not equal' comparison IBdeFilterExpression.
IBdeFilterExpression	createLogicalAnd(IBdeFilterExpression expression1, IBdeFilterExpression expression2) Creates a logical 'and' IBdeFilterExpression.
IBdeFilterExpression	createLogicalOr(IBdeFilterExpression expression1, IBdeFilterExpression expression2) Creates a logical 'or' IBdeFilterExpression.
void	setExpression(IBdeFilterExpression expression) This method sets an instance of IBdeFilterExpression in the IBdeFilter object.

Method Detail

setExpression

public void setExpression(IBdeFilterExpression expression)

This method sets an instance of IBdeFilterExpression in the IBdeFilter object.

Parameters:

expression - can be a logical expression or comparison expression.

createLogicalAnd

public IBdeFilterExpression createLogicalAnd(IBdeFilterExpression expression1,
                                             IBdeFilterExpression expression2)

Creates a logical 'and' IBdeFilterExpression. This can be set to the IBdeFilter using the setExpression(com.ssaglobal.bde.IBdeFilterExpression) method.

Parameters:

expression1 - the expression #1 to be used with the logicalOperator.

expression2 - the expression #2 to be used with the logicalOperator.

Returns:

IBdeFilterExpression object

createLogicalOr

public IBdeFilterExpression createLogicalOr(IBdeFilterExpression expression1,
                                            IBdeFilterExpression expression2)

Creates a logical 'or' IBdeFilterExpression. This can be set to the IBdeFilter using the setExpression(com.ssaglobal.bde.IBdeFilterExpression) method.

Parameters:

expression1 - the expression #1 to be used with the logicalOperator.

expression2 - the expression #2 to be used with the logicalOperator.

Returns:

IBdeFilterExpression object

createComparisonEqual

public IBdeFilterExpression createComparisonEqual(java.lang.String attribute,
                                                  java.lang.String value)

Creates an 'equal' comparison IBdeFilterExpression. This can be set to the IBdeFilter using the setExpression(com.ssaglobal.bde.IBdeFilterExpression) method. Two Comparison Expressios can be combined using Logical Expressions.

Parameters:

attribute - which needs to be used in the comparison. The Generated BDE proxy provides constants for those attributes.

value - which needs to be used in the comparison.

Returns:

IBdeFilterExpression object

createComparisonNotEqual

public IBdeFilterExpression createComparisonNotEqual(java.lang.String attribute,
                                                     java.lang.String value)

Creates a 'not equal' comparison IBdeFilterExpression. This can be set to the IBdeFilter using the setExpression(com.ssaglobal.bde.IBdeFilterExpression) method. Two Comparison Expressios can be combined using Logical Expressions.

Parameters:

attribute - which needs to be used in the comparison. The Generated BDE proxy provides constants for those attributes.

value - which needs to be used in the comparison.

Returns:

IBdeFilterExpression object

createComparisonLess

public IBdeFilterExpression createComparisonLess(java.lang.String attribute,
                                                 java.lang.String value)

Creates a 'less' comparison IBdeFilterExpression. This can be set to the IBdeFilter using the setExpression(com.ssaglobal.bde.IBdeFilterExpression) method. Two Comparison Expressios can be combined using Logical Expressions.

Parameters:

attribute - which needs to be used in the comparison. The Generated BDE proxy provides constants for those attributes.

value - which needs to be used in the comparison.

Returns:

IBdeFilterExpression object

createComparisonLessOrEqual

public IBdeFilterExpression createComparisonLessOrEqual(java.lang.String attribute,
                                                        java.lang.String value)

Creates a 'less or equal' comparison IBdeFilterExpression. This can be set to the IBdeFilter using the setExpression(com.ssaglobal.bde.IBdeFilterExpression) method. Two Comparison Expressios can be combined using Logical Expressions.

Parameters:

attribute - which needs to be used in the comparison. The Generated BDE proxy provides constants for those attributes.

value - which needs to be used in the comparison.

Returns:

IBdeFilterExpression object

createComparisonGreater

public IBdeFilterExpression createComparisonGreater(java.lang.String attribute,
                                                    java.lang.String value)

Creates a 'greater' comparison IBdeFilterExpression. This can be set to the IBdeFilter using the setExpression(com.ssaglobal.bde.IBdeFilterExpression) method. Two Comparison Expressios can be combined using Logical Expressions.

Parameters:

attribute - which needs to be used in the comparison. The Generated BDE proxy provides constants for those attributes.

value - which needs to be used in the comparison.

Returns:

IBdeFilterExpression object

createComparisonGreaterOrEqual

public IBdeFilterExpression createComparisonGreaterOrEqual(java.lang.String attribute,
                                                           java.lang.String value)

Creates a 'greater or equal' comparison IBdeFilterExpression. This can be set to the IBdeFilter using the setExpression(com.ssaglobal.bde.IBdeFilterExpression) method. Two Comparison Expressios can be combined using Logical Expressions.

Parameters:

attribute - which needs to be used in the comparison. The Generated BDE proxy provides constants for those attributes.

value - which needs to be used in the comparison.

Returns:

IBdeFilterExpression object

createAttributeComparisonEqual

public IBdeFilterExpression createAttributeComparisonEqual(java.lang.String attribute1,
                                                           java.lang.String attribute2)

Creates an 'equal' Attribute comparison IBdeFilterExpression. This can be set to the IBdeFilter using the setExpression(com.ssaglobal.bde.IBdeFilterExpression) method. Two Comparison Expressios can be combined using Logical Expressions.

Parameters:

attribute1 - which needs to be used in the comparison. The Generated BDE proxy provides constants for those attributes.

attribute2 - which needs to be used in the comparison. The Generated BDE proxy provides constants for those attributes. *

Returns:

IBdeFilterExpression object

createAttributeComparisonNotEqual

public IBdeFilterExpression createAttributeComparisonNotEqual(java.lang.String attribute1,
                                                              java.lang.String attribute2)

Creates a 'not equal' Attribute comparison IBdeFilterExpression. This can be set to the IBdeFilter using the setExpression(com.ssaglobal.bde.IBdeFilterExpression) method. Two Comparison Expressios can be combined using Logical Expressions.

Parameters:

attribute1 - which needs to be used in the comparison. The Generated BDE proxy provides constants for those attributes.

attribute2 - which needs to be used in the comparison. The Generated BDE proxy provides constants for those attributes. *

Returns:

IBdeFilterExpression object

createAttributeComparisonLess

public IBdeFilterExpression createAttributeComparisonLess(java.lang.String attribute1,
                                                          java.lang.String attribute2)

Creates a 'less' Attribute comparison IBdeFilterExpression. This can be set to the IBdeFilter using the setExpression(com.ssaglobal.bde.IBdeFilterExpression) method. Two Comparison Expressios can be combined using Logical Expressions.

Parameters:

attribute1 - which needs to be used in the comparison. The Generated BDE proxy provides constants for those attributes.

attribute2 - which needs to be used in the comparison. The Generated BDE proxy provides constants for those attributes. *

Returns:

IBdeFilterExpression object

createAttributeComparisonLessOrEqual

public IBdeFilterExpression createAttributeComparisonLessOrEqual(java.lang.String attribute1,
                                                                 java.lang.String attribute2)

Creates a 'less or equal' Attribute comparison IBdeFilterExpression. This can be set to the IBdeFilter using the setExpression(com.ssaglobal.bde.IBdeFilterExpression) method. Two Comparison Expressios can be combined using Logical Expressions.

Parameters:

attribute1 - which needs to be used in the comparison. The Generated BDE proxy provides constants for those attributes.

attribute2 - which needs to be used in the comparison. The Generated BDE proxy provides constants for those attributes. *

Returns:

IBdeFilterExpression object

createAttributeComparisonGreater

public IBdeFilterExpression createAttributeComparisonGreater(java.lang.String attribute1,
                                                             java.lang.String attribute2)

Creates a 'greater' Attribute comparison IBdeFilterExpression. This can be set to the IBdeFilter using the setExpression(com.ssaglobal.bde.IBdeFilterExpression) method. Two Comparison Expressios can be combined using Logical Expressions.

Parameters:

attribute1 - which needs to be used in the comparison. The Generated BDE proxy provides constants for those attributes.

attribute2 - which needs to be used in the comparison. The Generated BDE proxy provides constants for those attributes. *

Returns:

IBdeFilterExpression object

createAttributeComparisonGreaterOrEqual

public IBdeFilterExpression createAttributeComparisonGreaterOrEqual(java.lang.String attribute1,
                                                                    java.lang.String attribute2)

Creates a 'greater or equal' Attribute comparison IBdeFilterExpression. This can be set to the IBdeFilter using the setExpression(com.ssaglobal.bde.IBdeFilterExpression) method. Two Comparison Expressios can be combined using Logical Expressions.

Parameters:

attribute1 - which needs to be used in the comparison. The Generated BDE proxy provides constants for those attributes.

attribute2 - which needs to be used in the comparison. The Generated BDE proxy provides constants for those attributes. *

Returns:

IBdeFilterExpression object