Class ScalarParameterHandle
java.lang.Object
org.eclipse.birt.report.model.api.DesignElementHandle
org.eclipse.birt.report.model.api.ReportElementHandle
org.eclipse.birt.report.model.api.ParameterHandle
org.eclipse.birt.report.model.api.AbstractScalarParameterHandleImpl
org.eclipse.birt.report.model.api.AbstractScalarParameterHandle
org.eclipse.birt.report.model.api.ScalarParameterHandle
- All Implemented Interfaces:
org.eclipse.birt.report.model.elements.interfaces.IAbstractScalarParameterModel,org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel,org.eclipse.birt.report.model.elements.interfaces.IInternalAbstractScalarParameterModel,org.eclipse.birt.report.model.elements.interfaces.IParameterModel,org.eclipse.birt.report.model.elements.interfaces.IScalarParameterModel
public class ScalarParameterHandle
extends AbstractScalarParameterHandle
implements org.eclipse.birt.report.model.elements.interfaces.IScalarParameterModel
Represents a scalar (single-value) report parameter. If the user enters no
value for a parameter, then the default value is used. If there is no default
value, then BIRT checks if
null is allowed. If so, the value of
the parameter is null. If nulls are not allowed, then the user must enter a
value.
Scalar parameters can have static or dynamic selection lists.
- The parameter static selection list provides a developer-defined list of choices. Every choice has two parts: a choice and a label. The label can be externalized and appears in the UI. The choice is the value passed to the report.
- This parameter can define a dynamic selection list for the parameter. The data set can reference other parameters by referring to a data set. The data set must return a column that contains the choice values. It may also contain a column that returns the labels for the values. All other columns are ignored.
- See Also:
-
ScalarParameterParameterHandle
-
Field Summary
Fields inherited from class org.eclipse.birt.report.model.api.ReportElementHandle
elementFields inherited from class org.eclipse.birt.report.model.api.DesignElementHandle
moduleFields 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, NEW_HANDLER_ON_EACH_EVENT_PROP, NO_SLOT, PROPERTY_MASKS_PROP, REF_TEMPLATE_PARAMETER_PROP, SHORT_LABEL, USER_LABEL, USER_PROPERTIES_PROP, VIEW_ACTION_PROPFields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IInternalAbstractScalarParameterModel
CONTROL_TYPE_PROP, DATA_TYPE_PROP, DATASET_NAME_PROP, DEFAULT_VALUE_PROP, DISTINCT_PROP, IS_REQUIRED_PROP, LABEL_EXPR_PROP, LIST_LIMIT_PROP, SELECTION_LIST_PROP, SORT_BY_COLUMN_PROP, SORT_BY_PROP, SORT_DIRECTION_PROP, VALUE_EXPR_PROP, VALUE_TYPE_PROPFields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IParameterModel
HELP_TEXT_KEY_PROP, HELP_TEXT_PROP, HIDDEN_PROP, PROMPT_TEXT_ID_PROP, PROMPT_TEXT_PROP, VALIDATE_PROPFields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IScalarParameterModel
ALIGNMENT_PROP, ALLOW_BLANK_PROP, ALLOW_NULL_PROP, AUTO_SUGGEST_THRESHOLD_PROP, BOUND_DATA_COLUMNS_PROP, CONCEAL_VALUE_PROP, FIXED_ORDER_PROP, FORMAT_PROP, GET_DEFAULT_VALUE_LIST_PROP, GET_SELECTION_VALUE_LIST_PROP, MUCH_MATCH_PROP, PARAM_TYPE_PROP -
Constructor Summary
ConstructorsConstructorDescriptionScalarParameterHandle(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element) Constructs a handle for the ScalarParamter with the given design and the parameter. -
Method Summary
Modifier and TypeMethodDescriptionaddColumnBinding(ComputedColumn addColumn, boolean inForce) Adds a bound column to the list.booleanDeprecated.booleanDeprecated.Iterator<?>Returns the bound columns that binds the data set columns.Returns the alignment for this parameter.intReturns the maximal number of of entries a report parameter pick list can have.Returns the category for the parameter format.Get a handle to deal with the bound column.Returns the control type for this parameter.Deprecated.since 2.5 replaced byAbstractScalarParameterHandleImpl.getDefaultValueList()Gets the method content ofgetDefaultValueList.Deprecated.replaced by getPattern and getCategory.Deprecated.Replaced by the methodAbstractScalarParameterHandleImpl.getLabelExpr()intget the list limited number.Returns the parameter type for this scalar parameter.Returns the pattern of format instructions for the parameter value.getProperty(String propName) Returns the value of a property as a generic object.Gets the method content ofgetSelectionValueList.getType()Deprecated.Replaced by the methodAbstractScalarParameterHandleImpl.getDataType()Deprecated.Replaced by the methodAbstractScalarParameterHandleImpl.getValueExpr()booleanTests whether hides the user's entry by displaying asterisks.booleanTests whether to display values in the order defined in the list.booleanTests whether the value must match one of values in the selection list.voidRemoved unused bound columns from the parameter.voidsetAlignment(String align) Sets the alignment for this parameter.voidsetAllowBlank(boolean allowBlank) Deprecated.voidsetAllowNull(boolean allowNull) Deprecated.voidsetAutoSuggestThreshold(int number) Sets the maximal number of of entries a report parameter pick list can have.voidsetCategory(String category) Sets the category for the parameter format.voidsetConcealValue(boolean concealValue) Sets the attribute that's hides the user's entry by displaying asterisks.voidsetControlType(String controlType) Sets the control type for this parameter.voidsetDefaultValue(String defaultValue) Deprecated.since 2.5 replaced byAbstractScalarParameterHandleImpl.setDefaultValueList(List)voidsetDefaultValueListMethod(String getDefaultValueListMethod) Sets the method content ofgetDefaultValueList.voidsetFixedOrder(boolean fixedOrder) Sets the flag indicates that whether to display values in the order defined in the list.voidDeprecated.replaced by setPattern and setCategory.voidsetLabelColumn(String labelColumn) Deprecated.Replaced by the methodAbstractScalarParameterHandleImpl.setLabelExpr(String)voidsetMustMatch(boolean mustMatch) Sets the flag indicates that whether the value must match one of values in the selection list.voidsetParamType(String type) Sets the parameter type for this scalar parameter.voidsetPattern(String pattern) Sets the pattern of format instructions for the parameter value.voidsetProperty(String propName, Object value) Sets the value of a property from a generic object.voidsetSelectionValueListMethod(String getSelectionValueListMethod) Sets the method content ofgetSelectionValueList.voidDeprecated.Replaced by the methodAbstractScalarParameterHandleImpl.setDataType(String)voidsetValueColumn(String valueColumn) Deprecated.Replaced by the methodAbstractScalarParameterHandleImpl.setValueExpr(String)Methods inherited from class org.eclipse.birt.report.model.api.AbstractScalarParameterHandleImpl
choiceIterator, distinct, getDataSet, getDataSetName, getDataType, getDefaultValueList, getLabelExpr, getSortBy, getSortByColumn, getSortDirection, getValueExpr, getValueType, isRequired, setDataSet, setDataSetName, setDataType, setDefaultValueList, setDistinct, setIsRequired, setLabelExpr, setListlimit, setSortBy, setSortByColumn, setSortDirection, setValueExpr, setValueTypeMethods inherited from class org.eclipse.birt.report.model.api.ParameterHandle
getDisplayPromptText, getHelpText, getHelpTextKey, getPromptText, getPromptTextID, getValidate, isHidden, setHelpText, setHelpTextKey, setHidden, setPromptText, setPromptTextID, setValidateMethods inherited from class org.eclipse.birt.report.model.api.ReportElementHandle
getComments, getCustomXml, getDisplayName, getDisplayNameKey, getElement, getPropertyMask, isValidLayoutForCompoundElement, isValidReferenceForCompoundElement, propertyMaskIterator, setComments, setCustomXml, setDisplayName, setDisplayNameKey, setPropertyMaskMethods inherited from class org.eclipse.birt.report.model.api.DesignElementHandle
add, add, addElement, addElement, addListener, addUserPropertyDefn, cachePropertyHandles, canContain, canContain, canContain, canContain, canDrop, canEdit, canTransformToTemplate, clearAllProperties, clearContents, clearProperty, clientsIterator, copy, copyPropertyTo, createTemplateElement, derivedIterator, 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, getEventHandlerClass, getExpressionProperty, getExtends, getExternalizedValue, getExternalizedValue, getExternalizedValue, getFactoryElementHandle, getFactoryPropertyHandle, getFloatProperty, getFontProperty, getFullName, getHostViewHandle, getID, getIndex, getIntProperty, getListProperty, getListProperty, getMethods, getModule, getModuleHandle, getName, getNumberProperty, getPrivateStyle, getPropertyBinding, getPropertyBindingExpression, getPropertyBindings, getPropertyDefn, getPropertyHandle, getPropertyIterator, getQualifiedName, getRoot, getSemanticErrors, getSlot, getStringProperty, getStyle, getUserProperties, getUserPropertyDefnHandle, getXPath, hasLocalProperties, hasSemanticError, initializeSlotHandles, isDirectionRTL, isInTemplateParameter, isTemplateParameterValue, isValid, localize, move, move, moveTo, moveTo, moveTo, moveTo, newHandlerOnEachEvent, paste, paste, paste, paste, removeListener, revertToReportItem, revertToTemplate, semanticCheck, setBooleanProperty, setEncryption, setEventHandlerClass, setExpressionProperty, setExtends, setExtendsElement, setExtendsName, setFloatProperty, setIntProperty, setName, setNewHandlerOnEachEvent, setNumberProperty, setProperties, setPropertyBinding, setPropertyBinding, setStringProperty, setStyle, setStyleElement, setStyleName, setValid, shift, showError, slotsIterator
-
Constructor Details
-
ScalarParameterHandle
public ScalarParameterHandle(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element) Constructs a handle for the ScalarParamter with the given design and the parameter. The application generally does not create handles directly. Instead, it uses one of the navigation methods available on other element handles.- Parameters:
module- the moduleelement- the model representation of the element
-
-
Method Details
-
getDefaultValue
Deprecated.since 2.5 replaced byAbstractScalarParameterHandleImpl.getDefaultValueList()Returns the first default value of the parameter. The default value can be an expression, but cannot reference any other parameters. The default value of this parameter can be a list. This method returns the first value if exists.- Returns:
- the default value
-
setDefaultValue
Deprecated.since 2.5 replaced byAbstractScalarParameterHandleImpl.setDefaultValueList(List)Sets the default value of the parameter. The default value can be an expression, but cannot reference any other parameters.- Parameters:
defaultValue- the default value for the parameter- Throws:
SemanticException- if the property is locked.
-
isConcealValue
public boolean isConcealValue()Tests whether hides the user's entry by displaying asterisks. Often used for passwords.- Returns:
trueif hides the user's entry by asterisks,falseif shows characters as usual.
-
setConcealValue
Sets the attribute that's hides the user's entry by displaying asterisks. Often used for passwords.- Parameters:
concealValue-trueif hides the user's entry by asterisks,falseif shows characters as usual.- Throws:
SemanticException- if the property is locked.
-
allowNull
Deprecated.Tests whether the value of the parameter can benull.- Returns:
trueif the value can benull,falseif the value can not benull.
-
setAllowNull
Deprecated.Sets the flag that indicates whether the value of the parameter can benull.- Parameters:
allowNull-trueif the value can benull,falseif the value can not benull.- Throws:
SemanticException- if the property is locked.
-
allowBlank
Deprecated.Tests whether the string value of the parameter can benull.- Returns:
trueif the value can benull,falseif the value can not benull.
-
setAllowBlank
Deprecated.Sets the flag that indicates whether the string value of the parameter can benull.- Parameters:
allowBlank-trueif the value can benull,falseif the value can not benull.- Throws:
SemanticException- if the property is locked.
-
getFormat
Deprecated.replaced by getPattern and getCategory.Returns the format instructions for the parameter value. The format is used by the UI to display the value.- Returns:
- the format for the parameter value
-
getPattern
Returns the pattern of format instructions for the parameter value. The format is used by the UI to display the value.- Returns:
- the pattern of format for the parameter value
-
getCategory
Returns the category for the parameter format. The format is used by the UI to display the value.- Returns:
- the category for the parameter format
-
setFormat
Deprecated.replaced by setPattern and setCategory.Sets the format instructions for the parameter value. The format is used by the UI to display the value.- Parameters:
format- the format for the parameter value- Throws:
SemanticException- if the property is locked.
-
setPattern
Sets the pattern of format instructions for the parameter value. The format is used by the UI to display the value.- Parameters:
pattern- the format for the parameter value- Throws:
SemanticException- if the property is locked.
-
setCategory
Sets the category for the parameter format. The format is used by the UI to display the value.- Parameters:
category- the category for the format- Throws:
SemanticException- if the property is locked.
-
getControlType
Returns the control type for this parameter. Control types are one of constants defined inDesignChoiceConstants:- PARAM_CONTROL_TEXT_BOX
- PARAM_CONTROL_LIST_BOX
- PARAM_CONTROL_COMBOBOX
- PARAM_CONTROL_RADIO_BUTTON
- PARAM_CONTROL_CHECK_BOX
- PARAM_CONTROL_AUTO_SUGGEST
- Returns:
- the control type for the UI to display the parameter
- See Also:
-
getListlimit
public int getListlimit()get the list limited number.- Overrides:
getListlimitin classAbstractScalarParameterHandleImpl- Returns:
- the display prompt.
-
setControlType
Sets the control type for this parameter. Control types are one of constants defined inDesignChoiceConstants:- PARAM_CONTROL_TEXT_BOX
- PARAM_CONTROL_LIST_BOX
- PARAM_CONTROL_COMBOBOX
- PARAM_CONTROL_RADIO_BUTTON
- PARAM_CONTROL_CHECK_BOX
- PARAM_CONTROL_AUTO_SUGGEST
- Parameters:
controlType- the control type for the UI to display the parameter- Throws:
SemanticException- if the input type is not one of above choices.- See Also:
-
getAlignment
Returns the alignment for this parameter. Alignments can be one of the constants defined inDesignChoiceConstants:SCALAR_PARAM_ALIGN_AUTOSCALAR_PARAM_ALIGN_LEFTSCALAR_PARAM_ALIGN_CENTERSCALAR_PARAM_ALIGN_RIGHT
- Returns:
- the alignment for the UI to display the parameter
- See Also:
-
setAlignment
Sets the alignment for this parameter. Alignments can be one of the constants defined inDesignChoiceConstants:SCALAR_PARAM_ALIGN_AUTOSCALAR_PARAM_ALIGN_LEFTSCALAR_PARAM_ALIGN_CENTERSCALAR_PARAM_ALIGN_RIGHT
- Parameters:
align- the alignment for the UI to display the parameter- Throws:
SemanticException- if the input type is not one of above choices.- See Also:
-
isMustMatch
public boolean isMustMatch()Tests whether the value must match one of values in the selection list.- Returns:
trueif the value must match one of values in the list, otherwisefalse.
-
setMustMatch
Sets the flag indicates that whether the value must match one of values in the selection list.- Parameters:
mustMatch-trueif the value must match one of values in the list, otherwisefalse.- Throws:
SemanticException- if the property is locked.
-
isFixedOrder
public boolean isFixedOrder()Tests whether to display values in the order defined in the list.- Returns:
trueif to display value in the order, otherwisefalse.
-
setFixedOrder
Sets the flag indicates that whether to display values in the order defined in the list.- Parameters:
fixedOrder-trueif to display values in the order, otherwisefalse.- Throws:
SemanticException- if the property is locked.
-
getValueColumn
Deprecated.Replaced by the methodAbstractScalarParameterHandleImpl.getValueExpr()Returns the name of the query column that returns values for the choice of the dynamic list for this parameter.- Returns:
- the the name of the query column
-
setValueColumn
Deprecated.Replaced by the methodAbstractScalarParameterHandleImpl.setValueExpr(String)Sets the name of the query column that returns values for the choice of the dynamic list for this parameter.- Parameters:
valueColumn- the name of the query column- Throws:
SemanticException- if the property is locked.
-
getLabelColumn
Deprecated.Replaced by the methodAbstractScalarParameterHandleImpl.getLabelExpr()Returns the name of the query column that returns the prompt for the choice of the dynamic list for this parameter.- Returns:
- the the name of the query column
-
setLabelColumn
Deprecated.Replaced by the methodAbstractScalarParameterHandleImpl.setLabelExpr(String)Sets the name of the query column that returns the prompt for the choice of the dynamic list for this parameter.- Parameters:
labelColumn- the name of the query column- Throws:
SemanticException- if the property is locked.
-
getType
Deprecated.Replaced by the methodAbstractScalarParameterHandleImpl.getDataType()Returns the data type for this parameter. The data type controls how the requester formats, parses and validates the parameter. Types are defined inDesignChoiceConstantscan be one of the followings:PARAM_TYPE_STRINGPARAM_TYPE_FLOATPARAM_TYPE_DECIMALPARAM_TYPE_INTEGERPARAM_TYPE_DATETIMEPARAM_TYPE_DATEPARAM_TYPE_TIMEPARAM_TYPE_BOOLEAN
- Returns:
- the type for the parameter
- See Also:
-
setType
Deprecated.Replaced by the methodAbstractScalarParameterHandleImpl.setDataType(String)Sets the data type for this parameter. The data type controls how the Requester formats, parses and validates the parameter. Types are defined inDesignChoiceConstantscan be one of the followings:PARAM_TYPE_STRINGPARAM_TYPE_FLOATPARAM_TYPE_DECIMALPARAM_TYPE_INTEGERPARAM_TYPE_DATETIMEPARAM_TYPE_DATEPARAM_TYPE_TIMEPARAM_TYPE_BOOLEAN
- Parameters:
type- the type for the parameter- Throws:
SemanticException- if the input type is not one of above choices.- See Also:
-
columnBindingsIterator
Returns the bound columns that binds the data set columns. The item in the iterator is the correspondingComputedColumnHandle.- Returns:
- a list containing the bound columns.
-
getColumnBindings
Get a handle to deal with the bound column.- Returns:
- a handle to deal with the bound data column.
-
addColumnBinding
public ComputedColumnHandle addColumnBinding(ComputedColumn addColumn, boolean inForce) throws SemanticException Adds a bound column to the list.- Parameters:
addColumn- the bound column to addinForce-truethe column is added to the list regardless of duplicate expression.falsedo not add the column if the expression already exist- Returns:
- the newly created
ComputedColumnHandleor the existedComputedColumnHandlein the list - Throws:
SemanticException- if expression is not duplicate but the name duplicates the existing bound column. Or, if the both name/expression are duplicate, butinForceistrue.
-
removedUnusedColumnBindings
Removed unused bound columns from the parameter. Bound columns of nested elements will not be removed.- Throws:
SemanticException- if bound column property is locked.
-
setProperty
Description copied from class:DesignElementHandleSets the value of a property from a generic object. The value can be any of the supported types: String, Double, Integer, BigDecimal or one of the specialized property types. The type of object allowed depends on the type of the property.- Overrides:
setPropertyin classDesignElementHandle- Parameters:
propName- the property namevalue- the value to set- Throws:
SemanticException- if the property is undefined on the element or the value is invalid.
-
getProperty
Description copied from class:DesignElementHandleReturns the value of a property as a generic object. The value is the internal property value, it is not localized. For a property with the element reference type, the reference element name is returned.- Overrides:
getPropertyin classDesignElementHandle- Parameters:
propName- the name of the property of interest- Returns:
- the value of the property. The type of the returned object depends on the property type.
- See Also:
-
getParamType
Returns the parameter type for this scalar parameter. Types are defined inDesignChoiceConstantscan be one of the followings:SCALAR_PARAM_TYPE_SIMPLESCALAR_PARAM_TYPE_MULTI_VALUESCALAR_PARAM_TYPE_AD_HOC
- Returns:
- the type for the parameter
- See Also:
-
setParamType
Sets the parameter type for this scalar parameter. Types are defined inDesignChoiceConstantscan be one of the followings:SCALAR_PARAM_TYPE_SIMPLESCALAR_PARAM_TYPE_MULTI_VALUESCALAR_PARAM_TYPE_AD_HOC
- Parameters:
type- the type for the parameter- Throws:
SemanticException- if the input type is not one of above choices.- See Also:
-
getAutoSuggestThreshold
public int getAutoSuggestThreshold()Returns the maximal number of of entries a report parameter pick list can have.- Returns:
- the threshold number.
-
setAutoSuggestThreshold
Sets the maximal number of of entries a report parameter pick list can have.- Parameters:
number- the threshold number.- Throws:
SemanticException
-
getDefaultValueListMethod
Gets the method content ofgetDefaultValueList.- Returns:
- the method content of
getDefaultValueList
-
setDefaultValueListMethod
Sets the method content ofgetDefaultValueList.- Parameters:
getDefaultValueListMethod- the method content ofgetDefaultValueListto set- Throws:
SemanticException
-
getSelectionValueListMethod
Gets the method content ofgetSelectionValueList.- Returns:
- the method content of
getSelectionValueList
-
setSelectionValueListMethod
public void setSelectionValueListMethod(String getSelectionValueListMethod) throws SemanticException Sets the method content ofgetSelectionValueList.- Parameters:
getSelectionValueListMethod- the method content ofgetSelectionValueListto set- Throws:
SemanticException
-
AbstractScalarParameterHandleImpl.isRequired()