TableWidgetService (InterMine 5.0.0 API)

java.lang.Object
- org.intermine.webservice.server.WebService
- - org.intermine.webservice.server.core.JSONService
  - - org.intermine.webservice.server.widget.WidgetService
    - - org.intermine.webservice.server.widget.TableWidgetService

```
public class TableWidgetService
extends WidgetService
```
Web service that returns a table widget for a given list. URL examples: get a TableWidget /service/list/table?list=copy&widget=interactions

Author:

dbutano

Field Summary
- Fields inherited from class org.intermine.webservice.server.core.JSONService
  bagManager, model
- Fields inherited from class org.intermine.webservice.server.WebService
  dataPackageOutput, DEFAULT_CALLBACK, im, os, out, output, request, response, webProperties

Constructor Summary

Constructors
Constructor Description

TableWidgetService(InterMineAPI im)
Construct a TableWidgetService

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`addOutputConfig(WidgetConfig config)`	Add metadata about the widget we are using.
`protected void`	`execute()`	Runs service.
`protected WidgetResultProcessor`	`getProcessor()`

Methods inherited from class org.intermine.webservice.server.widget.WidgetService
addOutputAttribute, addOutputFilter, addOutputIdsInfo, addOutputListInfo, addOutputResult, getDefaultFilterValue, getHeaderAttributes, retrieveBag

Methods inherited from class org.intermine.webservice.server.core.JSONService
addOutputInfo, addResultEntries, addResultEntries, addResultEntry, addResultEntry, addResultItem, addResultItem, addResultValue, addResultValue, addResultValue, getDefaultFormat, getResultsKey, lazyList, postInit

Methods inherited from class org.intermine.webservice.server.WebService
canServe, cleanUp, formatIsFlatFile, formatIsJSON, formatIsJSONP, formatIsXML, getAuthenticatedUser, getCallback, getColumnHeaderStyle, getDefaultFileName, getDefaultOutput, getDefaultOutput, getExtension, getFormat, getIntParameter, getIntParameter, getLineBreak, getListManager, getOptionalParameter, getOptionalParameter, getPermission, getProperty, getRawOutput, getRequestFileName, getRequiredParameter, hasCallback, initState, isAuthenticated, isGzip, isUncompressed, isZip, makeJSONOutput, makeXMLOutput, service, setFormat, setNameSpace, validateState, wantsColumnHeaders, wantsDataPackage

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TableWidgetService
```
public TableWidgetService(InterMineAPI im)
```
    Construct a TableWidgetService
    
    Parameters:
    
    im - the intermine API object
- Method Detail
  - execute
```
protected void execute()
```
    Description copied from class: WebService
    
    Runs service. This is abstract method, that must be defined in subclasses and so performs something useful. Standard procedure is overwrite this method in subclasses and let this method to be called from WebService.doGet method that encapsulates logic common for all web services else you can overwrite doGet method in your web service class and manage all the things alone.
    
    Specified by:
    
    execute in class WebService
  - addOutputConfig
```
protected void addOutputConfig(WidgetConfig config)
```
    Description copied from class: WidgetService
    
    Add metadata about the widget we are using.
    
    Overrides:
    
    addOutputConfig in class WidgetService
    
    Parameters:
    
    config - The description of the widget.
  - getProcessor
```
protected WidgetResultProcessor getProcessor()
```
    Specified by:
    
    getProcessor in class WidgetService
    
    Returns:
    
    A widget result processor for outputting results.