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

java.lang.Object
  extended byorg.eclipse.birt.report.model.api.DesignElementHandle
      extended byorg.eclipse.birt.report.model.api.ReportElementHandle
          extended byorg.eclipse.birt.report.model.api.ParameterHandle
              extended byorg.eclipse.birt.report.model.api.ScalarParameterHandle
All Implemented Interfaces:
org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel, org.eclipse.birt.report.model.elements.interfaces.IParameterModel, org.eclipse.birt.report.model.elements.interfaces.IScalarParameterModel

public class ScalarParameterHandle
extends ParameterHandle
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.

See Also:
ScalarParameter, ParameterHandle

Field Summary
 
Fields inherited from class org.eclipse.birt.report.model.api.ReportElementHandle
element
 
Fields inherited from class org.eclipse.birt.report.model.api.DesignElementHandle
module
 
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IScalarParameterModel
ALIGNMENT_PROP, ALLOW_BLANK_PROP, ALLOW_NULL_PROP, CONCEAL_VALUE_PROP, CONTROL_TYPE_PROP, DATA_TYPE_PROP, DATASET_NAME_PROP, DEFAULT_VALUE_PROP, FIXED_ORDER_PROP, FORMAT_PROP, LABEL_EXPR_PROP, LIST_LIMIT_PROP, MUCH_MATCH_PROP, PROMPT_TEXT_PROP, SELECTION_LIST_PROP, VALUE_EXPR_PROP, VALUE_TYPE_PROP
 
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IParameterModel
HELP_TEXT_KEY_PROP, HELP_TEXT_PROP, HIDDEN_PROP, VALIDATE_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
 
Constructor Summary
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.
 
Method Summary
 boolean allowBlank()
          Tests whether the string value of the parameter can be null.
 boolean allowNull()
          Tests whether the value of the parameter can be null.
 java.util.Iterator choiceIterator()
          Returns the iterator for the static selection list defined on this scalar parameter.
 java.lang.String getAlignment()
          Returns the alignment for this parameter.
 java.lang.String getControlType()
          Returns the control type for this parameter.
 java.lang.String getDataSetName()
          Returns the data set name of the dynamic list for this parameter.
 java.lang.String getDataType()
          Returns the data type for this parameter.
 java.lang.String getDefaultValue()
          Returns the default value of the parameter.
 java.lang.String getFormat()
          Returns the format instructions for the parameter value.
 java.lang.String getLabelColumn()
          Deprecated. Replaced by the method getLabelExpr()
 java.lang.String getLabelExpr()
          Returns an expression on the data row from the dynamic list data set that returns the prompt for the choice.
 int getListlimit()
          get the list limited number.
 java.lang.String getPromptText()
          get the display prompt text.
 java.lang.String getType()
          Deprecated. Replaced by the method getDataType()
 java.lang.String getValueColumn()
          Deprecated. Replaced by the method getValueExpr()
 java.lang.String getValueExpr()
          Returns an expression on the data row from the dynamic list data set that returns the value for the choice.
 java.lang.String getValueType()
          Returns the parameter type for this scalar parameter.
 boolean isConcealValue()
          Tests whether hides the user's entry by displaying asterisks.
 boolean isFixedOrder()
          Tests whether to display values in the order defined in the list.
 boolean isMustMatch()
          Tests whether the value must match one of values in the selection list.
 void setAlignment(java.lang.String align)
          Sets the alignment for this parameter.
 void setAllowBlank(boolean allowNull)
          Sets the flag that indicates whether the string value of the parameter can be null.
 void setAllowNull(boolean allowNull)
          Sets the flag that indicates whether the value of the parameter can be null.
 void setConcealValue(boolean concealValue)
          Sets the attribute that's hides the user's entry by displaying asterisks.
 void setControlType(java.lang.String controlType)
          Sets the control type for this parameter.
 void setDataSetName(java.lang.String dataSetName)
          Sets the data set name of the dynamic list for this parameter.
 void setDataType(java.lang.String type)
          Sets the data type for this parameter.
 void setDefaultValue(java.lang.String defaultValue)
          Sets the default value of the parameter.
 void setFixedOrder(boolean fixedOrder)
          Sets the flag indicates that whether to display values in the order defined in the list.
 void setFormat(java.lang.String format)
          Sets the format instructions for the parameter value.
 void setLabelColumn(java.lang.String labelColumn)
          Deprecated. Replaced by the method setLabelExpr(String)
 void setLabelExpr(java.lang.String labelExpr)
          Sets an expression on the data row from the dynamic list data set that returns the prompt for the choice.
 void setListlimit(int listLimit)
          Set the value for the list limitation number.
 void setMustMatch(boolean mustMatch)
          Sets the flag indicates that whether the value must match one of values in the selection list.
 void setPromptText(java.lang.String promptValue)
          Set the value for the display prompt context.
 void setType(java.lang.String type)
          Deprecated. Replaced by the method setDataType(String)
 void setValueColumn(java.lang.String valueColumn)
          Deprecated. Replaced by the method setValueExpr(String)
 void setValueExpr(java.lang.String valueExpr)
          Sets an expression on the data row from the dynamic list data set that returns the value for the choice.
 void setValueType(java.lang.String type)
          Sets the parameter value type for this scalar parameter.
 
Methods inherited from class org.eclipse.birt.report.model.api.ParameterHandle
getHelpText, getHelpTextKey, getValidate, isHidden, setHelpText, setHelpTextKey, setHidden, setValidate
 
Methods inherited from class org.eclipse.birt.report.model.api.ReportElementHandle
getComments, getCustomXml, getDisplayName, getDisplayNameKey, getElement, getPropertyMask, isValidReferenceForCompoundElement, propertyMaskIterator, setComments, setCustomXml, setDisplayName, setDisplayNameKey, setPropertyMask
 
Methods inherited from class org.eclipse.birt.report.model.api.DesignElementHandle
addElement, addElement, addListener, addUserPropertyDefn, canContain, canContain, canDrop, canEdit, canTransformToTemplate, clearAllProperties, clearContents, clearProperty, clientsIterator, copy, copyPropertyTo, createTemplateElement, derivedIterator, doSort, drop, dropAndClear, dropUserPropertyDefn, findContentSlot, getBooleanProperty, getChoices, getColorProperty, getContainer, getContainerSlotHandle, getDefn, getDesign, getDesignHandle, getDimensionProperty, getDisplayLabel, getDisplayLabel, getDisplayProperty, getEffectiveModule, getElementFactory, getElementProperty, getEventHandlerClass, getExtends, getFactoryPropertyHandle, getFloatProperty, getFontProperty, getID, getIntProperty, getListProperty, getMethods, getModule, getModuleHandle, getName, getNumberProperty, getPrivateStyle, getProperty, getPropertyBinding, getPropertyDefn, getPropertyHandle, getPropertyIterator, getQualifiedName, getRoot, getSemanticErrors, getSlot, getStringProperty, getStyle, getUserProperties, getUserPropertyDefnHandle, getXPath, hasLocalProperties, hasSemanticError, isTemplateParameterValue, isValid, localize, moveTo, removeListener, revertToReportItem, revertToTemplate, semanticCheck, setEventHandlerClass, setExtends, setExtendsElement, setExtendsName, setFloatProperty, setIntProperty, setName, setNumberProperty, setProperties, setProperty, setPropertyBinding, setStringProperty, setStyle, setStyleElement, setStyleName, setValid, showError
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

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 module
element - the model representation of the element
Method Detail

getDataType

public java.lang.String getDataType()
Returns the data type for this parameter. The data type controls how the requester formats, parses and validates the parameter. Types are defined in DesignChoiceConstants can be one of the followings:

Returns:
the type for the parameter
See Also:
setDataType(String), DesignChoiceConstants

setDataType

public void setDataType(java.lang.String type)
                 throws SemanticException
Sets the data type for this parameter. The data type controls how the Requester formats, parses and validates the parameter. Types are defined in DesignChoiceConstants can be one of the followings:

Parameters:
type - the type for the parameter
Throws:
SemanticException - if the input type is not one of above choices.
See Also:
getDataType(), DesignChoiceConstants

getDefaultValue

public java.lang.String getDefaultValue()
Returns the default value of the parameter. The default value can be an expression, but cannot reference any other parameters.

Returns:
the default value

setDefaultValue

public void setDefaultValue(java.lang.String defaultValue)
                     throws SemanticException
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:
true if hides the user's entry by asterisks, false if shows characters as usual.

setConcealValue

public void setConcealValue(boolean concealValue)
                     throws SemanticException
Sets the attribute that's hides the user's entry by displaying asterisks. Often used for passwords.

Parameters:
concealValue - true if hides the user's entry by asterisks, false if shows characters as usual.
Throws:
SemanticException - if the property is locked.

allowNull

public boolean allowNull()
Tests whether the value of the parameter can be null.

Returns:
true if the value can be null, false if the value can not be null.

setAllowNull

public void setAllowNull(boolean allowNull)
                  throws SemanticException
Sets the flag that indicates whether the value of the parameter can be null.

Parameters:
allowNull - true if the value can be null, false if the value can not be null.
Throws:
SemanticException - if the property is locked.

allowBlank

public boolean allowBlank()
Tests whether the string value of the parameter can be null.

Returns:
true if the value can be null, false if the value can not be null.

setAllowBlank

public void setAllowBlank(boolean allowNull)
                   throws SemanticException
Sets the flag that indicates whether the string value of the parameter can be null.

Parameters:
allowNull - true if the value can be null, false if the value can not be null.
Throws:
SemanticException - if the property is locked.

getFormat

public java.lang.String getFormat()
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

setFormat

public void setFormat(java.lang.String format)
               throws SemanticException
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.

getControlType

public java.lang.String getControlType()
Returns the control type for this parameter. Control types are one of constants defined in DesignChoiceConstants:

Returns:
the control type for the UI to display the parameter
See Also:
DesignChoiceConstants

setControlType

public void setControlType(java.lang.String controlType)
                    throws SemanticException
Sets the control type for this parameter. Control types are one of constants defined in DesignChoiceConstants:

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:
getDataType(), DesignChoiceConstants

getAlignment

public java.lang.String getAlignment()
Returns the alignment for this parameter. Alignments can be one of the constants defined in DesignChoiceConstants:

Returns:
the alignment for the UI to display the parameter
See Also:
DesignChoiceConstants

setAlignment

public void setAlignment(java.lang.String align)
                  throws SemanticException
Sets the alignment for this parameter. Alignments can be one of the constants defined in DesignChoiceConstants:

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:
DesignChoiceConstants

isMustMatch

public boolean isMustMatch()
Tests whether the value must match one of values in the selection list.

Returns:
true if the value must match one of values in the list, otherwise false.

setMustMatch

public void setMustMatch(boolean mustMatch)
                  throws SemanticException
Sets the flag indicates that whether the value must match one of values in the selection list.

Parameters:
mustMatch - true if the value must match one of values in the list, otherwise false.
Throws:
SemanticException - if the property is locked.

isFixedOrder

public boolean isFixedOrder()
Tests whether to display values in the order defined in the list.

Returns:
true if to display value in the order, otherwise false.

setFixedOrder

public void setFixedOrder(boolean fixedOrder)
                   throws SemanticException
Sets the flag indicates that whether to display values in the order defined in the list.

Parameters:
fixedOrder - true if to display values in the order, otherwise false.
Throws:
SemanticException - if the property is locked.

choiceIterator

public java.util.Iterator choiceIterator()
Returns the iterator for the static selection list defined on this scalar parameter. Each element in the iterator is the an instance of SelectionChoiceHandle.

Returns:
the iterator for selection list defined on this scalar parameter.
See Also:
SelectionChoice

getDataSetName

public java.lang.String getDataSetName()
Returns the data set name of the dynamic list for this parameter.

Returns:
the data set name of the dynamic list

setDataSetName

public void setDataSetName(java.lang.String dataSetName)
                    throws SemanticException
Sets the data set name of the dynamic list for this parameter.

Parameters:
dataSetName - the data set name of the dynamic list
Throws:
SemanticException - if the property is locked.

getValueExpr

public java.lang.String getValueExpr()
Returns an expression on the data row from the dynamic list data set that returns the value for the choice.

Returns:
the expression that returns the parameter value for each row in the dynamic list.

setValueExpr

public void setValueExpr(java.lang.String valueExpr)
                  throws SemanticException
Sets an expression on the data row from the dynamic list data set that returns the value for the choice.

Parameters:
valueExpr - the expression that returns the parameter value for each row in the dynamic list.
Throws:
SemanticException - if the property is locked.

getLabelExpr

public java.lang.String getLabelExpr()
Returns an expression on the data row from the dynamic list data set that returns the prompt for the choice.

Returns:
an expression that returns the display value for each row in the dynamic list.

setLabelExpr

public void setLabelExpr(java.lang.String labelExpr)
                  throws SemanticException
Sets an expression on the data row from the dynamic list data set that returns the prompt for the choice.

Parameters:
labelExpr - an expression that returns the display value for each row in the dynamic list.
Throws:
SemanticException - if the property is locked.

getValueColumn

public java.lang.String getValueColumn()
Deprecated. Replaced by the method 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

public void setValueColumn(java.lang.String valueColumn)
                    throws SemanticException
Deprecated. Replaced by the method 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

public java.lang.String getLabelColumn()
Deprecated. Replaced by the method 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

public void setLabelColumn(java.lang.String labelColumn)
                    throws SemanticException
Deprecated. Replaced by the method 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

public java.lang.String getType()
Deprecated. Replaced by the method getDataType()

Returns the data type for this parameter. The data type controls how the requester formats, parses and validates the parameter. Types are defined in DesignChoiceConstants can be one of the followings:

Returns:
the type for the parameter
See Also:
setType(String), DesignChoiceConstants

setType

public void setType(java.lang.String type)
             throws SemanticException
Deprecated. Replaced by the method 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 in DesignChoiceConstants can be one of the followings:

Parameters:
type - the type for the parameter
Throws:
SemanticException - if the input type is not one of above choices.
See Also:
getType(), DesignChoiceConstants

getValueType

public java.lang.String getValueType()
Returns the parameter type for this scalar parameter. Types are defined in DesignChoiceConstants can be one of the followings:

Returns:
the type for the scalar parameter
See Also:
setValueType(String), DesignChoiceConstants

setValueType

public void setValueType(java.lang.String type)
                  throws SemanticException
Sets the parameter value type for this scalar parameter. Types are defined in DesignChoiceConstants can be one of the followings:

Parameters:
type - the type for the scalar parameter
Throws:
SemanticException - if the input type is not one of above choices.
See Also:
getValueType(), DesignChoiceConstants

setPromptText

public void setPromptText(java.lang.String promptValue)
                   throws SemanticException
Set the value for the display prompt context.

Parameters:
promptValue - The display prompt context.
Throws:
SemanticException

getPromptText

public java.lang.String getPromptText()
get the display prompt text.

Returns:
the display prompt.

setListlimit

public void setListlimit(int listLimit)
                  throws SemanticException
Set the value for the list limitation number. This property is used to limit the parameter display list.

Parameters:
listLimit - The limited number.
Throws:
SemanticException

getListlimit

public int getListlimit()
get the list limited number.

Returns:
the display prompt.


Copyright © 2005 Actuate Corp. All rights reserved.