public class FilterConditionElementHandle extends ContentElementHandle implements org.eclipse.birt.report.model.elements.interfaces.IFilterConditionElementModel
element
module
DYNAMIC_FILTER_PARAMETER_PROP, EXPR_PROP, EXTENSION_EXPR_ID_PROP, EXTENSION_NAME_PROP, FILTER_TARGET_PROP, IS_OPTIONAL_PROP, MEMBER_PROP, OPERATOR_PROP, PUSH_DOWN_PROP, TYPE_PROP, UPDATE_AGGREGATION_PROP, VALUE1_PROP, VALUE2_PROP
COMMENTS_PROP, CUSTOM_XML_PROP, DISPLAY_NAME_ID_PROP, DISPLAY_NAME_PROP, EVENT_HANDLER_CLASS_PROP, EXTENDS_PROP, FULL_LABEL, ID_SUFFIX, NAME_PROP, NEW_HANDLER_ON_EACH_EVENT_PROP, NO_SLOT, PROPERTY_MASKS_PROP, REF_TEMPLATE_PARAMETER_PROP, SHORT_LABEL, USER_LABEL, USER_PROPERTIES_PROP, VIEW_ACTION_PROP
Constructor and Description |
---|
FilterConditionElementHandle(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.core.DesignElement element)
Constructs a filter condition handle with the given design and the
element.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getDynamicFilterParameter()
Returns the name of the dynamic filter parameter to reference when the
filter condition is dynamic.
|
java.lang.String |
getExpr()
Returns the filter expression.
|
java.lang.String |
getExtensionExprId()
Returns the id of a custom filter expression contributed and defined by
the extension identified in the consumerExpressionMapping.
|
java.lang.String |
getExtensionName()
Returns the unique id of an
org.eclipse.datatools.connectivity.oda.filterExpressions extension to
whose custom expressions are defined to map to a BIRT filter operator.
|
java.lang.String |
getFilterTarget()
Returns the filter target.
|
MemberValueHandle |
getMember()
Gets the member value handle of this filter condition element if it sets.
|
java.lang.String |
getOperator()
Returns the operator of this filter condition.
|
java.lang.String |
getType()
Returns the type of this filter condition.
|
java.lang.String |
getValue1()
Returns the value 1 expression of this filter condition.
|
ExpressionListHandle |
getValue1ExpressionList()
Gets the value1 expression list of this filter condition.
|
java.util.List |
getValue1List()
Deprecated.
|
java.lang.String |
getValue2()
Returns the value 2 expression of this filter condition.
|
boolean |
isOptional()
Determines whether this filter condition is optional or not.
|
boolean |
pushDown()
Indicate if the current filter condition will be pushed down to the
database.
|
void |
setDynamicFilterParameter(java.lang.String parameterName)
Sets the name of the dynamic filter parameter to reference.
|
void |
setExpr(java.lang.String filterExpr)
Sets the filter expression.
|
void |
setExtensionExprId(java.lang.String extensionExprId)
Sets the id of a custom filter expression contributed and defined by the
extension identified in the consumerExpressionMapping.
|
void |
setExtensionName(java.lang.String extensionName)
Sets the unique id of an
org.eclipse.datatools.connectivity.oda.filterExpressions extension to
whose custom expressions are defined to map to a BIRT filter operator.
|
void |
setFilterTarget(java.lang.String filterTarget)
Sets the filter target.
|
void |
setOperator(java.lang.String operator)
Sets the operator of this filter condition.
|
void |
setOptional(boolean isOptional)
Sets the optional status for this filter condition.
|
void |
setPushDown(boolean pushDown)
Sets the push down status for this filter condition
|
void |
setType(java.lang.String type)
Sets the type of this filter condition.
|
void |
setUpdateAggregation(boolean updateAggregation)
Sets the updateAggregation flag of the filter condition.
|
void |
setValue1(java.util.List value1List)
Sets the value 1 expression list of this filter condition.
|
void |
setValue1(java.lang.String value1Expr)
Sets the value 1 expression of this filter condition.
|
void |
setValue2(java.lang.String value2Expr)
Sets the value 2 expression of this filter condition.
|
boolean |
updateAggregation()
Checks if this filter condition needs to update aggregation.
|
addListener, canTransformToTemplate, clientsIterator, createTemplateElement, derivedIterator, getElement, getEventHandlerClass, getExtends, getName, getPrivateStyle, getQualifiedName, isTemplateParameterValue, localize, removeListener, revertToReportItem, revertToTemplate, setEventHandlerClass, setExtends, setExtendsName, setName, setStyle, setStyleName
add, add, addElement, addElement, addUserPropertyDefn, cachePropertyHandles, canContain, canContain, canContain, canContain, canDrop, canEdit, clearAllProperties, clearContents, clearProperty, copy, copyPropertyTo, doSort, drop, drop, drop, dropAndClear, dropAndClear, dropAndClear, dropUserPropertyDefn, findContentSlot, getBooleanProperty, getChoices, getColorProperty, getContainer, getContainerPropertyHandle, getContainerSlotHandle, getContent, getContentCount, getContents, getDefn, getDesign, getDesignHandle, getDimensionProperty, getDisplayLabel, getDisplayLabel, getDisplayProperty, getEffectiveModule, getElementFactory, getElementProperty, getExpressionProperty, getExternalizedValue, getExternalizedValue, getExternalizedValue, getFactoryElementHandle, getFactoryPropertyHandle, getFloatProperty, getFontProperty, getFullName, getHostViewHandle, getID, getIndex, getIntProperty, getListProperty, getListProperty, getMethods, getModule, getModuleHandle, getNumberProperty, getProperty, getPropertyBinding, getPropertyBindingExpression, getPropertyBindings, getPropertyDefn, getPropertyHandle, getPropertyIterator, getRoot, getSemanticErrors, getSlot, getStringProperty, getStyle, getUserProperties, getUserPropertyDefnHandle, getXPath, hasLocalProperties, hasSemanticError, initializeSlotHandles, isDirectionRTL, isInTemplateParameter, isValid, move, move, moveTo, moveTo, moveTo, moveTo, newHandlerOnEachEvent, paste, paste, paste, paste, semanticCheck, setBooleanProperty, setEncryption, setExpressionProperty, setExtendsElement, setFloatProperty, setIntProperty, setNewHandlerOnEachEvent, setNumberProperty, setProperties, setProperty, setPropertyBinding, setPropertyBinding, setStringProperty, setStyleElement, setValid, shift, showError, slotsIterator
public FilterConditionElementHandle(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
module
- the moduleelement
- the model representation of the elementpublic java.lang.String getExpr()
public void setExpr(java.lang.String filterExpr) throws SemanticException
filterExpr
- the filter expression to setSemanticException
- value required exceptionpublic java.lang.String getOperator()
DesignChoiceConstants
,
and they are:
FILTER_OPERATOR_EQ
FILTER_OPERATOR_NE
FILTER_OPERATOR_LT
FILTER_OPERATOR_LE
FILTER_OPERATOR_GE
FILTER_OPERATOR_GT
FILTER_OPERATOR_BETWEEN
FILTER_OPERATOR_NOT_BETWEEN
FILTER_OPERATOR_NULL
FILTER_OPERATOR_NOT_NULL
FILTER_OPERATOR_TRUE
FILTER_OPERATOR_FALSE
FILTER_OPERATOR_LIKE
FILTER_OPERATOR_TOP_N
FILTER_OPERATOR_BOTTOM_N
FILTER_OPERATOR_TOP_PERCENT
FILTER_OPERATOR_BOTTOM_PERCENT
FILTER_OPERATOR_ANY
public void setOperator(java.lang.String operator) throws SemanticException
DesignChoiceConstants
,
and they are:
FILTER_OPERATOR_EQ
FILTER_OPERATOR_NE
FILTER_OPERATOR_LT
FILTER_OPERATOR_LE
FILTER_OPERATOR_GE
FILTER_OPERATOR_GT
FILTER_OPERATOR_BETWEEN
FILTER_OPERATOR_NOT_BETWEEN
FILTER_OPERATOR_NULL
FILTER_OPERATOR_NOT_NULL
FILTER_OPERATOR_TRUE
FILTER_OPERATOR_FALSE
FILTER_OPERATOR_LIKE
FILTER_OPERATOR_TOP_N
FILTER_OPERATOR_BOTTOM_N
FILTER_OPERATOR_TOP_PERCENT
FILTER_OPERATOR_BOTTOM_PERCENT
FILTER_OPERATOR_ANY
operator
- the operator to setSemanticException
- if operator is not in the choice list.public java.lang.String getValue1()
public java.util.List getValue1List()
getValue1ExpressionList()
public ExpressionListHandle getValue1ExpressionList()
public void setValue1(java.lang.String value1Expr) throws SemanticException
value1Expr
- the value 1 expression to setSemanticException
public void setValue1(java.util.List value1List) throws SemanticException
value1List
- the value 1 expression list to setSemanticException
- if the instance in the list is not validpublic java.lang.String getValue2()
public void setValue2(java.lang.String value2Expr) throws SemanticException
value2Expr
- the value 2 expression to setSemanticException
public java.lang.String getFilterTarget()
DesignChoiceConstants
,
and they are:
FILTER_TARGET_DATA_SET
FILTER_TARGET_RESULT_SET
public void setFilterTarget(java.lang.String filterTarget) throws SemanticException
DesignChoiceConstants
,
and they are:
FILTER_TARGET_DATA_SET
FILTER_TARGET_RESULT_SET
filterTarget
- the filter target to setSemanticException
- if the value is not one of the above.public MemberValueHandle getMember()
public boolean isOptional()
public void setOptional(boolean isOptional) throws SemanticException
isOptional
- true if this filter is optional, otherwise falseSemanticException
public java.lang.String getExtensionName()
public java.lang.String getExtensionExprId()
public boolean pushDown()
public java.lang.String getDynamicFilterParameter()
public void setExtensionName(java.lang.String extensionName) throws SemanticException
extensionName
- the extension name to setSemanticException
public void setExtensionExprId(java.lang.String extensionExprId) throws SemanticException
extensionExprId
- the id to setSemanticException
public void setPushDown(boolean pushDown) throws SemanticException
pushDown
- true if the current filter condition will be pushed down to
the database, otherwise false.SemanticException
public void setDynamicFilterParameter(java.lang.String parameterName) throws SemanticException
parameterName
- the name of the dynamic filter parameter to setSemanticException
public java.lang.String getType()
DesignChoiceConstants
,
and they are:
FILTER_CONDITION_TYPE_SLICER
FILTER_CONDITION_TYPE_SIMPLE
public void setType(java.lang.String type) throws SemanticException
DesignChoiceConstants
,
and they are:
FILTER_CONDITION_TYPE_SLICER
FILTER_CONDITION_TYPE_SIMPLE
type
- the type to setSemanticException
- if type is not in the choice list.public boolean updateAggregation()
public void setUpdateAggregation(boolean updateAggregation) throws SemanticException
updateAggregation
- the updateAggregation flag to setSemanticException
Copyright © 2008 Actuate Corp. All rights reserved.