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

public class ResultSetColumn extends org.eclipse.birt.report.model.core.Structure
This class represents one column in the result set.

This is a managed object, meaning that all changes should be made though the command layer so that they can be undone and redone. Each result set column has the following properties:

Name
a result set column has an optional name.
Position
a result set column has an optional position for it.
Data Type
a result set column has a choice data type: any, integer, string, data time, decimal, float, structure or table.
  • Field Details

    • RESULT_SET_COLUMN_STRUCT

      public static final String RESULT_SET_COLUMN_STRUCT
      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 column name member.
      See Also:
    • DATA_TYPE_MEMBER

      public static final String DATA_TYPE_MEMBER
      Name of the data type member.
      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:
  • Constructor Details

    • ResultSetColumn

      public ResultSetColumn()
  • 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.
    • getIntrinsicProperty

      protected Object getIntrinsicProperty(String propName)
      Description copied from class: org.eclipse.birt.report.model.core.Structure
      Returns the value of a structure property represented as a member variable.
      Specified by:
      getIntrinsicProperty in class org.eclipse.birt.report.model.core.Structure
      Parameters:
      propName - name of the property
      Returns:
      the value of the property, or null if the property is not set
    • setIntrinsicProperty

      protected void setIntrinsicProperty(String propName, Object value)
      Description copied from class: org.eclipse.birt.report.model.core.Structure
      Sets the value of of a structure property represented as a member variable.
      Specified by:
      setIntrinsicProperty in class org.eclipse.birt.report.model.core.Structure
      Parameters:
      propName - the name of the property to set
      value - the property value
    • getColumnName

      public String getColumnName()
      Returns the column name.
      Returns:
      the column name.
    • setColumnName

      public void setColumnName(String columnName)
      Sets the column name.
      Parameters:
      columnName - the column name to set
    • getDataType

      public String getDataType()
      Returns the data type of this column. The possible values are defined in DesignChoiceConstants, and they are:
      • COLUMN_DATA_TYPE_ANY
      • COLUMN_DATA_TYPE_INTEGER
      • COLUMN_DATA_TYPE_STRING
      • COLUMN_DATA_TYPE_DATETIME
      • COLUMN_DATA_TYPE_DECIMAL
      • COLUMN_DATA_TYPE_FLOAT
      • COLUMN_DATA_TYPE_STRUCTURE
      • COLUMN_DATA_TYPE_TABLE
      Returns:
      the data type of this column.
    • setDataType

      public void setDataType(String dataType)
      Sets the data type of this column. The allowed values are defined in DesignChoiceConstants, and they are:
      • COLUMN_DATA_TYPE_ANY
      • COLUMN_DATA_TYPE_INTEGER
      • COLUMN_DATA_TYPE_STRING
      • COLUMN_DATA_TYPE_DATETIME
      • COLUMN_DATA_TYPE_DECIMAL
      • COLUMN_DATA_TYPE_FLOAT
      • COLUMN_DATA_TYPE_STRUCTURE
      • COLUMN_DATA_TYPE_TABLE
      Parameters:
      dataType - the data type 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 column.
      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.
    • getNativeDataType

      public Integer getNativeDataType()
      Returns the native data type.
      Returns:
      the result set column native data type.
    • setNativeDataType

      public void setNativeDataType(Integer dataType)
      Sets the result set column native data type.
      Parameters:
      dataType - the native data type to set.
    • validate

      public List validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
      Validates this structure. The following are the rules:
      • The column name is required.
      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
      See Also:
      • Structure.validate(Module, org.eclipse.birt.report.model.core.DesignElement)