Skip navigation links
com.groupdocs.assembly

Class DocumentTable

  • java.lang.Object
    • com.groupdocs.assembly.DocumentTable

  • public class DocumentTable
extends java.lang.Object
    Provides access to data of a single table (or spreadsheet) located in an external document to be used while assembling a document.

    For documents of Spreadsheet file formats, a DocumentTable instance represents a single sheet. For documents of other file formats, a DocumentTable instance represents a single table.

    To access data of the corresponding table while assembling a document, pass an instance of this class as a data source to one of DocumentAssembler. assembleDocument overloads.

    In template documents, a DocumentTable instance should be treated in the same way as if it was a DataTable instance. See template syntax reference for more information.

    • Constructor Detail

      • DocumentTable

        public DocumentTable(java.lang.String documentPath,
                     int indexInDocument)
              throws java.lang.Exception
        Creates a new instance of this class using default DocumentTableOptions.
        Parameters:
        documentPath - The path to a document containing the table to be accessed.
        indexInDocument - The zero-based index of the table in the document.
        Throws:
        java.lang.Exception

      • DocumentTable

        public DocumentTable(java.lang.String documentPath,
                     int indexInDocument,
                     DocumentTableOptions options)
              throws java.lang.Exception
        Creates a new instance of this class.
        Parameters:
        documentPath - The path to a document containing the table to be accessed.
        indexInDocument - The zero-based index of the table in the document.
        options - A set of options controlling extraction of data from the table. If null, default options are applied.
        Throws:
        java.lang.Exception

      • DocumentTable

        public DocumentTable(java.io.InputStream documentStream,
                     int indexInDocument)
              throws java.lang.Exception
        Creates a new instance of this class using default DocumentTableOptions.
        Parameters:
        documentStream - The stream containing a document with the table to be accessed.
        indexInDocument - The zero-based index of the table in the document.
        Throws:
        java.lang.Exception

      • DocumentTable

        public DocumentTable(java.io.InputStream documentStream,
                     int indexInDocument,
                     DocumentTableOptions options)
              throws java.lang.Exception
        Creates a new instance of this class.
        Parameters:
        documentStream - The stream containing a document with the table to be accessed.
        indexInDocument - The zero-based index of the table in the document.
        options - A set of options controlling extraction of data from the table. If null, default options are applied.
        Throws:
        java.lang.Exception

    • Method Detail

      • getName

        public java.lang.String getName()
        Gets the name of this table used to access the table's data in a template document passed to DocumentAssembler.

        If the table's name is read from a document, the name is automatically corrected so that it to be valid. However, if the table's name is set manually through this property and the name is invalid, an exception is thrown.

        The table's name is considered to be valid, if the following conditions are met:

        • The name is not empty.
        • The name's first character is a letter or underscore.
        • The rest of the name's characters are letters, underscores, digits, or the following characters: '@', '#', '$'.
        • The corresponding DocumentTableSet object does not contain a DocumentTable instance with the same name.
        Returns:
        The name of this table used to access the table's data in a template document passed to DocumentAssembler.

      • setName

        public void setName(java.lang.String value)
        Sets the name of this table used to access the table's data in a template document passed to DocumentAssembler.

        If the table's name is read from a document, the name is automatically corrected so that it to be valid. However, if the table's name is set manually through this property and the name is invalid, an exception is thrown.

        The table's name is considered to be valid, if the following conditions are met:

        • The name is not empty.
        • The name's first character is a letter or underscore.
        • The rest of the name's characters are letters, underscores, digits, or the following characters: '@', '#', '$'.
        • The corresponding DocumentTableSet object does not contain a DocumentTable instance with the same name.
        Parameters:
        value - The name of this table used to access the table's data in a template document passed to DocumentAssembler.

      • getIndexInDocument

        public int getIndexInDocument()
        Gets the original zero-based index of the corresponding table as per the source document. Depending on an IDocumentTableLoadHandler implementation provided, this index may differ from the index of this DocumentTable instance within the table collection of the corresponding DocumentTableSet instance, if any.
        Returns:
        The original zero-based index of the corresponding table as per the source document.