Annotation Type ExcelTable


  • @Target(TYPE)
    @Retention(RUNTIME)
    public @interface ExcelTable
    Use this annotation on any Entity class, that defines the data from a Excel file. Note that only 2 dimensional tabular structure based content is supported. Must define "file" attribute to define where to read from. This annotation is to read a Excel file into an Entity from a file location.
    See Excel translator in Teiid for more information [Microsoft Excel Translator]
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      String file
      On Class ONLY, defines the excel file to be read.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      int dataRowStartsAt
      Row number from which data rows start from
      int headerRow
      Row number that contains the header information, -1 no header
      boolean ignoreEmptyCells
      When true any cells with empty value for header row are ignored, otherwise an empty header row cell indicates end of columns.
      String sheetName
      Name of the Sheet to read the data from
      String source
      Source name; If overriding the org.teiid.translator.ws.WsExecutionFactory bean then provide the name of the bean
    • Element Detail

      • file

        String file
        On Class ONLY, defines the excel file to be read. Either relative to source's parent directory or absolute path
        Returns:
        excel file name
      • dataRowStartsAt

        int dataRowStartsAt
        Row number from which data rows start from
        Returns:
        row number
        Default:
        0
      • ignoreEmptyCells

        boolean ignoreEmptyCells
        When true any cells with empty value for header row are ignored, otherwise an empty header row cell indicates end of columns.
        Returns:
        true to ignore
        Default:
        false
      • headerRow

        int headerRow
        Row number that contains the header information, -1 no header
        Returns:
        header column row number
        Default:
        -1
      • sheetName

        String sheetName
        Name of the Sheet to read the data from
        Returns:
        sheet name
        Default:
        "Sheet1"
      • source

        String source
        Source name; If overriding the org.teiid.translator.ws.WsExecutionFactory bean then provide the name of the bean
        Returns:
        string
        Default:
        "file"