org.intermine.web.logic.export.http
Interface TableHttpExporter

All Known Implementing Classes:

CSVHttpExporter, ExcelHttpExporter, StandardHttpExporter, TabHttpExporter

public interface TableHttpExporter

Implemented by objects that can export PagedTable.

Method Summary

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) 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)

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

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