Class FilterExprDefinition
java.lang.Object
org.eclipse.birt.report.model.api.filterExtension.FilterExprDefinition
- All Implemented Interfaces:
IFilterExprDefinition
FilterExprDefinition
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected String
BIRT predefined filter expression operator display name.protected String
Filter operator defined by BIRT.protected int
The max number of arguments that this filter operator required.protected int
The min number of arguments that this filter operator required.protected boolean
Indicates if this filter operator expression support unlimited max number of arguments.protected static final int
Fields inherited from interface org.eclipse.birt.report.model.api.filterExtension.interfaces.IFilterExprDefinition
BIRT_SUPPORT_ONLY, EXPR_MAPPING_SUPPORTED, EXTENSION_SUPPORT_ONLY
-
Constructor Summary
ConstructorsConstructorDescriptionFilterExprDefinition
(String birtFilterExpr) Constructor for FilterExprDefinition by BIRT predefined filter expression operator id. -
Method Summary
Modifier and TypeMethodDescriptionint
Returns the expression supported type of this FilterExprDefinition.Return the corresponding BIRT predefined Filter expression operator display name.getBirtFilterExprDisplayName
(com.ibm.icu.util.ULocale locale) Return the corresponding BIRT predefined Filter expression operator display name.Returns the BIRT predefined filter expression operator internal name.Returns the display name of this Filter expression.Returns the ODA filter extension filter expression id if there is.Returns the number of arguments that this filter definition can maximize supported.Returns the min arguments required by this filter expression definition.Returns the ODA filter extension provider ID if there is.protected void
initBirtExpr
(int birtOperator) boolean
Indicates whether the expression is mapped to the negated data base expression, i.e.boolean
supportsAPIDataType
(int apiDataType) Indicates whether the given API type is supported by this filter operator.boolean
Indicates if this filter definition support unbounded max arguments.
-
Field Details
-
UNDEFINED
protected static final int UNDEFINED- See Also:
-
birtFilterExprId
Filter operator defined by BIRT. -
birtFilterDisplayName
BIRT predefined filter expression operator display name. -
minArgs
protected int minArgsThe min number of arguments that this filter operator required. -
maxArgs
protected int maxArgsThe max number of arguments that this filter operator required. -
supportUnboundedMaxArgs
protected boolean supportUnboundedMaxArgsIndicates if this filter operator expression support unlimited max number of arguments.
-
-
Constructor Details
-
FilterExprDefinition
public FilterExprDefinition() -
FilterExprDefinition
Constructor for FilterExprDefinition by BIRT predefined filter expression operator id. The instance returned is not mapped to any external ODA extension filter.- Parameters:
birtFilterExpr
- BIRT predefined filter expression operator Id.- Throws:
IllegalArgumentException
-
-
Method Details
-
expressionSupportedType
public int expressionSupportedType()Description copied from interface:IFilterExprDefinition
Returns the expression supported type of this FilterExprDefinition. The returned type could be:- BIRT_SUPPORT_ONLY
- EXTENSION_SUPPORT_ONLY
- EXPR_MAPPING_SUPPORTED
- Specified by:
expressionSupportedType
in interfaceIFilterExprDefinition
- Returns:
- the expression supported type.
-
getBirtFilterExprId
Description copied from interface:IFilterExprDefinition
Returns the BIRT predefined filter expression operator internal name.- Specified by:
getBirtFilterExprId
in interfaceIFilterExprDefinition
- Returns:
- BIRT predefined filter operator internal name, if there is. Return Null if this definition is not mapped to a BIRT predefined filter expression.
-
getBirtFilterExprDisplayName
Description copied from interface:IFilterExprDefinition
Return the corresponding BIRT predefined Filter expression operator display name.- Specified by:
getBirtFilterExprDisplayName
in interfaceIFilterExprDefinition
- Returns:
- BIRT predefined filter operator name, if there is. Null, if there is no mapped one.
-
getExtFilterDisplayName
Description copied from interface:IFilterExprDefinition
Returns the display name of this Filter expression.- Specified by:
getExtFilterDisplayName
in interfaceIFilterExprDefinition
- Returns:
- display name of the filter expression.
-
getExtFilterExprId
Description copied from interface:IFilterExprDefinition
Returns the ODA filter extension filter expression id if there is.- Specified by:
getExtFilterExprId
in interfaceIFilterExprDefinition
- Returns:
- ODA extension filter expression id if there is. Null, if not applicable.
-
getMaxArguments
Description copied from interface:IFilterExprDefinition
Returns the number of arguments that this filter definition can maximize supported.- Specified by:
getMaxArguments
in interfaceIFilterExprDefinition
- Returns:
- the maximal number of arguments.
-
getMinArguments
Description copied from interface:IFilterExprDefinition
Returns the min arguments required by this filter expression definition.- Specified by:
getMinArguments
in interfaceIFilterExprDefinition
- Returns:
- the min number of arguments that required by this filter definition.
-
getProviderExtensionId
Description copied from interface:IFilterExprDefinition
Returns the ODA filter extension provider ID if there is.- Specified by:
getProviderExtensionId
in interfaceIFilterExprDefinition
- Returns:
- ODA filter extension provider ID, if there is. Null, if there is no ODA extension filter applicable.
-
supportsUnboundedMaxArguments
public boolean supportsUnboundedMaxArguments()Description copied from interface:IFilterExprDefinition
Indicates if this filter definition support unbounded max arguments.- Specified by:
supportsUnboundedMaxArguments
in interfaceIFilterExprDefinition
- Returns:
- true if it supported unbounded max arguments, false, if it does not support.
-
initBirtExpr
protected void initBirtExpr(int birtOperator) -
isNegatedExtExprId
public boolean isNegatedExtExprId()Description copied from interface:IFilterExprDefinition
Indicates whether the expression is mapped to the negated data base expression, i.e. the database expression should be nested within a NotExpression.One example is that: the database may use eq and negated eq to represent BIRT EQ and NE.
- Specified by:
isNegatedExtExprId
in interfaceIFilterExprDefinition
- Returns:
true
if mapped to a negated provider expression;false
otherwise.
-
getBirtFilterExprDisplayName
Description copied from interface:IFilterExprDefinition
Return the corresponding BIRT predefined Filter expression operator display name.- Specified by:
getBirtFilterExprDisplayName
in interfaceIFilterExprDefinition
- Returns:
- BIRT predefined filter operator name, if there is. Null, if there is no mapped one.
-
supportsAPIDataType
public boolean supportsAPIDataType(int apiDataType) Description copied from interface:IFilterExprDefinition
Indicates whether the given API type is supported by this filter operator.- Specified by:
supportsAPIDataType
in interfaceIFilterExprDefinition
- Parameters:
apiDataType
- the api data type- Returns:
true
if it is supported. Otherwise,false
.
-