Package org.intermine.web.struts

Class TableExportForm

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    CSVExportForm
    public class TableExportForm
extends org.apache.struts.action.ActionForm
    Form to hold options for exporting.
    Author:
    Kim Rutherford
    See Also:
    Serialized Form

    • Field Summary

      • Fields inherited from class org.apache.struts.action.ActionForm

        multipartRequestHandler, servlet

    • Constructor Summary

      Constructors 
      Constructor Description
      TableExportForm()
      Constructor

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean getDoGzip()
      Get whether the output should be GZIPped.
      protected java.util.Map<java.lang.String,​java.lang.Object> getExtraParams()
      Extra parameters map for use by sub classes.
      boolean getIncludeHeaders()
      Return the current value of the includeHeaders flag.
      java.lang.String getPathsString()
      Get the paths string in the format: "Class.field Class.field2 Class.ref.field"
      java.lang.String getTable()
      Get the table identifier to look up the PagedTable in the servlet context
      java.lang.String getType()
      Return the export type: "tab", etc.
      void initialise()
      Initialiser
      void reset​(org.apache.struts.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest request)
      Reset the form to the initial state
      void setDoGzip​(boolean doGzip)
      Set whether the output should be GZIPped.
      void setIncludeHeaders​(boolean includeHeaders)
      Set the includeHeaders flag.
      void setPathsString​(java.lang.String pathsString)
      Set the paths string
      void setTable​(java.lang.String table)
      Set the table identifier to look up in the servlet context
      void setType​(java.lang.String type)
      Set the type

      • Methods inherited from class org.apache.struts.action.ActionForm

        getMultipartRequestHandler, getServlet, getServletWrapper, reset, setMultipartRequestHandler, setServlet, validate, validate

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • TableExportForm

        public TableExportForm()
        Constructor

    • Method Detail

      • getPathsString

        public final java.lang.String getPathsString()
        Get the paths string in the format: "Class.field Class.field2 Class.ref.field"
        Returns:
        the pathsString

      • setPathsString

        public final void setPathsString​(java.lang.String pathsString)
        Set the paths string
        Parameters:
        pathsString - the pathsString to set

      • getType

        public java.lang.String getType()
        Return the export type: "tab", etc.
        Returns:
        the type

      • setType

        public final void setType​(java.lang.String type)
        Set the type
        Parameters:
        type - the type to set

      • setIncludeHeaders

        public void setIncludeHeaders​(boolean includeHeaders)
        Set the includeHeaders flag. If true column headers will be added to the output where possible.
        Parameters:
        includeHeaders - the new value.

      • getIncludeHeaders

        public boolean getIncludeHeaders()
        Return the current value of the includeHeaders flag.
        Returns:
        the includeHeaders flag

      • getTable

        public final java.lang.String getTable()
        Get the table identifier to look up the PagedTable in the servlet context
        Returns:
        the table

      • setTable

        public final void setTable​(java.lang.String table)
        Set the table identifier to look up in the servlet context
        Parameters:
        table - the table to set

      • getExtraParams

        protected final java.util.Map<java.lang.String,​java.lang.Object> getExtraParams()
        Extra parameters map for use by sub classes. The Map is reset when the form is initialised.
        Returns:
        the extraParams

      • setDoGzip

        public void setDoGzip​(boolean doGzip)
        Set whether the output should be GZIPped.
        Parameters:
        doGzip - a boolean

      • getDoGzip

        public boolean getDoGzip()
        Get whether the output should be GZIPped.
        Returns:
        a boolean

      • initialise

        public void initialise()
        Initialiser

      • reset

        public void reset​(org.apache.struts.action.ActionMapping mapping,
                  javax.servlet.http.HttpServletRequest request)
        Reset the form to the initial state
        Overrides:
        reset in class org.apache.struts.action.ActionForm
        Parameters:
        mapping - the mapping
        request - the request