java.lang.Object
org.eclipse.birt.report.model.core.Structure
org.eclipse.birt.report.model.core.PropertyStructure
org.eclipse.birt.report.model.api.elements.structures.DataSetParameter
All Implemented Interfaces:
Cloneable, IStructure, org.eclipse.birt.report.model.core.IPropertySet
Direct Known Subclasses:
OdaDataSetParameter

public class DataSetParameter extends org.eclipse.birt.report.model.core.PropertyStructure
Represents the parameter for ODA drivers. The parameter is the part of the data set definition, if defined. A parameter can be an input or output parameter. A parameter can also be input and output parameter. Each data set parameter has the following properties:

Name
a data set parameter has a required name.
Position
a data set parameter has an optional position for it.
Data Type
a data set parameter has a choice data type: any, integer, string, data time, decimal, float, structure or table.
Is optional
whether this parameter is optional.
Allow Null
whether the value of this parameter can be nullable.
Is Input
whether this parameter is an input parameter.
Is Output
whether this parameter is an output parameter.
  • Field Details

    • STRUCT_NAME

      public static final String STRUCT_NAME
      Name of this structure. Matches the definition in the meta-data dictionary.
      See Also:
    • POSITION_MEMBER

      public static final String POSITION_MEMBER
      Name of the position member.
      See Also:
    • NAME_MEMBER

      public static final String NAME_MEMBER
      Name of the parameter name member.
      See Also:
    • DATA_TYPE_MEMBER

      public static final String DATA_TYPE_MEMBER
      Name of the parameter data type member.
      See Also:
    • IS_OPTIONAL_MEMBER

      public static final String IS_OPTIONAL_MEMBER
      Name of the member indicating that whether the report must provide a value for this parameter.
      See Also:
    • DEFAULT_VALUE_MEMBER

      public static final String DEFAULT_VALUE_MEMBER
      Name of the parameter default value member.
      See Also:
    • IS_NULLABLE_MEMBER

      @Deprecated public static final String IS_NULLABLE_MEMBER
      Deprecated.
      Name of the member indicating that whether the value of this parameter can be null.
      See Also:
    • ALLOW_NULL_MEMBER

      public static final String ALLOW_NULL_MEMBER
      Name of the member indicating that whether the value of this parameter can be null.
      See Also:
    • IS_INPUT_MEMBER

      public static final String IS_INPUT_MEMBER
      Name of the member indicating that whether this is an input parameter.
      See Also:
    • IS_OUTPUT_MEMBER

      public static final String IS_OUTPUT_MEMBER
      Name of the member indicating that whether this is an output parameter.
      See Also:
    • NATIVE_DATA_TYPE_MEMBER

      public static final String NATIVE_DATA_TYPE_MEMBER
      Name of the member indicating the native (database) data type code.
      See Also:
    • DISPLAY_NAME_MEMBER

      public static final String DISPLAY_NAME_MEMBER
      Name of the member indicating the display name of the parameter
      See Also:
    • DISPLAY_NAME_ID_MEMBER

      public static final String DISPLAY_NAME_ID_MEMBER
      Name of the member indicating the display name id of the parameter
      See Also:
    • HEADING_MEMBER

      public static final String HEADING_MEMBER
      Name of the member indicating the heading of the parameter
      See Also:
    • HEADING_ID_MEMBER

      public static final String HEADING_ID_MEMBER
      Name of the member indicating the heading id of the parameter
      See Also:
    • HELP_TEXT_MEMBER

      public static final String HELP_TEXT_MEMBER
      Name of the member indicating the help text of the parameter
      See Also:
    • HELP_TEXT_ID_MEMBER

      public static final String HELP_TEXT_ID_MEMBER
      Name of the member indicating the help text id of the parameter
      See Also:
    • DESCRIPTION_MEMBER

      public static final String DESCRIPTION_MEMBER
      Name of the member indicating the description of the parameter
      See Also:
    • DESCRIPTION_ID_MEMBER

      public static final String DESCRIPTION_ID_MEMBER
      Name of the member indicating the description id of the parameter
      See Also:
  • Constructor Details

    • DataSetParameter

      public DataSetParameter()
  • Method Details

    • getStructName

      public String getStructName()
      Description copied from interface: IStructure
      Returns the name of the structure definition. The name is the one used to define the structure in the meta-data dictionary.
      Returns:
      the internal name of the structure a defined in the meta-data dictionary.
    • isOptional

      public boolean isOptional()
      Whether the parameter is optional.
      Returns:
      whether the parameter is optional
    • setIsOptional

      public void setIsOptional(boolean value)
      Sets whether the parameter is optional.
      Parameters:
      value - the value to set
    • setDefaultValue

      public void setDefaultValue(String expr)
      Sets the default value of the input parameter.
      Parameters:
      expr - the default value
    • getDefaultValue

      public String getDefaultValue()
      Gets the default value of the input parameter.
      Returns:
      the default value
    • isInput

      public boolean isInput()
      Checks whether this parameter is an input parameter.
      Returns:
      true if it is an input parameter. Otherwise false.
    • setIsInput

      public void setIsInput(boolean isInput)
      Sets whether this parameter is an input parameter.
      Parameters:
      isInput - true if it is an input parameter. Otherwise false.
    • isNullable

      @Deprecated public boolean isNullable()
      Deprecated.
      Use allowNull()
      Checks whether the value of this parameter can be null.
      Returns:
      true if the value can be null. Otherwise false.
    • setIsNullable

      @Deprecated public void setIsNullable(boolean isNullable)
      Deprecated.
      Use setAllowNull(boolean)
      Sets whether the value of this parameter can be null.
      Parameters:
      isNullable - true if the value can be null. Otherwise false.
    • allowNull

      public boolean allowNull()
      Checks whether the value of this parameter can be null.
      Returns:
      true if the value can be null. Otherwise false.
    • setAllowNull

      public void setAllowNull(boolean allowNull)
      Sets whether the value of this parameter can be null.
      Parameters:
      allowNull - true if the value can be null. Otherwise false.
    • isOutput

      public boolean isOutput()
      Checks whether this parameter is an output parameter.
      Returns:
      true if it is an output parameter. Otherwise false.
    • setIsOutput

      public void setIsOutput(boolean isOutput)
      Sets whether this parameter is an output parameter.
      Parameters:
      isOutput - true if it is an output parameter. Otherwise false.
    • getDataType

      public String getDataType()
      Returns the parameter data type.
      Returns:
      the parameter dataType
    • setDataType

      public void setDataType(String dataType)
      Sets the parameter data type.
      Parameters:
      dataType - the data type to set
    • getName

      public String getName()
      Returns the parameter name.
      Returns:
      the parameter name
    • setName

      public void setName(String name)
      Sets the parameter name.
      Parameters:
      name - the name to set
    • getPosition

      public Integer getPosition()
      Returns the position of this parameter.
      Returns:
      the position of this parameter
    • setPosition

      public void setPosition(Integer position)
      Sets the position of this parameter.
      Parameters:
      position - the position to set
    • handle

      public StructureHandle handle(SimpleValueHandle valueHandle, int index)
      Description copied from class: org.eclipse.birt.report.model.core.Structure
      Creates the specific handle of this structure. This handle is always created.
      Specified by:
      handle in class org.eclipse.birt.report.model.core.Structure
      Parameters:
      valueHandle - the value handle of this structure list property this structure is in
      index - the position of this structure in structure list
      Returns:
      the handle of this structure.
    • validate

      public List validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
      Description copied from class: org.eclipse.birt.report.model.core.Structure
      Validate whether this structure is valid. The derived class should override this method if semantic check is needed. The each error is the instance of PropertyValueException.
      Overrides:
      validate in class org.eclipse.birt.report.model.core.Structure
      Parameters:
      module - the module
      element - the element contains this structure
      Returns:
      the semantic error list
    • getNativeDataType

      public Integer getNativeDataType()
      Returns the native data type.
      Returns:
      the parameter native data type.
    • setNativeDataType

      public void setNativeDataType(Integer dataType)
      Sets the parameter native data type.
      Parameters:
      dataType - the native data type to set.
    • getParameterDataType

      public String getParameterDataType()
      Returns the data type in parameter type choices of this parameter. The possible values are:
      • PARAM_TYPE_ANY
      • PARAM_TYPE_INTEGER
      • PARAM_TYPE_STRING
      • PARAM_TYPE_DATETIME
      • PARAM_TYPE_DECIMAL
      • PARAM_TYPE_FLOAT
      • PARAM_TYPE_BOOLEAN
      Returns:
      the data type of this parameter.
    • setParameterDataType

      public void setParameterDataType(String dataType)
      Sets the data type in parameter type choices to this parameter. The allowed values are:
      • PARAM_TYPE_ANY
      • PARAM_TYPE_INTEGER
      • PARAM_TYPE_STRING
      • PARAM_TYPE_DATETIME
      • PARAM_TYPE_DECIMAL
      • PARAM_TYPE_FLOAT
      • PARAM_TYPE_BOOLEAN
      Parameters:
      dataType - the data type to set
      Throws:
      SemanticException - if the value is not in the above list.
    • getDisplayName

      public String getDisplayName()
      Gets the display name of this parameter.
      Returns:
      the display name of this parameter
    • setDisplayName

      public void setDisplayName(String displayName)
      Sets the display name of this parameter.
      Parameters:
      displayName - the new display name of this parameter
    • getDisplayNameKey

      public String getDisplayNameKey()
      Gets the resource key of the display name of this parameter.
      Returns:
      the resource key of the display name
    • setDisplayNameKey

      public void setDisplayNameKey(String displayNameID)
      Sets the resource key of the display name id of this parameter.
      Parameters:
      displayNameID - the new resource key of the display name
    • getHeading

      public String getHeading()
      Gets the heading of this parameter.
      Returns:
      the heading of this parameter
    • setHeading

      public void setHeading(String heading)
      Sets the heading of this parameter.
      Parameters:
      heading - the new heading of this parameter
    • getHeadingKey

      public String getHeadingKey()
      Gets the resource key of the heading of this parameter.
      Returns:
      the resource key of the heading
    • setHeadingKey

      public void setHeadingKey(String headingID)
      Sets the resource key of the heading of this parameter.
      Parameters:
      headingID - the new resource key of the heading
    • getHelpText

      public String getHelpText()
      Gets the help text of this parameter.
      Returns:
      the help text of this parameter
    • setHelpText

      public void setHelpText(String helpText)
      Sets the help text of this parameter.
      Parameters:
      helpText - the new help text of this parameter
    • getHelpTextKey

      public String getHelpTextKey()
      Gets the resource key of the help text of this parameter.
      Returns:
      the resource key of the help text
    • setHelpTextKey

      public void setHelpTextKey(String helpTextID)
      Sets the resource key of the help text of this parameter.
      Parameters:
      helpTextID - the new resource key of the heading
    • getDescription

      public String getDescription()
      Gets the description of this parameter.
      Returns:
      the description of this parameter
    • setDescription

      public void setDescription(String description)
      Sets the description of this parameter.
      Parameters:
      description - the new description of this parameter
    • getDescriptionKey

      public String getDescriptionKey()
      Gets the resource key of the description of this parameter.
      Returns:
      the resource key
    • setDescriptionKey

      public void setDescriptionKey(String descriptionID)
      Sets the resource key of the description of this parameter.
      Parameters:
      descriptionID - the new resource key of the description