org.eclipse.birt.report.model.api
Class FilterConditionElementHandle

java.lang.Object
  extended by org.eclipse.birt.report.model.api.DesignElementHandle
      extended by org.eclipse.birt.report.model.api.ContentElementHandle
          extended by org.eclipse.birt.report.model.api.FilterConditionElementHandle
All Implemented Interfaces:
org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel, org.eclipse.birt.report.model.elements.interfaces.IFilterConditionElementModel

public class FilterConditionElementHandle
extends ContentElementHandle
implements org.eclipse.birt.report.model.elements.interfaces.IFilterConditionElementModel


Field Summary
 
Fields inherited from class org.eclipse.birt.report.model.api.ContentElementHandle
element
 
Fields inherited from class org.eclipse.birt.report.model.api.DesignElementHandle
module
 
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IFilterConditionElementModel
EXPR_PROP, FILTER_TARGET_PROP, IS_OPTIONAL_PROP, MEMBER_PROP, OPERATOR_PROP, VALUE1_PROP, VALUE2_PROP
 
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel
COMMENTS_PROP, CUSTOM_XML_PROP, DISPLAY_NAME_ID_PROP, DISPLAY_NAME_PROP, EVENT_HANDLER_CLASS_PROP, EXTENDS_PROP, FULL_LABEL, ID_SUFFIX, NAME_PROP, NO_SLOT, PROPERTY_MASKS_PROP, REF_TEMPLATE_PARAMETER_PROP, SHORT_LABEL, USER_LABEL, USER_PROPERTIES_PROP, VIEW_ACTION_PROP
 
Constructor Summary
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.
 
Method Summary
 java.lang.String getExpr()
          Returns the filter expression.
 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 getValue1()
          Returns the value 1 expression of this filter condition.
 java.util.List getValue1List()
          Gets the value1 expression list of this filter condition.
 java.lang.String getValue2()
          Returns the value 2 expression of this filter condition.
 boolean isOptional()
          Determines whether this filte rcondition is optional or not.
 void setExpr(java.lang.String filterExpr)
          Sets the filter expression.
 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 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.
 
Methods inherited from class org.eclipse.birt.report.model.api.ContentElementHandle
addListener, addUserPropertyDefn, canTransformToTemplate, clientsIterator, createTemplateElement, derivedIterator, getElement, getEventHandlerClass, getExtends, getName, getPrivateStyle, getQualifiedName, getUserProperties, getUserPropertyDefnHandle, isTemplateParameterValue, localize, removeListener, revertToReportItem, revertToTemplate, setEventHandlerClass, setExtends, setExtendsName, setName, setStyle, setStyleName
 
Methods inherited from class org.eclipse.birt.report.model.api.DesignElementHandle
add, add, addElement, addElement, 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, getExternalizedValue, getExternalizedValue, getExternalizedValue, getFactoryPropertyHandle, getFloatProperty, getFontProperty, getFullName, getHostViewHandle, getID, getIndex, getIntProperty, getListProperty, getListProperty, getMethods, getModule, getModuleHandle, getNumberProperty, getProperty, getPropertyBinding, getPropertyBindings, getPropertyDefn, getPropertyHandle, getPropertyIterator, getRoot, getSemanticErrors, getSlot, getStringProperty, getStyle, getXPath, hasLocalProperties, hasSemanticError, initializeSlotHandles, isDirectionRTL, isInTemplateParameter, isValid, move, move, moveTo, moveTo, moveTo, moveTo, paste, paste, paste, paste, semanticCheck, setEncryption, setExtendsElement, setFloatProperty, setIntProperty, setNumberProperty, setProperties, setProperty, setPropertyBinding, setStringProperty, setStyleElement, setValid, shift, showError
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FilterConditionElementHandle

public 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. The application generally does not create handles directly. Instead, it uses one of the navigation methods available on other element handles.

Parameters:
module - the module
element - the model representation of the element
Method Detail

getExpr

public java.lang.String getExpr()
Returns the filter expression.

Returns:
the filter expression

setExpr

public void setExpr(java.lang.String filterExpr)
             throws SemanticException
Sets the filter expression.

Parameters:
filterExpr - the filter expression to set
Throws:
SemanticException - value required exception

getOperator

public java.lang.String getOperator()
Returns the operator of this filter condition. The possible values are defined in DesignChoiceConstants, and they are:

Returns:
the operator of this filter condition

setOperator

public void setOperator(java.lang.String operator)
                 throws SemanticException
Sets the operator of this filter condition. The allowed values are defined in DesignChoiceConstants, and they are:

Parameters:
operator - the operator to set
Throws:
SemanticException - if operator is not in the choice list.

getValue1

public java.lang.String getValue1()
Returns the value 1 expression of this filter condition.

Returns:
the value 1 expression of this filter condition

getValue1List

public java.util.List getValue1List()
Gets the value1 expression list of this filter condition. For most filter operator, there is only one expression in the returned list. However, filter operator 'in' may contain more than one expression.

Returns:
the value1 expression list of this filter condition.

setValue1

public void setValue1(java.lang.String value1Expr)
               throws SemanticException
Sets the value 1 expression of this filter condition.

Parameters:
value1Expr - the value 1 expression to set
Throws:
SemanticException

setValue1

public void setValue1(java.util.List value1List)
               throws SemanticException
Sets the value 1 expression list of this filter condition.

Parameters:
value1List - the value 1 expression list to set
Throws:
SemanticException - if the instance in the list is not valid

getValue2

public java.lang.String getValue2()
Returns the value 2 expression of this filter condition.

Returns:
the value 2 expression of this filter condition

setValue2

public void setValue2(java.lang.String value2Expr)
               throws SemanticException
Sets the value 2 expression of this filter condition.

Parameters:
value2Expr - the value 2 expression to set
Throws:
SemanticException

getFilterTarget

public java.lang.String getFilterTarget()
Returns the filter target. The possible values are defined in DesignChoiceConstants, and they are:

Returns:
the target type

setFilterTarget

public void setFilterTarget(java.lang.String filterTarget)
                     throws SemanticException
Sets the filter target. The allowed values are defined in DesignChoiceConstants, and they are:

Parameters:
filterTarget - the filter target to set
Throws:
SemanticException - if the value is not one of the above.

getMember

public MemberValueHandle getMember()
Gets the member value handle of this filter condition element if it sets. Otherwise return null.

Returns:

isOptional

public boolean isOptional()
Determines whether this filte rcondition is optional or not.

Returns:
true if this filter is optional, otherwise false

setOptional

public void setOptional(boolean isOptional)
                 throws SemanticException
Sets the optional status for this filter condition.

Parameters:
isOptional - true if this filter is optional, otherwise false
Throws:
SemanticException


Copyright © 2008 Actuate Corp. All rights reserved.