Package org.intermine.web.logic.export.http

Interface TableHttpExporter

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean canExport​(PagedTable pt)
      Check if this TableExporter can export the given PagedTable.
      void export​(PagedTable pt, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, TableExportForm form, java.util.Collection<Path> unionPathCollection, java.util.Collection<Path> newPathCollection)
      Method called to export a PagedTable object
      java.util.List<Path> getInitialExportPaths​(PagedTable pt)
      Return a list of the Paths to show the user as initial export columns or header contents.

    • Method Detail

      • export

        void export​(PagedTable pt,
            javax.servlet.http.HttpServletRequest request,
            javax.servlet.http.HttpServletResponse response,
            TableExportForm form,
            java.util.Collection<Path> unionPathCollection,
            java.util.Collection<Path> newPathCollection)
        Method called to export a PagedTable object
        Parameters:
        pt - exported PagedTable
        request - The HTTP request we are processing
        response - The HTTP response we are creating
        form - the form containing the columns paths to export
        unionPathCollection - a collection of Path combining old and new views from pathquery
        newPathCollection - a collection of Path, from user columns paths

      • canExport

        boolean canExport​(PagedTable pt)
        Check if this TableExporter can export the given PagedTable.
        Parameters:
        pt - the PagedTable
        Returns:
        true if and only if this TableExporter can export the argument PagedTable

      • getInitialExportPaths

        java.util.List<Path> getInitialExportPaths​(PagedTable pt)
                                    throws PathException
        Return a list of the Paths to show the user as initial export columns or header contents. The List is likely to be based on the columns of the PagedTable plus or minus special cases for this exporter.
        Parameters:
        pt - the PagedTable
        Returns:
        the Paths
        Throws:
        PathException - if bad path encountered