com.ibm.as400.util.servlet

Interface RowMetaData

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.String getColumnAlignment(int columnIndex)
      Returns the horizontal alignment of the column data specified by columnIndex.
      int getColumnCount()
      Returns the number of columns.
      java.lang.String getColumnDirection(int columnIndex)
      Returns the direction of the column data specified by columnIndex.
      int getColumnDisplaySize(int columnIndex)
      Returns the display size in characters of the column specified by columnIndex.
      java.lang.String getColumnLabel(int columnIndex)
      Returns the label of the column specified by columnIndex.
      java.lang.String getColumnName(int columnIndex)
      Returns the name of the column specified by columnIndex.
      int getColumnType(int columnIndex)
      Returns the data type of the column specified by columnIndex.
      java.lang.String getColumnTypeName(int columnIndex)
      Returns the data type name of the column specified by columnIndex.
      int getPrecision(int columnIndex)
      Returns the precision of the column specified by columnIndex.
      int getScale(int columnIndex)
      Returns the scale of the column specified by columnIndex.
      boolean isNumericData(int columnIndex)
      Indicates if the column specified by columnIndex contains numeric data.
      boolean isTextData(int columnIndex)
      Indicates if the column specified by columnIndex contains text data.
      void setColumnAlignment(int columnIndex, java.lang.String alignment)
      Sets the specified horizontal alignment for the column data specified by columnIndex.
      void setColumnDirection(int columnIndex, java.lang.String alignment)
      Sets the specified direction for the column data specified by columnIndex.
      void setColumnLabel(int columnIndex, java.lang.String label)
      Sets the specified label for the column specified by columnIndex.
    • Method Detail

      • getColumnAlignment

        java.lang.String getColumnAlignment(int columnIndex)
                                            throws RowDataException
        Returns the horizontal alignment of the column data specified by columnIndex. For a list of values, see HTMLConstants.
        Parameters:
        columnIndex - The column index (0-based).
        Returns:
        The horizontal column alignment. One of the following constants defined in HTMLConstants: LEFT, CENTER, RIGHT, or JUSTIFY.
        Throws:
        RowDataException - If a row data error occurred.
      • getColumnCount

        int getColumnCount()
                           throws RowDataException
        Returns the number of columns.
        Returns:
        The number of columns.
        Throws:
        RowDataException - If a row data error occurred.
      • getColumnDirection

        java.lang.String getColumnDirection(int columnIndex)
                                            throws RowDataException
        Returns the direction of the column data specified by columnIndex. For a list of values, see HTMLConstants.
        Parameters:
        columnIndex - The column index (0-based).
        Returns:
        The direction.
        Throws:
        RowDataException - If a row data error occurred.
      • getColumnDisplaySize

        int getColumnDisplaySize(int columnIndex)
                                 throws RowDataException
        Returns the display size in characters of the column specified by columnIndex.
        Parameters:
        columnIndex - The column index (0-based).
        Returns:
        The display size.
        Throws:
        RowDataException - If a row data error occurred.
      • getColumnLabel

        java.lang.String getColumnLabel(int columnIndex)
                                        throws RowDataException
        Returns the label of the column specified by columnIndex.
        Parameters:
        columnIndex - The column index(0-based).
        Returns:
        The label.
        Throws:
        RowDataException - If a row data error occurred.
      • getColumnName

        java.lang.String getColumnName(int columnIndex)
                                       throws RowDataException
        Returns the name of the column specified by columnIndex.
        Parameters:
        columnIndex - The column index(0-based).
        Returns:
        The name.
        Throws:
        RowDataException - If a row data error occurred.
      • getColumnType

        int getColumnType(int columnIndex)
                          throws RowDataException
        Returns the data type of the column specified by columnIndex. For a list of values, see RowMetaDataType
        Parameters:
        columnIndex - The column index (0-based).
        Returns:
        The data type.
        Throws:
        RowDataException - If a row data error occurred.
      • getColumnTypeName

        java.lang.String getColumnTypeName(int columnIndex)
                                           throws RowDataException
        Returns the data type name of the column specified by columnIndex.
        Parameters:
        columnIndex - The column index (0-based).
        Returns:
        The data type name.
        Throws:
        RowDataException - If a row data error occurred.
      • getPrecision

        int getPrecision(int columnIndex)
                         throws RowDataException
        Returns the precision of the column specified by columnIndex.
        Parameters:
        columnIndex - The column index (0-based).
        Returns:
        The precision (number of decimal digits).
        Throws:
        RowDataException - If a row data error occurred.
      • getScale

        int getScale(int columnIndex)
                     throws RowDataException
        Returns the scale of the column specified by columnIndex.
        Parameters:
        columnIndex - The column index (0-based).
        Returns:
        The scale (number of digits to the right of the decimal point).
        Throws:
        RowDataException - If a row data error occurred.
      • isNumericData

        boolean isNumericData(int columnIndex)
                              throws RowDataException
        Indicates if the column specified by columnIndex contains numeric data.
        Parameters:
        columnIndex - The column index (0-based).
        Returns:
        true if numeric data; false otherwise.
        Throws:
        RowDataException - If a row data error occurred.
      • isTextData

        boolean isTextData(int columnIndex)
                           throws RowDataException
        Indicates if the column specified by columnIndex contains text data.
        Parameters:
        columnIndex - The column index (0-based).
        Returns:
        true if text data; false otherwise.
        Throws:
        RowDataException - If a row data error occurred.
      • setColumnLabel

        void setColumnLabel(int columnIndex,
                          java.lang.String label)
                            throws RowDataException
        Sets the specified label for the column specified by columnIndex.
        Parameters:
        columnIndex - The column index (0-based).
        label - The label.
        Throws:
        RowDataException - If a row data error occurred.
      • setColumnAlignment

        void setColumnAlignment(int columnIndex,
                              java.lang.String alignment)
                                throws RowDataException
        Sets the specified horizontal alignment for the column data specified by columnIndex.
        Parameters:
        columnIndex - The column index (0-based).
        alignment - The horizontal column alignment. One of the following constants defined in HTMLConstants: LEFT, CENTER, RIGHT, or JUSTIFY.
        Throws:
        RowDataException
        See Also:
        HTMLConstants
      • setColumnDirection

        void setColumnDirection(int columnIndex,
                              java.lang.String alignment)
                                throws RowDataException
        Sets the specified direction for the column data specified by columnIndex.
        Parameters:
        columnIndex - The column index (0-based).
        alignment - The column direction.
        Throws:
        RowDataException
        See Also:
        HTMLConstants