Formatter (InterMine 5.0.0 API)

java.lang.Object
- org.intermine.webservice.server.output.Formatter

Direct Known Subclasses:

ArrayFormatter, FlatFileFormatter, JSONFormatter, PlainFormatter, XMLFormatter
```
public abstract class Formatter
extends java.lang.Object
```
Abstract class for formatting result data.

Author:

Jakub Kulaviak

Constructor Summary

Constructors
Constructor Description

Formatter()

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`abstract java.lang.String`	`formatFooter(java.lang.String errorMessage, int errorCode)`	Returns formatted footer.
`abstract java.lang.String`	`formatHeader(java.util.Map<java.lang.String,java.lang.Object> attributes)`	Returns formatted header.
`abstract java.lang.String`	`formatResult(java.util.List<java.lang.String> resultRow)`	Returns formatted result item.

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

- Constructor Detail
  - Formatter
```
public Formatter()
```
- Method Detail
  - formatHeader
```
public abstract java.lang.String formatHeader(java.util.Map<java.lang.String,java.lang.Object> attributes)
```
    Returns formatted header.
    
    Parameters:
    
    attributes - attributes contained in header
    
    Returns:
    
    formatted header
  - formatResult
```
public abstract java.lang.String formatResult(java.util.List<java.lang.String> resultRow)
```
    Returns formatted result item.
    
    Parameters:
    
    resultRow - result row
    
    Returns:
    
    formatted result row
  - formatFooter
```
public abstract java.lang.String formatFooter(java.lang.String errorMessage,
                                              int errorCode)
```
    Returns formatted footer.
    
    Parameters:
    
    errorMessage - The error message, if sth went wrong.
    
    errorCode - The error code, if sth went wrong.
    
    Returns:
    
    formatted footer